wt.inf.container
Interface WTContainerNamespace

All Superinterfaces:
IdentificationObjectNamespace
All Known Implementing Classes:
AbsCollectionCriteriaIdentity, AbsCollectionCriteriaKey, ArchiveIdentity, CabinetIdentity, ChangeIdentificationObject, ChangeKey, DataMaintRecordIdentity, EPMDocumentMasterIdentity, EPMDocumentMasterKey, ESITargetIdentity, ESITargetKey, ManagedBaselineIdentity, ManagedBaselineKey, MaturityKey, PromotionIdentificationObject, SubFolderIdentity, WTContainerIdentity, WTDocumentMasterIdentity, WTDocumentMasterKey, WTPartMasterIdentity, WTPartMasterKey

public interface WTContainerNamespace
extends IdentificationObjectNamespace

Allows the IdentityService to automatically handled updates to and queries for WTContainedIdentified objects. As such, this interface should be implemented by IdentificationObjects that are associated with WTContainedIdentified objects. In addition, this interface should be implemented by an object's SemanticKey if it is UniquelyIdentified as well as WTContainedIdentified

Supported API: true

Extendable: true


Field Summary
static String CONTAINED_IDENTIFIED
          Label for the attribute; A callback to the WTContainedIdentified object that this is a namespace for.
static String CONTAINER_REFERENCE
          Label for the attribute; The container that the WTContainedIdentified object is contained by.
static String NAMESPACE_ID
           
static String NAMESPACE_REFERENCE
          Label for the attribute; This property is used internally by the container service's identity processing.
 
Method Summary
 WTContainedIdentified getContainedIdentified()
          Gets the value of the attribute: CONTAINED_IDENTIFIED.
 WTContainerRef getContainerReference()
          Gets the value of the attribute: CONTAINER_REFERENCE.
 WTContainerRef getNamespaceReference()
          Gets the value of the attribute: NAMESPACE_REFERENCE.
 void setContainedIdentified(WTContainedIdentified a_ContainedIdentified)
          Sets the value of the attribute: CONTAINED_IDENTIFIED.
 void setContainerReference(WTContainerRef a_ContainerReference)
          Sets the value of the attribute: CONTAINER_REFERENCE.
 void setNamespaceReference(WTContainerRef a_NamespaceReference)
          Sets the value of the attribute: NAMESPACE_REFERENCE.
 

Field Detail

CONTAINED_IDENTIFIED

public static final String CONTAINED_IDENTIFIED
Label for the attribute; A callback to the WTContainedIdentified object that this is a namespace for. This property is used internally and never needs to be set by callers.

Supported API: false

See Also:
Constant Field Values

CONTAINER_REFERENCE

public static final String CONTAINER_REFERENCE
Label for the attribute; The container that the WTContainedIdentified object is contained by. Setting this property and then calling IdentityService.changeIdentity will update the object's container reference.

Supported API: false

See Also:
Constant Field Values

NAMESPACE_REFERENCE

public static final String NAMESPACE_REFERENCE
Label for the attribute; This property is used internally by the container service's identity processing. Callers should never need to set it.

A reference to the WTContainer that serves as a namespace for the WTContainedIdentified object. This value is typically derivable from WTContainerHelper.service.getNamespace, except for situations where a container and its children are being re-namespaced as part of a single transaction.

Supported API: false

See Also:
Constant Field Values

NAMESPACE_ID

public static final String NAMESPACE_ID
Method Detail

getContainedIdentified

public WTContainedIdentified getContainedIdentified()
Gets the value of the attribute: CONTAINED_IDENTIFIED. A callback to the WTContainedIdentified object that this is a namespace for. This property is used internally and never needs to be set by callers.

Supported API: false

Returns:
WTContainedIdentified

setContainedIdentified

public void setContainedIdentified(WTContainedIdentified a_ContainedIdentified)
                            throws WTPropertyVetoException
Sets the value of the attribute: CONTAINED_IDENTIFIED. A callback to the WTContainedIdentified object that this is a namespace for. This property is used internally and never needs to be set by callers.

Supported API: false

Parameters:
a_ContainedIdentified -
Throws:
WTPropertyVetoException

getContainerReference

public WTContainerRef getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE. The container that the WTContainedIdentified object is contained by. Setting this property and then calling IdentityService.changeIdentity will update the object's container reference.

Supported API: false

Returns:
WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: CONTAINER_REFERENCE. The container that the WTContainedIdentified object is contained by. Setting this property and then calling IdentityService.changeIdentity will update the object's container reference.

Supported API: false

Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

getNamespaceReference

public WTContainerRef getNamespaceReference()
Gets the value of the attribute: NAMESPACE_REFERENCE. This property is used internally by the container service's identity processing. Callers should never need to set it.

A reference to the WTContainer that serves as a namespace for the WTContainedIdentified object. This value is typically derivable from WTContainerHelper.service.getNamespace, except for situations where a container and its children are being re-namespaced as part of a single transaction.

Supported API: false

Returns:
WTContainerRef

setNamespaceReference

public void setNamespaceReference(WTContainerRef a_NamespaceReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: NAMESPACE_REFERENCE. This property is used internally by the container service's identity processing. Callers should never need to set it.

A reference to the WTContainer that serves as a namespace for the WTContainedIdentified object. This value is typically derivable from WTContainerHelper.service.getNamespace, except for situations where a container and its children are being re-namespaced as part of a single transaction.

Supported API: false

Parameters:
a_NamespaceReference -
Throws:
WTPropertyVetoException