wt.inf.container
Interface WTContainer

All Superinterfaces:

AccessControlled, AccessControlList, AdHocControlled, DisplayIdentification, DomainAdministered, Federatable, Identified, NetFactor, ObjectMappable, OrganizationOwned, OrganizationOwnedImpl, Persistable, RecentlyVisited, RemotelyLinkable, Serializable, SubjectOfForum, SubjectOfNotebook, WTContained, WTContainedIdentified

All Known Subinterfaces:

ContainerTeamManaged

All Known Implementing Classes:

ExchangeContainer, OrgContainer, PDMLinkProduct, Project2, WTLibrary

public interface WTContainer

extends AdHocControlled, DisplayIdentification, DomainAdministered, SubjectOfNotebook, SubjectOfForum, Federatable, WTContainedIdentified, OrganizationOwnedImpl

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	ADMINISTRATORS Label for the attribute; Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.
static String	ADMINISTRATORS_REFERENCE Label for the attribute; Supported API: false
static String	BUSINESS_NAMESPACE Label for the attribute; Whether or not objects in the "business namespace" have their identity constrained by this container.
static String	CONTAINER_INFO Label for the attribute.
static String	CONTAINER_TEMPLATE Label for the attribute.
static String	CONTAINER_TEMPLATE_REFERENCE Label for the attribute.
static String	CONTEXT_PROVIDER Label for the attribute; Represents a node in LDAP under which container-specific LDAP objects should be created.
static String	CREATOR Label for the attribute.
static String	CREATOR_REFERENCE Label for the attribute.
static String	DEFAULT_CABINET Label for the attribute; A Cabinet for a container's "business" data.
static String	DEFAULT_CABINET_REFERENCE Label for the attribute; Supported API: false
static String	DEFAULT_DOMAIN Label for the attribute; A domain that is set up to administer a container's business data.
static String	DEFAULT_DOMAIN_REFERENCE Label for the attribute; Supported API: false
static String	DESCRIPTION Label for the attribute.
static String	INTERNET_DOMAIN Label for the attribute; The name of the internet domain associated with this container, for example "com.ptc".
static String	META_DATA_NAMESPACE Label for the attribute; Determines whether or not this container can have LWC metadata dependent upon it.
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	OWNER_REFERENCE Label for the attribute; Supported API: false
static String	PRIVATE_ACCESS Label for the attribute; Determines how open the access is to the contents of this container.
static String	PUBLIC_PARENT_DOMAIN Label for the attribute.
static String	PUBLIC_PARENT_DOMAIN_REFERENCE Label for the attribute; Supported API: false
static String	SHARING_ENABLED Label for the attribute; Whether or not objects can be shared from this container.
static String	SYSTEM_CABINET Label for the attribute; A Cabinet for "system" data.
static String	SYSTEM_CABINET_REFERENCE Label for the attribute; Supported API: false
static String	SYSTEM_DOMAIN Label for the attribute; A domain that is set up to administer a container's system data.
static String	SYSTEM_DOMAIN_REFERENCE Label for the attribute; Supported API: false

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER, CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME

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

WTGroup	getAdministrators() Gets the value of the attribute: ADMINISTRATORS.
WTPrincipalReference	getAdministratorsReference() Gets the value of the attribute: ADMINISTRATORS_REFERENCE.
WTContainerInfo	getContainerInfo() Gets the object for the association that plays role: CONTAINER_INFO.
WTContainerTemplate	getContainerTemplate() Gets the object for the association that plays role: CONTAINER_TEMPLATE.
WTContainerTemplateRef	getContainerTemplateReference() Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.
DirectoryContextProvider	getContextProvider() Gets the value of the attribute: CONTEXT_PROVIDER.
WTPrincipal	getCreator() Gets the value of the attribute: CREATOR.
WTPrincipalReference	getCreatorReference() Gets the value of the attribute: CREATOR_REFERENCE.
Cabinet	getDefaultCabinet() Gets the value of the attribute: DEFAULT_CABINET.
CabinetReference	getDefaultCabinetReference() Gets the value of the attribute: DEFAULT_CABINET_REFERENCE.
AdministrativeDomain	getDefaultDomain() Gets the value of the attribute: DEFAULT_DOMAIN.
AdminDomainRef	getDefaultDomainReference() Gets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getInternetDomain() Gets the value of the attribute: INTERNET_DOMAIN.
String	getName() Gets the value of the attribute: NAME.
WTPrincipal	getOwner() Gets the value of the attribute: OWNER.
WTPrincipalReference	getOwnerReference() Gets the value of the attribute: OWNER_REFERENCE.
AdministrativeDomain	getPublicParentDomain() Gets the value of the attribute: PUBLIC_PARENT_DOMAIN.
AdminDomainRef	getPublicParentDomainReference() Gets the value of the attribute: PUBLIC_PARENT_DOMAIN_REFERENCE.
Cabinet	getSystemCabinet() Gets the value of the attribute: SYSTEM_CABINET.
CabinetReference	getSystemCabinetReference() Gets the value of the attribute: SYSTEM_CABINET_REFERENCE.
AdministrativeDomain	getSystemDomain() Gets the value of the attribute: SYSTEM_DOMAIN.
AdminDomainRef	getSystemDomainReference() Gets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.
boolean	isBusinessNamespace() Gets the value of the attribute: BUSINESS_NAMESPACE.
boolean	isMetaDataNamespace() Gets the value of the attribute: META_DATA_NAMESPACE.
boolean	isPrivateAccess() Gets the value of the attribute: PRIVATE_ACCESS.
boolean	isSharingEnabled() Gets the value of the attribute: SHARING_ENABLED.
void	setAdministrators(WTGroup a_Administrators) Sets the value of the attribute: ADMINISTRATORS.
void	setAdministratorsReference(WTPrincipalReference a_AdministratorsReference) Sets the value of the attribute: ADMINISTRATORS_REFERENCE.
void	setContainerTemplate(WTContainerTemplate a_ContainerTemplate) Sets the object for the association that plays role: CONTAINER_TEMPLATE.
void	setContainerTemplateReference(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	setCreatorReference(WTPrincipalReference a_CreatorReference) Sets the value of the attribute: CREATOR_REFERENCE.
void	setDefaultCabinet(Cabinet a_DefaultCabinet) Sets the value of the attribute: DEFAULT_CABINET.
void	setDefaultCabinetReference(CabinetReference a_DefaultCabinetReference) Sets the value of the attribute: DEFAULT_CABINET_REFERENCE.
void	setDefaultDomain(AdministrativeDomain a_DefaultDomain) Sets the value of the attribute: DEFAULT_DOMAIN.
void	setDefaultDomainReference(AdminDomainRef a_DefaultDomainReference) Sets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.
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	setOwnerReference(WTPrincipalReference a_OwnerReference) Sets the value of the attribute: OWNER_REFERENCE.
void	setSharingEnabled(boolean a_SharingEnabled) Sets the value of the attribute: SHARING_ENABLED.
void	setSystemCabinet(Cabinet a_SystemCabinet) Sets the value of the attribute: SYSTEM_CABINET.
void	setSystemCabinetReference(CabinetReference a_SystemCabinetReference) Sets the value of the attribute: SYSTEM_CABINET_REFERENCE.
void	setSystemDomain(AdministrativeDomain a_SystemDomain) Sets the value of the attribute: SYSTEM_DOMAIN.
void	setSystemDomainReference(AdminDomainRef a_SystemDomainReference) Sets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Methods inherited from interface wt.access.AdHocControlled

getEntrySet, setEntrySet

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

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.identity.DisplayIdentification

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from interface wt.admin.DomainAdministered

getDomainRef, isInheritedDomain, setDomainRef, setInheritedDomain

Methods inherited from interface wt.ufid.Federatable

getFederatableInfo, setFederatableInfo

Methods inherited from interface wt.inf.container.WTContainedIdentified

getContainer, getContainerReference, setContainer, setContainerReference

Methods inherited from interface wt.inf.container.WTContained

getContainerName

Methods inherited from interface wt.fc.Identified

getIdentificationObject

Methods inherited from interface wt.org.OrganizationOwnedImpl

getOrganizationReference, setOrganizationReference

Methods inherited from interface wt.org.OrganizationOwned

getOrganization, getOrganizationCodingSystem, getOrganizationName, getOrganizationUniqueIdentifier, setOrganization

Field Detail

ADMINISTRATORS

public static final String ADMINISTRATORS

Label for the attribute; Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.

Supported API: false

See Also:

Constant Field Values

ADMINISTRATORS_REFERENCE

public static final String ADMINISTRATORS_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#administrators, Constant Field Values

BUSINESS_NAMESPACE

public static final String BUSINESS_NAMESPACE

Label for the attribute; Whether or not objects in the "business namespace" have their identity constrained by this container. If false, then the first parent of this container that is a business namespace will be used.

Supported API: false

See Also:

Constant Field Values

CONTEXT_PROVIDER

public static final String CONTEXT_PROVIDER

Label for the attribute; Represents a node in LDAP under which container-specific LDAP objects should be created.

Supported API: false

See Also:

Constant Field Values

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CREATOR_REFERENCE

public static final String CREATOR_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DEFAULT_CABINET

public static final String DEFAULT_CABINET

Label for the attribute; A Cabinet for a container's "business" data. Typically, folder browsing will use the default cabinet as a root. Administrative data should be placed in the system cabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

See Also:

Constant Field Values

DEFAULT_CABINET_REFERENCE

public static final String DEFAULT_CABINET_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#cabinet, Constant Field Values

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

Label for the attribute; A domain that is set up to administer a container's business data. If this container is not private, then the default domain will be parented by the publicParentDomain.

Supported API: false

See Also:

Constant Field Values

DEFAULT_DOMAIN_REFERENCE

public static final String DEFAULT_DOMAIN_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#defaultDomain, Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

INTERNET_DOMAIN

public static final String INTERNET_DOMAIN

Label for the attribute; The name of the internet domain associated with this container, for example "com.ptc".

This property is derived from WTOrganization.internetDomain

Supported API: false

See Also:

Constant Field Values

META_DATA_NAMESPACE

public static final String META_DATA_NAMESPACE

Label for the attribute; Determines whether or not this container can have LWC metadata dependent upon it. If true, then getInternetDomain() must return a non-null value.

This property will always be true for instances of OrgContainer or ExchangeContainer, and always be false for other container types.

Supported API: false

See Also:

Constant Field Values

NAME

public 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

public static final String OWNER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

OWNER_REFERENCE

public static final String OWNER_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#owner, Constant Field Values

PRIVATE_ACCESS

public static final String PRIVATE_ACCESS

Label for the attribute; Determines how open the access is to the contents of this container. When true, the container should be set up such that only the users directly participating in the container have access to it. For ContainerTeamManaged objects, this means the confirmed participants in the container.

If a container has already been run through the create process, then the WTContainerService should be used to change this property. Use makePrivate to turn on private access, and makePublic to turn it off.

Supported API: false

See Also:

Constant Field Values

PUBLIC_PARENT_DOMAIN

public static final String PUBLIC_PARENT_DOMAIN

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PUBLIC_PARENT_DOMAIN_REFERENCE

public static final String PUBLIC_PARENT_DOMAIN_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#publicParentDomain, Constant Field Values

SHARING_ENABLED

public 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

SYSTEM_CABINET

public static final String SYSTEM_CABINET

Label for the attribute; A Cabinet for "system" data. The assumption is that data in this cabinet is typically not displayed in a folder paradigm but rather through another administrative client. Typical folder displays should work with the defaultCabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

See Also:

Constant Field Values

SYSTEM_CABINET_REFERENCE

public static final String SYSTEM_CABINET_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#systemCabinet, Constant Field Values

SYSTEM_DOMAIN

public static final String SYSTEM_DOMAIN

Label for the attribute; A domain that is set up to administer a container's system data. Care should be taken when specifying the parent of the systemDomain, so that open access is not granted to the container's administrative data.

Supported API: false

See Also:

Constant Field Values

SYSTEM_DOMAIN_REFERENCE

public static final String SYSTEM_DOMAIN_REFERENCE

Label for the attribute;

Supported API: false

See Also:

#systemDomain, Constant Field Values

CONTAINER_INFO

public static final String CONTAINER_INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_TEMPLATE

public static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CONTAINER_TEMPLATE_REFERENCE

public static final String CONTAINER_TEMPLATE_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getAdministrators

public WTGroup getAdministrators()

Gets the value of the attribute: ADMINISTRATORS. Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.

Supported API: false

Returns:

WTGroup

setAdministrators

public void setAdministrators(WTGroup a_Administrators)
                       throws WTPropertyVetoException,
                              WTException

Sets the value of the attribute: ADMINISTRATORS. Used by the WTContainerService.isAsministrator API to determine if a given user is an administrator of a container.

Supported API: false

Parameters:

a_Administrators -

Throws:

WTPropertyVetoException

WTException

getAdministratorsReference

public WTPrincipalReference getAdministratorsReference()

Gets the value of the attribute: ADMINISTRATORS_REFERENCE.

Supported API: false

Returns:

WTPrincipalReference

See Also:

#administrators

setAdministratorsReference

public void setAdministratorsReference(WTPrincipalReference a_AdministratorsReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: ADMINISTRATORS_REFERENCE.

Supported API: false

Parameters:

a_AdministratorsReference -

Throws:

WTPropertyVetoException

See Also:

#administrators

isBusinessNamespace

public boolean isBusinessNamespace()

Gets the value of the attribute: BUSINESS_NAMESPACE. Whether or not objects in the "business namespace" have their identity constrained by this container. If false, then the first parent of this container that is a business namespace will be used.

Supported API: false

Returns:

boolean

getContextProvider

public DirectoryContextProvider getContextProvider()
                                            throws WTException

Gets the value of the attribute: CONTEXT_PROVIDER. Represents a node in LDAP under which container-specific LDAP objects should be created.

Supported API: false

Returns:

DirectoryContextProvider

Throws:

WTException

getCreator

public WTPrincipal getCreator()

Gets the value of the attribute: CREATOR.

Supported API: true

Returns:

WTPrincipal

setCreator

public void setCreator(WTPrincipal a_Creator)
                throws WTPropertyVetoException,
                       WTException

Sets the value of the attribute: CREATOR.

Supported API: true

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

WTException

getCreatorReference

public WTPrincipalReference getCreatorReference()

Gets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Returns:

WTPrincipalReference

setCreatorReference

public void setCreatorReference(WTPrincipalReference a_CreatorReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Parameters:

a_CreatorReference -

Throws:

WTPropertyVetoException

getDefaultCabinet

public Cabinet getDefaultCabinet()

Gets the value of the attribute: DEFAULT_CABINET. A Cabinet for a container's "business" data. Typically, folder browsing will use the default cabinet as a root. Administrative data should be placed in the system cabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Returns:

Cabinet

setDefaultCabinet

public void setDefaultCabinet(Cabinet a_DefaultCabinet)
                       throws WTPropertyVetoException,
                              WTException

Sets the value of the attribute: DEFAULT_CABINET. A Cabinet for a container's "business" data. Typically, folder browsing will use the default cabinet as a root. Administrative data should be placed in the system cabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Parameters:

a_DefaultCabinet -

Throws:

WTPropertyVetoException

WTException

getDefaultCabinetReference

public CabinetReference getDefaultCabinetReference()

Gets the value of the attribute: DEFAULT_CABINET_REFERENCE.

Supported API: false

Returns:

CabinetReference

See Also:

#cabinet

setDefaultCabinetReference

public void setDefaultCabinetReference(CabinetReference a_DefaultCabinetReference)
                                throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_CABINET_REFERENCE.

Supported API: false

Parameters:

a_DefaultCabinetReference -

Throws:

WTPropertyVetoException

See Also:

#cabinet

getDefaultDomain

public AdministrativeDomain getDefaultDomain()

Gets the value of the attribute: DEFAULT_DOMAIN. A domain that is set up to administer a container's business data. If this container is not private, then the default domain will be parented by the publicParentDomain.

Supported API: false

Returns:

AdministrativeDomain

setDefaultDomain

public void setDefaultDomain(AdministrativeDomain a_DefaultDomain)
                      throws WTPropertyVetoException,
                             WTException

Sets the value of the attribute: DEFAULT_DOMAIN. A domain that is set up to administer a container's business data. If this container is not private, then the default domain will be parented by the publicParentDomain.

Supported API: false

Parameters:

a_DefaultDomain -

Throws:

WTPropertyVetoException

WTException

getDefaultDomainReference

public AdminDomainRef getDefaultDomainReference()

Gets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.

Supported API: false

Returns:

AdminDomainRef

See Also:

#defaultDomain

setDefaultDomainReference

public void setDefaultDomainReference(AdminDomainRef a_DefaultDomainReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.

Supported API: false

Parameters:

a_DefaultDomainReference -

Throws:

WTPropertyVetoException

See Also:

#defaultDomain

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getInternetDomain

public String getInternetDomain()
                         throws WTException

Gets the value of the attribute: INTERNET_DOMAIN. The name of the internet domain associated with this container, for example "com.ptc".

This property is derived from WTOrganization.internetDomain

Supported API: false

Returns:

String

Throws:

WTException

isMetaDataNamespace

public boolean isMetaDataNamespace()

Gets the value of the attribute: META_DATA_NAMESPACE. Determines whether or not this container can have LWC metadata dependent upon it. If true, then getInternetDomain() must return a non-null value.

This property will always be true for instances of OrgContainer or ExchangeContainer, and always be false for other container types.

Supported API: false

Returns:

boolean

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

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

Parameters:

a_Name -

Throws:

WTPropertyVetoException

See Also:

IdentityService#changeIdentity, WTContainerIdentity

getOwner

public WTPrincipal getOwner()

Gets the value of the attribute: OWNER.

Supported API: true

Returns:

WTPrincipal

setOwner

public void setOwner(WTPrincipal a_Owner)
              throws WTPropertyVetoException,
                     WTException

Sets the value of the attribute: OWNER.

Supported API: true

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

WTException

getOwnerReference

public WTPrincipalReference getOwnerReference()

Gets the value of the attribute: OWNER_REFERENCE.

Supported API: false

Returns:

WTPrincipalReference

See Also:

#owner

setOwnerReference

public void setOwnerReference(WTPrincipalReference a_OwnerReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: OWNER_REFERENCE.

Supported API: false

Parameters:

a_OwnerReference -

Throws:

WTPropertyVetoException

See Also:

#owner

isPrivateAccess

public boolean isPrivateAccess()

Gets the value of the attribute: PRIVATE_ACCESS. Determines how open the access is to the contents of this container. When true, the container should be set up such that only the users directly participating in the container have access to it. For ContainerTeamManaged objects, this means the confirmed participants in the container.

If a container has already been run through the create process, then the WTContainerService should be used to change this property. Use makePrivate to turn on private access, and makePublic to turn it off.

Supported API: false

Returns:

boolean

getPublicParentDomain

public AdministrativeDomain getPublicParentDomain()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN.

Supported API: false

Returns:

AdministrativeDomain

getPublicParentDomainReference

public AdminDomainRef getPublicParentDomainReference()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN_REFERENCE.

Supported API: false

Returns:

AdminDomainRef

See Also:

#publicParentDomain

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

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

Parameters:

a_SharingEnabled -

Throws:

WTPropertyVetoException

getSystemCabinet

public Cabinet getSystemCabinet()

Gets the value of the attribute: SYSTEM_CABINET. A Cabinet for "system" data. The assumption is that data in this cabinet is typically not displayed in a folder paradigm but rather through another administrative client. Typical folder displays should work with the defaultCabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Returns:

Cabinet

setSystemCabinet

public void setSystemCabinet(Cabinet a_SystemCabinet)
                      throws WTPropertyVetoException,
                             WTException

Sets the value of the attribute: SYSTEM_CABINET. A Cabinet for "system" data. The assumption is that data in this cabinet is typically not displayed in a folder paradigm but rather through another administrative client. Typical folder displays should work with the defaultCabinet.

Every effort should be made to limit the Cabinets in a container to the 2 defined in the WTContainer model -- the defaultCabinet and systemCabinet.

Supported API: false

Parameters:

a_SystemCabinet -

Throws:

WTPropertyVetoException

WTException

getSystemCabinetReference

public CabinetReference getSystemCabinetReference()

Gets the value of the attribute: SYSTEM_CABINET_REFERENCE.

Supported API: false

Returns:

CabinetReference

See Also:

#systemCabinet

setSystemCabinetReference

public void setSystemCabinetReference(CabinetReference a_SystemCabinetReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: SYSTEM_CABINET_REFERENCE.

Supported API: false

Parameters:

a_SystemCabinetReference -

Throws:

WTPropertyVetoException

See Also:

#systemCabinet

getSystemDomain

public AdministrativeDomain getSystemDomain()

Gets the value of the attribute: SYSTEM_DOMAIN. A domain that is set up to administer a container's system data. Care should be taken when specifying the parent of the systemDomain, so that open access is not granted to the container's administrative data.

Supported API: false

Returns:

AdministrativeDomain

setSystemDomain

public void setSystemDomain(AdministrativeDomain a_SystemDomain)
                     throws WTPropertyVetoException,
                            WTException

Sets the value of the attribute: SYSTEM_DOMAIN. A domain that is set up to administer a container's system data. Care should be taken when specifying the parent of the systemDomain, so that open access is not granted to the container's administrative data.

Supported API: false

Parameters:

a_SystemDomain -

Throws:

WTPropertyVetoException

WTException

getSystemDomainReference

public AdminDomainRef getSystemDomainReference()

Gets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Supported API: false

Returns:

AdminDomainRef

See Also:

#systemDomain

setSystemDomainReference

public void setSystemDomainReference(AdminDomainRef a_SystemDomainReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Supported API: false

Parameters:

a_SystemDomainReference -

Throws:

WTPropertyVetoException

See Also:

#systemDomain

getContainerInfo

public WTContainerInfo getContainerInfo()

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

Supported API: false

Returns:

WTContainerInfo

getContainerTemplate

public WTContainerTemplate getContainerTemplate()

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

Supported API: true

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

Parameters:

a_ContainerTemplate -

Throws:

WTPropertyVetoException

WTException

getContainerTemplateReference

public WTContainerTemplateRef getContainerTemplateReference()

Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Returns:

WTContainerTemplateRef

setContainerTemplateReference

public void setContainerTemplateReference(WTContainerTemplateRef a_ContainerTemplateReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: true

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException