wt.inf.container
Class ExchangeContainer

java.lang.Object
  wt.fc.WTObject
      wt.inf.container.ExchangeContainer

All Implemented Interfaces:

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

public final class ExchangeContainer

extends WTObject

implements WTContainer, Externalizable

A special type of container that is used as the root of a given installation's container hierarchy. There is one and only one instance of an ExchangeContainer per installation.

Use the newExchangeContainer static factory method(s), not the ExchangeContainer 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

protected static String	CLASSIC Label for the attribute.
protected static String	CLASSIC_REFERENCE Label for the attribute.
private WTContainerRef	classicReference
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
static String	CONTAINER_TEMPLATE Label for the attribute.
private WTContainerInfo	containerInfo
private WTContainerRef	containerReference
private WTContainerTemplateRef	containerTemplateReference
private AdminDomainRef	domainRef
private AclEntrySet	entrySet
static long	EXTERNALIZATION_VERSION_UID
private FederatableInfo	federatableInfo
private boolean	inheritedDomain
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	organizationReference
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.inf.container.WTContainer

ADMINISTRATORS, ADMINISTRATORS_REFERENCE, BUSINESS_NAMESPACE, CONTAINER_INFO, CONTAINER_TEMPLATE_REFERENCE, CONTEXT_PROVIDER, CREATOR, CREATOR_REFERENCE, DEFAULT_CABINET, DEFAULT_CABINET_REFERENCE, DEFAULT_DOMAIN, DEFAULT_DOMAIN_REFERENCE, DESCRIPTION, INTERNET_DOMAIN, META_DATA_NAMESPACE, NAME, OWNER, OWNER_REFERENCE, PRIVATE_ACCESS, PUBLIC_PARENT_DOMAIN, PUBLIC_PARENT_DOMAIN_REFERENCE, SHARING_ENABLED, SYSTEM_CABINET, SYSTEM_CABINET_REFERENCE, SYSTEM_DOMAIN, SYSTEM_DOMAIN_REFERENCE

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_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

Constructor Summary

ExchangeContainer()

Method Summary

private void	classicReferenceValidate(WTContainerRef a_ClassicReference)
private void	containerInfoValidate(WTContainerInfo a_ContainerInfo)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	containerTemplateReferenceValidate(WTContainerTemplateRef a_ContainerTemplateReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	federatableInfoValidate(FederatableInfo a_FederatableInfo)
WTGroup	getAdministrators() Gets the value of the attribute: ADMINISTRATORS.
WTPrincipalReference	getAdministratorsReference() Gets the value of the attribute: ADMINISTRATORS_REFERENCE.
protected WTContainer	getClassic() Gets the object for the association that plays role: CLASSIC.
protected WTContainerRef	getClassicReference() Gets the value of the attribute: CLASSIC_REFERENCE.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
WTContainerInfo	getContainerInfo() Gets the object for the association that plays role: CONTAINER_INFO.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
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.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
FederatableInfo	getFederatableInfo() Gets the object for the association that plays role: FEDERATABLE_INFO.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDisplayIdentity
String	getInternetDomain() Gets the value of the attribute: INTERNET_DOMAIN.
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.
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.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isBusinessNamespace() Gets the value of the attribute: BUSINESS_NAMESPACE.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
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	log(StringBuffer sb)
static ExchangeContainer	newExchangeContainer() Default factory for the class.
private void	organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ExchangeContainer thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.
protected void	setBusinessNamespace(boolean a_BusinessNamespace) Sets the value of the attribute: BUSINESS_NAMESPACE.
protected void	setClassic(WTContainer a_Classic) Sets the object for the association that plays role: CLASSIC.
protected void	setClassicReference(WTContainerRef a_ClassicReference) Sets the value of the attribute: CLASSIC_REFERENCE.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
protected void	setContainerInfo(WTContainerInfo a_ContainerInfo) Sets the object for the association that plays role: CONTAINER_INFO.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_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	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setFederatableInfo(FederatableInfo a_FederatableInfo) Sets the object for the association that plays role: FEDERATABLE_INFO.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
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	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.
String	toString() If the object has been persisted, return it's ObjectIdentifier.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.identity.DisplayIdentification

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASSIC

protected static final String CLASSIC

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CLASSIC_REFERENCE

protected static final String CLASSIC_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

classicReference

private WTContainerRef classicReference

containerInfo

private WTContainerInfo containerInfo

CONTAINER_TEMPLATE

public static final String CONTAINER_TEMPLATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerTemplateReference

private WTContainerTemplateRef containerTemplateReference

entrySet

private AclEntrySet entrySet

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

federatableInfo

private FederatableInfo federatableInfo

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

organizationReference

private WTPrincipalReference organizationReference

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ExchangeContainer

public ExchangeContainer()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class WTObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ExchangeContainer thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class WTObject

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getClassic

protected WTContainer getClassic()

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

Supported API: false

Returns:

WTContainer

setClassic

protected void setClassic(WTContainer a_Classic)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: false

Parameters:

a_Classic -

Throws:

WTPropertyVetoException

WTException

getClassicReference

protected WTContainerRef getClassicReference()

Gets the value of the attribute: CLASSIC_REFERENCE.

Supported API: false

Returns:

WTContainerRef

setClassicReference

protected void setClassicReference(WTContainerRef a_ClassicReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: CLASSIC_REFERENCE.

Supported API: false

Parameters:

a_ClassicReference -

Throws:

WTPropertyVetoException

classicReferenceValidate

private void classicReferenceValidate(WTContainerRef a_ClassicReference)
                               throws WTPropertyVetoException

Parameters:

a_ClassicReference -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDisplayIdentity

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class WTObject

Returns:

String

newExchangeContainer

public static ExchangeContainer newExchangeContainer()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

ExchangeContainer

Throws:

WTException

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

Specified by:

getAdministrators in interface WTContainer

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

Specified by:

setAdministrators in interface WTContainer

Parameters:

a_Administrators -

Throws:

WTPropertyVetoException

WTException

getAdministratorsReference

public WTPrincipalReference getAdministratorsReference()

Gets the value of the attribute: ADMINISTRATORS_REFERENCE.

Supported API: false

Specified by:

getAdministratorsReference in interface WTContainer

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

Specified by:

setAdministratorsReference in interface WTContainer

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

Specified by:

isBusinessNamespace in interface WTContainer

Returns:

boolean

setBusinessNamespace

protected void setBusinessNamespace(boolean a_BusinessNamespace)
                             throws WTPropertyVetoException

Sets 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

Parameters:

a_BusinessNamespace -

Throws:

WTPropertyVetoException

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

Specified by:

getContextProvider in interface WTContainer

Returns:

DirectoryContextProvider

Throws:

WTException

getCreator

public WTPrincipal getCreator()

Gets the value of the attribute: CREATOR.

Supported API: false

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: false

Specified by:

setCreator in interface WTContainer

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

WTException

getCreatorReference

public WTPrincipalReference getCreatorReference()

Gets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Specified by:

getCreatorReference in interface WTContainer

Returns:

WTPrincipalReference

setCreatorReference

public void setCreatorReference(WTPrincipalReference a_CreatorReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CREATOR_REFERENCE.

Supported API: false

Specified by:

setCreatorReference in interface WTContainer

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

Specified by:

getDefaultCabinet in interface WTContainer

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

Specified by:

setDefaultCabinet in interface WTContainer

Parameters:

a_DefaultCabinet -

Throws:

WTPropertyVetoException

WTException

getDefaultCabinetReference

public CabinetReference getDefaultCabinetReference()

Gets the value of the attribute: DEFAULT_CABINET_REFERENCE.

Supported API: false

Specified by:

getDefaultCabinetReference in interface WTContainer

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

Specified by:

setDefaultCabinetReference in interface WTContainer

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

Specified by:

getDefaultDomain in interface WTContainer

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

Specified by:

setDefaultDomain in interface WTContainer

Parameters:

a_DefaultDomain -

Throws:

WTPropertyVetoException

WTException

getDefaultDomainReference

public AdminDomainRef getDefaultDomainReference()

Gets the value of the attribute: DEFAULT_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getDefaultDomainReference in interface WTContainer

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

Specified by:

setDefaultDomainReference in interface WTContainer

Parameters:

a_DefaultDomainReference -

Throws:

WTPropertyVetoException

See Also:

#defaultDomain

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

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: false

Specified by:

setDescription in interface WTContainer

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

Specified by:

getInternetDomain in interface WTContainer

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

Specified by:

isMetaDataNamespace in interface WTContainer

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: false

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: false

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: false

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: false

Specified by:

setOwner in interface WTContainer

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

WTException

getOwnerReference

public WTPrincipalReference getOwnerReference()

Gets the value of the attribute: OWNER_REFERENCE.

Supported API: false

Specified by:

getOwnerReference in interface WTContainer

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

Specified by:

setOwnerReference in interface WTContainer

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

Specified by:

isPrivateAccess in interface WTContainer

Returns:

boolean

getPublicParentDomain

public AdministrativeDomain getPublicParentDomain()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN.

Supported API: false

Specified by:

getPublicParentDomain in interface WTContainer

Returns:

AdministrativeDomain

getPublicParentDomainReference

public AdminDomainRef getPublicParentDomainReference()

Gets the value of the attribute: PUBLIC_PARENT_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getPublicParentDomainReference in interface WTContainer

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: false

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: false

Specified by:

setSharingEnabled in interface WTContainer

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

Specified by:

getSystemCabinet in interface WTContainer

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

Specified by:

setSystemCabinet in interface WTContainer

Parameters:

a_SystemCabinet -

Throws:

WTPropertyVetoException

WTException

getSystemCabinetReference

public CabinetReference getSystemCabinetReference()

Gets the value of the attribute: SYSTEM_CABINET_REFERENCE.

Supported API: false

Specified by:

getSystemCabinetReference in interface WTContainer

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

Specified by:

setSystemCabinetReference in interface WTContainer

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

Specified by:

getSystemDomain in interface WTContainer

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

Specified by:

setSystemDomain in interface WTContainer

Parameters:

a_SystemDomain -

Throws:

WTPropertyVetoException

WTException

getSystemDomainReference

public AdminDomainRef getSystemDomainReference()

Gets the value of the attribute: SYSTEM_DOMAIN_REFERENCE.

Supported API: false

Specified by:

getSystemDomainReference in interface WTContainer

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

Specified by:

setSystemDomainReference in interface WTContainer

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

Specified by:

getContainerInfo in interface WTContainer

Returns:

WTContainerInfo

setContainerInfo

protected void setContainerInfo(WTContainerInfo a_ContainerInfo)
                         throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ContainerInfo -

Throws:

WTPropertyVetoException

containerInfoValidate

private void containerInfoValidate(WTContainerInfo a_ContainerInfo)
                            throws WTPropertyVetoException

Parameters:

a_ContainerInfo -

Throws:

WTPropertyVetoException

getContainerTemplate

public WTContainerTemplate getContainerTemplate()

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

Supported API: false

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: false

Specified by:

setContainerTemplate in interface WTContainer

Parameters:

a_ContainerTemplate -

Throws:

WTPropertyVetoException

WTException

getContainerTemplateReference

public WTContainerTemplateRef getContainerTemplateReference()

Gets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: false

Specified by:

getContainerTemplateReference in interface WTContainer

Returns:

WTContainerTemplateRef

setContainerTemplateReference

public void setContainerTemplateReference(WTContainerTemplateRef a_ContainerTemplateReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_TEMPLATE_REFERENCE.

Supported API: false

Specified by:

setContainerTemplateReference in interface WTContainer

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException

containerTemplateReferenceValidate

private void containerTemplateReferenceValidate(WTContainerTemplateRef a_ContainerTemplateReference)
                                         throws WTPropertyVetoException

Parameters:

a_ContainerTemplateReference -

Throws:

WTPropertyVetoException

getEntrySet

public AclEntrySet getEntrySet()

Gets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

getEntrySet in interface AdHocControlled

Returns:

AclEntrySet

setEntrySet

public void setEntrySet(AclEntrySet a_EntrySet)

Sets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

setEntrySet in interface AdHocControlled

Parameters:

a_EntrySet -

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

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

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getFederatableInfo

public FederatableInfo getFederatableInfo()

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

Supported API: false

Specified by:

getFederatableInfo in interface Federatable

Returns:

FederatableInfo

setFederatableInfo

public void setFederatableInfo(FederatableInfo a_FederatableInfo)
                        throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFederatableInfo in interface Federatable

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

federatableInfoValidate

private void federatableInfoValidate(FederatableInfo a_FederatableInfo)
                              throws WTPropertyVetoException

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContainedIdentified

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContainedIdentified

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContainedIdentified

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContainedIdentified

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

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: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

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: false

Specified by:

setOrganizationReference in interface OrganizationOwnedImpl

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

organizationReferenceValidate

private void organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
                                    throws WTPropertyVetoException

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: false

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: false

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: false

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: false

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: false

Specified by:

setOrganization in interface OrganizationOwned

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class WTObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class WTObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

toString

public String toString()

Description copied from class: WTObject

If the object has been persisted, return it's ObjectIdentifier. If it has not yet been persisted, simply return it's conceptual (modeled) name.

Overrides:

toString in class WTObject

Returns:

String

log

public void log(StringBuffer sb)