oracle.workspaces.attachment
Interface CwAttachmentEnabled

All Known Implementing Classes:

CwResourceItem

public interface CwAttachmentEnabled

Interface representing an item that can have attachments attached to itself.

Method Summary

void	addAttachments(CwAttachmentDefinition attachmentDef) Add the attachment or attachments specified in the definition object.
CwAttachedEntity[]	listAllAttachments() Return all attached items; the result is sorted by attachment type.
java.util.Map	listAllAttachmentsByType() Return a Map of all attached items grouped by type; CwEntityType -> CwAttachedEntity[].
CwAttachedEntity[]	listAttachments() Return the attached items that are the "target" of the relationship; the result is sorted by attachment type.
java.util.Map	listAttachmentsByType() Return a Map of "target" attachments grouped by type; CwEntityType -> CwAttachedEntity[].
CwAttachedEntity[]	listSourceAttachments() Return attached items that are the "source" of the relationship; the result is sorted by attachment type.
java.util.Map	listSourceAttachmentsByType() Return a Map of "source" attachments grouped by type; CwEntityType -> CwAttachedEntity[].
void	removeAttachments(CwAttachedEntity[] attachments) Remove the specified attachments.
void	removeAttachments(CwUid[] attachmentUids) Remove the specified attachments.
void	updateAttachments(CwAttachedEntity[] attachments) Update the attachments for this object to include changes made to the entities; notably changes to the description(s).
void	updateAttachments(CwUid[] attachmentUids, java.lang.String[] newDescriptions) Update attachments for the specified CwUids to have the specified descriptions.

Method Detail

addAttachments

public void addAttachments(CwAttachmentDefinition attachmentDef)
                    throws CwException

Add the attachment or attachments specified in the definition object.

Throws:

CwException

listAllAttachments

public CwAttachedEntity[] listAllAttachments()
                                      throws CwException

Return all attached items; the result is sorted by attachment type.

Throws:

CwException

listAllAttachmentsByType

public java.util.Map listAllAttachmentsByType()
                                       throws CwException

Return a Map of all attached items grouped by type; CwEntityType -> CwAttachedEntity[].

Throws:

CwException

listAttachments

public CwAttachedEntity[] listAttachments()
                                   throws CwException

Return the attached items that are the "target" of the relationship; the result is sorted by attachment type.

Throws:

CwException

listAttachmentsByType

public java.util.Map listAttachmentsByType()
                                    throws CwException

Return a Map of "target" attachments grouped by type; CwEntityType -> CwAttachedEntity[].

Throws:

CwException

listSourceAttachments

public CwAttachedEntity[] listSourceAttachments()
                                         throws CwException

Return attached items that are the "source" of the relationship; the result is sorted by attachment type.

Throws:

CwException

listSourceAttachmentsByType

public java.util.Map listSourceAttachmentsByType()
                                          throws CwException

Return a Map of "source" attachments grouped by type; CwEntityType -> CwAttachedEntity[].

Throws:

CwException

removeAttachments

public void removeAttachments(CwAttachedEntity[] attachments)
                       throws CwException

Remove the specified attachments. Note that this removes the attachment relationship but not the actual item.

Throws:

CwException

removeAttachments

public void removeAttachments(CwUid[] attachmentUids)
                       throws CwException

Remove the specified attachments. Note that this removes the attachment relationship but not the actual item.

Throws:

CwException

updateAttachments

public void updateAttachments(CwAttachedEntity[] attachments)
                       throws CwException

Update the attachments for this object to include changes made to the entities; notably changes to the description(s).

Throws:

CwException

updateAttachments

public void updateAttachments(CwUid[] attachmentUids,
                              java.lang.String[] newDescriptions)
                       throws CwException

Update attachments for the specified CwUids to have the specified descriptions.

Throws:

CwException