wt.inf.template
Class DefaultWTContainerTemplate

java.lang.Object
  wt.fc.WTObject
      wt.inf.template.DefaultWTContainerTemplate

All Implemented Interfaces:

AccessControlled, AdHocStringVersioned, ContainerDefinition, ContainerTemplateDefinition, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, Iterated, Lockable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, Versionable, Workable, WTContained, WTContainerTemplate

public final class DefaultWTContainerTemplate

extends WTObject

implements ContentHolder, ContainerDefinition, WTContained, AdHocStringVersioned, WTContainerTemplate, Workable, AccessControlled, DomainAdministered, Notifiable, Externalizable

The package scope attributes are gettable by members of this package by design. Delegates will recieve these attributes as parameters

Use the newDefaultWTContainerTemplate static factory method(s), not the DefaultWTContainerTemplate 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

private static int	AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT
private String	adHocStringIdentifier
private CheckoutInfo	checkoutInfo
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
static String	CONTAINER_CLASS_NAME Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
private ControlBranch	controlBranch
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute; The reference to a persisted principal who created the object Supported API: false
static String	DESCRIPTION Label for the attribute.
private AdminDomainRef	domainRef
static String	ENABLED Label for the attribute.
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private boolean	hasContents
private Vector	httpVector
private boolean	inheritedDomain
private IterationInfo	iterationInfo
static String	LOCALE Label for the attribute.
private Lock	lock
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
private WTContainerTemplateMasterReference	masterReference
static String	NAME Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID
private XMLLob	xml
static String	XML Label for the attribute.

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.vc.AdHocStringVersioned

AD_HOC_STRING_IDENTIFIER

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

DefaultWTContainerTemplate()

Method Summary

private void	adHocStringIdentifierValidate(String a_AdHocStringIdentifier)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getAdHocStringIdentifier() Gets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
CheckoutInfo	getCheckoutInfo() Gets the object for the association that plays role: CHECKOUT_INFO.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerClassName() Gets the value of the attribute: CONTAINER_CLASS_NAME.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
DefaultWTContainerTemplate	getContainerTemplate() Deprecated.
ObjectReference	getContainerTemplateReference() Deprecated.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
String	getLocale() Gets the value of the attribute: LOCALE.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
String	getName() Gets the value of the attribute: NAME.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
XMLLob	getXml() Gets the value of the attribute: XML.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
protected void	initialize(String name, String containerClassName) Initializes objects created by new-factory methods.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static DefaultWTContainerTemplate	newDefaultWTContainerTemplate() Initializes objects created by new-factory methods.
static DefaultWTContainerTemplate	newDefaultWTContainerTemplate(String name, String containerClassName) Initializes objects created by new-factory methods.
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(DefaultWTContainerTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAdHocStringIdentifier(String a_AdHocStringIdentifier) Sets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
void	setCheckoutInfo(CheckoutInfo a_CheckoutInfo) Sets the object for the association that plays role: CHECKOUT_INFO.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerClass(String className)
void	setContainerClassName(String a_ContainerClassName) Sets the value of the attribute: CONTAINER_CLASS_NAME.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
private void	setCreator(WTPrincipalReference principalRef)
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	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLocale(String a_Locale) Sets the value of the attribute: LOCALE.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setXml(XMLLob a_Xml) Sets the value of the attribute: XML.
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, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_CLASS_NAME

public static final String CONTAINER_CLASS_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LOCALE

public static final String LOCALE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

XML

public static final String XML

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

xml

private XMLLob xml

MASTER

public static final String MASTER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

masterReference

private WTContainerTemplateMasterReference masterReference

CREATOR

public static final String CREATOR

Label for the attribute; The reference to a persisted principal who created the object

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

private static int AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

adHocStringIdentifier

private String adHocStringIdentifier

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

checkoutInfo

private CheckoutInfo checkoutInfo

lock

private Lock lock

ownership

private Ownership ownership

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

eventSet

private WTStringSet eventSet

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

DefaultWTContainerTemplate

public DefaultWTContainerTemplate()

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(DefaultWTContainerTemplate 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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Specified by:

getName in interface WTContainerTemplate

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Specified by:

setName in interface WTContainerTemplate

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Specified by:

getDescription in interface WTContainerTemplate

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 WTContainerTemplate

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED.

Supported API: false

Specified by:

isEnabled in interface WTContainerTemplate

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)
                throws WTPropertyVetoException

Sets the value of the attribute: ENABLED.

Supported API: false

Specified by:

setEnabled in interface WTContainerTemplate

Parameters:

a_Enabled -

Throws:

WTPropertyVetoException

getContainerClassName

public String getContainerClassName()

Gets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Specified by:

getContainerClassName in interface WTContainerTemplate

Returns:

String

setContainerClassName

public void setContainerClassName(String a_ContainerClassName)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Specified by:

setContainerClassName in interface WTContainerTemplate

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

getLocale

public String getLocale()

Gets the value of the attribute: LOCALE.

Supported API: false

Returns:

String

setLocale

public void setLocale(String a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: LOCALE.

Supported API: false

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

getXml

public XMLLob getXml()

Gets the value of the attribute: XML.

Supported API: false

Returns:

XMLLob

setXml

public void setXml(XMLLob a_Xml)
            throws WTPropertyVetoException

Sets the value of the attribute: XML.

Supported API: false

Parameters:

a_Xml -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

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

Supported API: false

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR. The reference to a persisted principal who created the object

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

initialize

protected void initialize()
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

initialize

protected void initialize(String name,
                          String containerClassName)
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Parameters:

name -

containerClassName -

Throws:

WTException

newDefaultWTContainerTemplate

public static DefaultWTContainerTemplate newDefaultWTContainerTemplate(String name,
                                                                       String containerClassName)
                                                                throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Parameters:

name -

containerClassName -

Returns:

DefaultWTContainerTemplate

Throws:

WTException

newDefaultWTContainerTemplate

public static DefaultWTContainerTemplate newDefaultWTContainerTemplate()
                                                                throws WTException

Initializes objects created by new-factory methods.

Supported API: false

Returns:

DefaultWTContainerTemplate

Throws:

WTException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

getContainerTemplate

public DefaultWTContainerTemplate getContainerTemplate()

Deprecated.

This method is deprecated, use ContainerHelper.getContainerTemplate(ContainerDefinition def) instead.

Supported API: false

Specified by:

getContainerTemplate in interface ContainerTemplateDefinition

Returns:

DefaultWTContainerTemplate

getContainerTemplateReference

public ObjectReference getContainerTemplateReference()

Deprecated.

deprecated, use ContainerHelper.service.getContainerTemplateRef(ContainerDefinition def) instead.

Supported API: false

Specified by:

getContainerTemplateReference in interface ContainerTemplateDefinition

Returns:

ObjectReference

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

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

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 WTContained

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 WTContained

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 WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getAdHocStringIdentifier

public String getAdHocStringIdentifier()

Gets the value of the attribute: AD_HOC_STRING_IDENTIFIER. This attribute persists the ad-hoc identifier provided by some client/process. This identifier is typically wrapped by another, more appropriately named attribute, such as "name".

Supported API: true

Specified by:

getAdHocStringIdentifier in interface AdHocStringVersioned

Returns:

String

setAdHocStringIdentifier

public void setAdHocStringIdentifier(String a_AdHocStringIdentifier)
                              throws WTPropertyVetoException

Sets the value of the attribute: AD_HOC_STRING_IDENTIFIER. This attribute persists the ad-hoc identifier provided by some client/process. This identifier is typically wrapped by another, more appropriately named attribute, such as "name".

Supported API: true

Specified by:

setAdHocStringIdentifier in interface AdHocStringVersioned

Parameters:

a_AdHocStringIdentifier -

Throws:

WTPropertyVetoException

adHocStringIdentifierValidate

private void adHocStringIdentifierValidate(String a_AdHocStringIdentifier)
                                    throws WTPropertyVetoException

Parameters:

a_AdHocStringIdentifier -

Throws:

WTPropertyVetoException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

getCheckoutInfo

public CheckoutInfo getCheckoutInfo()

Gets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

getCheckoutInfo in interface Workable

Returns:

CheckoutInfo

See Also:

CheckoutInfo

setCheckoutInfo

public void setCheckoutInfo(CheckoutInfo a_CheckoutInfo)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

setCheckoutInfo in interface Workable

Parameters:

a_CheckoutInfo -

Throws:

WTPropertyVetoException

See Also:

CheckoutInfo

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

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 -

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

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

setCreator

private void setCreator(WTPrincipalReference principalRef)

setContainerClass

public void setContainerClass(String className)