Oracle® Collaboration Suite Workspaces API Reference
10g Release 1 (10.1.2)

B25479-01


oracle.workspaces.attachment
Class CwAttachedEntity

java.lang.Object
  extended byoracle.workspaces.attachment.CwAttachedEntity


public class CwAttachedEntity
extends java.lang.Object

Represents an entity that is related/linked to another. The relationship can optionally have a description, and it has a role specifying whether this entity is the source or the target of the relationship. When you attach item B to item A, item A is considered the source of the attachment and item B the target.


Field Summary
static java.lang.String ENTITY_ROLE_SOURCE
Constant representing the attachment source role.
static java.lang.String ENTITY_ROLE_TARGET
Constant representing the attachment target role.

Method Summary
java.lang.String getDescription()
Returns the description for the attachment, if any.
java.lang.String getEntityRole()
Returns the role of the attached entity.
CwUid getEntityUid()
Returns the CwUid of the attached entity.
void setDescription(java.lang.String description)
Sets the description for the attachment.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITY_ROLE_SOURCE

public static java.lang.String ENTITY_ROLE_SOURCE
Constant representing the attachment source role.

ENTITY_ROLE_TARGET

public static java.lang.String ENTITY_ROLE_TARGET
Constant representing the attachment target role.

Method Detail

getDescription

public java.lang.String getDescription()
Returns the description for the attachment, if any.

getEntityRole

public java.lang.String getEntityRole()
Returns the role of the attached entity.

getEntityUid

public CwUid getEntityUid()
Returns the CwUid of the attached entity.

setDescription

public void setDescription(java.lang.String description)
Sets the description for the attachment.

Copyright © 2001, 2005, Oracle. All rights reserved.