wt.workflow.collaboration
Interface CollaborationContainer

All Superinterfaces:

NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

NotebookIfc

All Known Implementing Classes:

Discussion, Notebook, NotebookFolder

public interface CollaborationContainer

extends Persistable, Notifiable

CollaborationContainer is a convenience interface to capture common behavior such as template-based instantiation, subscription and parent-child associations in one place.

Supported API: false

Extendable: false

Field Summary

static String	DEFINITION Label for the attribute.
static String	DEFINITION_REFERENCE Label for the attribute.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Method Summary

Vector	getChildren() Returns all objects that have the container as their parent object.
CollaborationTemplate	getDefinition() Gets the object for the association that plays role: DEFINITION.
ObjectReference	getDefinitionReference() Gets the value of the attribute: DEFINITION_REFERENCE.
CollaborationContainer	getParent() Returns the object if any that acts as the container of this object.
ObjectSubscription	populateSubscription(ObjectSubscription subscription) Populates the given ObjectSubscription with values specific to the CollaborationContainer object.
void	setDefinition(CollaborationTemplate a_Definition) Sets the object for the association that plays role: DEFINITION.
void	setDefinitionReference(ObjectReference a_DefinitionReference) Sets the value of the attribute: DEFINITION_REFERENCE.

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Methods inherited from interface wt.notify.Notifiable

getEventSet, setEventSet

Field Detail

DEFINITION

public static final String DEFINITION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DEFINITION_REFERENCE

public static final String DEFINITION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getDefinition

public CollaborationTemplate getDefinition()

Gets the object for the association that plays role: DEFINITION.

Supported API: false

Returns:

CollaborationTemplate

setDefinition

public void setDefinition(CollaborationTemplate a_Definition)
                   throws WTPropertyVetoException,
                          WTException

Sets the object for the association that plays role: DEFINITION.

Supported API: false

Parameters:

a_Definition -

Throws:

WTPropertyVetoException

WTException

getDefinitionReference

public ObjectReference getDefinitionReference()

Gets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDefinitionReference

public void setDefinitionReference(ObjectReference a_DefinitionReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

getChildren

public Vector getChildren()
                   throws WTException

Returns all objects that have the container as their parent object.

Supported API: false

Returns:

Vector

Throws:

WTException

getParent

public CollaborationContainer getParent()
                                 throws WTException

Returns the object if any that acts as the container of this object.

Supported API: false

Returns:

CollaborationContainer

Throws:

WTException

populateSubscription

public ObjectSubscription populateSubscription(ObjectSubscription subscription)
                                        throws WTException

Populates the given ObjectSubscription with values specific to the CollaborationContainer object.

Supported API: false

Parameters:

subscription -

Returns:

ObjectSubscription

Throws:

WTException