wt.inf.container
Interface WTContainer

All Superinterfaces:

AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, DisplayIdentification, wt.admin.DomainAdministered, wt.ufid.Federatable, wt.federation.FederatedLinkHolder, Identified, IdentityAccessControlled, NetFactor, Notifiable, ObjectMappable, OrganizationOwned, OrganizationOwnedImpl, Persistable, wt.access.PolicyAccessControlled, wt.recent.RecentlyVisited, wt.federation.RemotelyLinkable, wt.access.SecurityLabeled, Serializable, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.SubjectOfNotebook, WTContained, WTContainedIdentified

All Known Subinterfaces:

ContainerTeamManaged

All Known Implementing Classes:

OrgContainer, PDMLinkProduct, Project2, WTLibrary

public interface WTContainer
extends wt.access.AdHocControlled, DisplayIdentification, wt.admin.DomainAdministered, wt.workflow.notebook.SubjectOfNotebook, wt.workflow.forum.SubjectOfForum, wt.ufid.Federatable, WTContainedIdentified, OrganizationOwnedImpl, IdentityAccessControlled, Notifiable, wt.access.SecurityLabeled, wt.access.PolicyAccessControlled

Implementors of WTContainer should create a new WTContainerInfo in their initializer: protected void initialize() throws WTException { super.initialize(); try { setContainerInfo(WTContainerInfo.newWTContainerInfo()); } catch (WTPropertyVetoException wtpve) { throw new WTException(wtpve); } }

Supported API: true

Extendable: false

Field Summary

static String	CONTAINER_TEMPLATE Label for the attribute.
static String	CONTAINER_TEMPLATE_REFERENCE Label for the attribute.
static String	CREATOR Label for the attribute.
static String	DESCRIPTION Label for the attribute.
static String	NAME Label for the attribute; To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)
static String	OWNER Label for the attribute.
static String	SHARING_ENABLED Label for the attribute; Whether or not objects can be shared from this container.

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

WTContainerTemplate	getContainerTemplate() Gets the object for the association that plays role: CONTAINER_TEMPLATE.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateReference() Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
WTPrincipal	getCreator() Gets the value of the attribute: CREATOR.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
WTPrincipal	getOwner() Gets the value of the attribute: OWNER.
boolean	isSharingEnabled() Gets the value of the attribute: SHARING_ENABLED.
void	setContainerTemplate(WTContainerTemplate a_ContainerTemplate) Sets the object for the association that plays role: CONTAINER_TEMPLATE.
void	setContainerTemplateReference(wt.inf.container.WTContainerTemplateRef a_ContainerTemplateReference) Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
void	setCreator(WTPrincipal a_Creator) Sets the value of the attribute: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOwner(WTPrincipal a_Owner) Sets the value of the attribute: OWNER.
void	setSharingEnabled(boolean a_SharingEnabled) Sets the value of the attribute: SHARING_ENABLED.

Methods inherited from interface wt.fc.Identified

getIdentificationObject

Methods inherited from interface wt.org.OrganizationOwnedImpl

getOrganizationReference

Methods inherited from interface wt.org.OrganizationOwned

getOrganization, getOrganizationCodingSystem, getOrganizationName, getOrganizationUniqueIdentifier

Field Detail

CREATOR

static final String CREATOR

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

NAME

static final String NAME

Label for the attribute; To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)

Subclasses should override the default implementation of setName to call WTContainerInfo.setName(WTContainer,String). This will ensure the change restriction check is properly enforced.

Supported API: true

See Also:

IdentityService#changeIdentity, WTContainerIdentity, Constant Field Values

OWNER

static final String OWNER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SHARING_ENABLED

static final String SHARING_ENABLED

Label for the attribute; Whether or not objects can be shared from this container.

Supported API: true

See Also:

Constant Field Values

CONTAINER_TEMPLATE

static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CONTAINER_TEMPLATE_REFERENCE

static final String CONTAINER_TEMPLATE_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getCreator

WTPrincipal getCreator()

Gets the value of the attribute: CREATOR.

Supported API: true

Returns:

WTPrincipal

setCreator

void setCreator(WTPrincipal a_Creator)
                throws WTPropertyVetoException,
                       WTException

Sets the value of the attribute: CREATOR.

Supported API: true

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

WTException

getDescription

String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: true

Returns:

String

setDescription

void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getName

String getName()

Gets the value of the attribute: NAME. To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)

Subclasses should override the default implementation of setName to call WTContainerInfo.setName(WTContainer,String). This will ensure the change restriction check is properly enforced.

Supported API: true

Returns:

String

See Also:

IdentityService#changeIdentity, WTContainerIdentity

setName

void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. To rename a container, use IdentityHelper.service.changeIdentity(WTContainer, WTContainerIdentity)

Subclasses should override the default implementation of setName to call WTContainerInfo.setName(WTContainer,String). This will ensure the change restriction check is properly enforced.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

See Also:

IdentityService#changeIdentity, WTContainerIdentity

getOwner

WTPrincipal getOwner()

Gets the value of the attribute: OWNER.

Supported API: true

Returns:

WTPrincipal

setOwner

void setOwner(WTPrincipal a_Owner)
              throws WTPropertyVetoException,
                     WTException

Sets the value of the attribute: OWNER.

Supported API: true

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

WTException

isSharingEnabled

boolean isSharingEnabled()

Gets the value of the attribute: SHARING_ENABLED. Whether or not objects can be shared from this container.

Supported API: true

Returns:

boolean

setSharingEnabled

void setSharingEnabled(boolean a_SharingEnabled)
                       throws WTPropertyVetoException

Sets the value of the attribute: SHARING_ENABLED. Whether or not objects can be shared from this container.

Supported API: true

Parameters:

a_SharingEnabled -

Throws:

WTPropertyVetoException

getContainerTemplate

WTContainerTemplate getContainerTemplate()

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

Supported API: true

Returns:

WTContainerTemplate

setContainerTemplate

void setContainerTemplate(WTContainerTemplate a_ContainerTemplate)
                          throws WTPropertyVetoException,
                                 WTException

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

Supported API: true

Parameters:

a_ContainerTemplate -

Throws:

WTPropertyVetoException

WTException

getContainerTemplateReference

wt.inf.container.WTContainerTemplateRef getContainerTemplateReference()

Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Returns:

WTContainerTemplateRef

setContainerTemplateReference

void setContainerTemplateReference(wt.inf.container.WTContainerTemplateRef a_ContainerTemplateReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException