wt.inf.container
Class OrgContainer

java.lang.Object
  wt.fc.WTObject
      wt.team.WTRoleHolder2
          wt.inf.container.OrgContainer

All Implemented Interfaces:

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

public final class OrgContainer
extends WTRoleHolder2
implements WTContainer, Externalizable

A container for an organization's business and administrative objects.

Use the newOrgContainer static factory method(s), not the OrgContainer constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String

CONTAINER_TEMPLATE Label for the attribute.

Fields inherited from interface wt.inf.container.WTContainer

CONTAINER_TEMPLATE_REFERENCE, CREATOR, DESCRIPTION, NAME, OWNER, SHARING_ENABLED

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.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getName() Gets the value of the attribute: NAME.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
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	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.
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 class wt.team.WTRoleHolder2

addPool, addPrincipal, deletePoolTarget, deletePrincipalTarget, deleteRole, getMembers, getPoolTarget, getPrincipalTarget, getRoles

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTAINER_TEMPLATE

public static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getCreator

public WTPrincipal getCreator()

Gets the value of the attribute: CREATOR.

Supported API: true

Specified by:

getCreator in interface WTContainer

Returns:

WTPrincipal

setCreator

public void setCreator(WTPrincipal a_Creator)
                throws WTPropertyVetoException,
                       WTException

Sets the value of the attribute: CREATOR.

Supported API: true

Specified by:

setCreator in interface WTContainer

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

WTException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: true

Specified by:

getDescription in interface WTContainer

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: true

Specified by:

setDescription in interface WTContainer

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getName

public 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

Specified by:

getName in interface WTContainer

Returns:

String

See Also:

IdentityService#changeIdentity, WTContainerIdentity

setName

public 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

Specified by:

setName in interface WTContainer

Parameters:

a_Name -

Throws:

WTPropertyVetoException

See Also:

IdentityService#changeIdentity, WTContainerIdentity

getOwner

public WTPrincipal getOwner()

Gets the value of the attribute: OWNER.

Supported API: true

Specified by:

getOwner in interface WTContainer

Returns:

WTPrincipal

setOwner

public void setOwner(WTPrincipal a_Owner)
              throws WTPropertyVetoException,
                     WTException

Sets the value of the attribute: OWNER.

Supported API: true

Specified by:

setOwner in interface WTContainer

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

WTException

isSharingEnabled

public boolean isSharingEnabled()

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

Supported API: true

Specified by:

isSharingEnabled in interface WTContainer

Returns:

boolean

setSharingEnabled

public 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

Specified by:

setSharingEnabled in interface WTContainer

Parameters:

a_SharingEnabled -

Throws:

WTPropertyVetoException

getContainerTemplate

public WTContainerTemplate getContainerTemplate()

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

Supported API: true

Specified by:

getContainerTemplate in interface WTContainer

Returns:

WTContainerTemplate

setContainerTemplate

public void setContainerTemplate(WTContainerTemplate a_ContainerTemplate)
                          throws WTPropertyVetoException,
                                 WTException

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

Supported API: true

Specified by:

setContainerTemplate in interface WTContainer

Parameters:

a_ContainerTemplate -

Throws:

WTPropertyVetoException

WTException

getContainerTemplateReference

public wt.inf.container.WTContainerTemplateRef getContainerTemplateReference()

Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Specified by:

getContainerTemplateReference in interface WTContainer

Returns:

WTContainerTemplateRef

setContainerTemplateReference

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

Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Specified by:

setContainerTemplateReference in interface WTContainer

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException