wt.lifecycle
Class LifeCycleTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.IteratedFolderResident
          wt.lifecycle.LifeCycleTemplate

All Implemented Interfaces:

AccessControlled, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Iterated, IteratedFoldered, LifeCycleDefinition, Lockable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable, Workable

public final class LifeCycleTemplate

extends IteratedFolderResident

implements LifeCycleDefinition, Externalizable

LifeCycleTemplate holds a Life Cycle specification. It is composed of an ordered sequence of PhaseTemplates. It is paired with the Life Cycle Template Master object to provide the concept of an iterated and workable Life Cycle.

A LifeCycleTemplate is valid for a specific class and its subclasses.

Use the newLifeCycleTemplate static factory method(s), not the LifeCycleTemplate 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:

PhaseTemplate, LifeCycleDefinition, LifeCycleTemplateMaster, Serialized Form

Field Summary

private boolean	basic
static String	BASIC Label for the attribute; This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).
private static String	CLASSNAME
static String	CONTAINER_REFERENCE Label for the attribute; Life Cycle description.
static String	DESCRIPTION Label for the attribute; Life Cycle description.
static String	ENABLED Label for the attribute; A boolean that notates whether the Life Cycle Template is enabled or disabled.
static long	EXTERNALIZATION_VERSION_UID
static String	NAME Label for the attribute; Unique template name.
protected static long	OLD_FORMAT_VERSION_UID
static String	PHASE_TEMPLATE_ID Label for the attribute.
private ObjectReference	phaseTemplateId
private static String	RESOURCE
static String	ROUTING Label for the attribute; A boolean that notates whether the Life Cycle Template can be used to route objects.
(package private) static long	serialVersionUID
static String	SUPPORTED_CLASS Label for the attribute; The class of object this template will accept.

Fields inherited from class wt.enterprise.IteratedFolderResident

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, MASTER

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

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.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

LifeCycleTemplate()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
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	getConceptualClassname() Deprecated.
WTContainer	getContainer() Supported API: false
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getIdentity() Returns a string that can be displayed to the user to identify the object.
LifeCycleTemplate	getLifeCycleTemplate() Depending on the specific object type, return the appropriate Life Cycle Template object.
LifeCycleTemplateReference	getLifeCycleTemplateReference() Depending on the specific object type, return a reference to the appropriate Life Cycle Template object.
String	getName() Gets the value of the attribute: NAME.
ObjectReference	getPhaseTemplateId() Gets the object for the association that plays role: PHASE_TEMPLATE_ID.
String	getSupportedClass() Gets the value of the attribute: SUPPORTED_CLASS.
AdminDomainRef	getSystemDomainReference() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isBasic() Gets the value of the attribute: BASIC.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isRouting() Gets the value of the attribute: ROUTING.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static LifeCycleTemplate	newLifeCycleTemplate() Default factory for the class.
private void	phaseTemplateIdValidate(ObjectReference a_PhaseTemplateId)
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(LifeCycleTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBasic(boolean a_Basic) Sets the value of the attribute: BASIC.
void	setContainer(WTContainerRef container) Supported API: false
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
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	setPhaseTemplateId(ObjectReference a_PhaseTemplateId) Sets the object for the association that plays role: PHASE_TEMPLATE_ID.
void	setRouting(boolean a_Routing) Sets the value of the attribute: ROUTING.
void	setSupportedClass(String a_SupportedClass) Sets the value of the attribute: SUPPORTED_CLASS.
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.enterprise.IteratedFolderResident

getBranchIdentifier, getCabinet, getCabinetName, getCabinetReference, getCheckoutInfo, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEventSet, getFolderingInfo, getFolderPath, getIterationIdentifier, getIterationInfo, getIterationNote, getLocation, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, initialize, isInheritedDomain, isLatestIteration, isLocked, readVersion, setCheckoutInfo, setControlBranch, setDomainRef, setEventSet, setFolderingInfo, setInheritedDomain, setIterationInfo, setLock, setOwnership

Methods inherited from class wt.fc.WTObject

duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, 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

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; Unique template name. This value is derived from the name attribute on the Life Cycle Template Master object.

Supported API: false

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

Label for the attribute; A boolean that notates whether the Life Cycle Template is enabled or disabled. This value is derived from the enabled attribute on the Life Cycle Template Master.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Life Cycle description. This value is derived from the description attribute on the Life Cycle Template Master.

Supported API: false

See Also:

Constant Field Values

SUPPORTED_CLASS

public static final String SUPPORTED_CLASS

Label for the attribute; The class of object this template will accept. Subclasses are also accepted. This value is derived from the supportedClass attribute on the Life Cycle Template Master.

Supported API: false

See Also:

Constant Field Values

CONTAINER_REFERENCE

public static final String CONTAINER_REFERENCE

Label for the attribute; Life Cycle description. This value is derived from the container reference attribute on the Life Cycle Template Master.

Supported API: false

See Also:

Constant Field Values

ROUTING

public static final String ROUTING

Label for the attribute; A boolean that notates whether the Life Cycle Template can be used to route objects. This value is derived from the routing attribute on the Life Cycle Template Master.

Supported API: false

See Also:

Constant Field Values

BASIC

public static final String BASIC

Label for the attribute; This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

See Also:

Constant Field Values

basic

private boolean basic

PHASE_TEMPLATE_ID

public static final String PHASE_TEMPLATE_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

phaseTemplateId

private ObjectReference phaseTemplateId

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

LifeCycleTemplate

public LifeCycleTemplate()

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 IteratedFolderResident

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 IteratedFolderResident

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(LifeCycleTemplate 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 IteratedFolderResident

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 IteratedFolderResident

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. Unique template name. This value is derived from the name attribute on the Life Cycle Template Master object.

Supported API: false

Specified by:

getName in interface CabinetBased

Overrides:

getName in class IteratedFolderResident

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Unique template name. This value is derived from the name attribute on the Life Cycle Template Master object.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED. A boolean that notates whether the Life Cycle Template is enabled or disabled. This value is derived from the enabled attribute on the Life Cycle Template Master.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)
                throws WTPropertyVetoException

Sets the value of the attribute: ENABLED. A boolean that notates whether the Life Cycle Template is enabled or disabled. This value is derived from the enabled attribute on the Life Cycle Template Master.

Supported API: false

Parameters:

a_Enabled -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Life Cycle description. This value is derived from the description attribute on the Life Cycle Template Master.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Life Cycle description. This value is derived from the description attribute on the Life Cycle Template Master.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getSupportedClass

public String getSupportedClass()

Gets the value of the attribute: SUPPORTED_CLASS. The class of object this template will accept. Subclasses are also accepted. This value is derived from the supportedClass attribute on the Life Cycle Template Master.

Supported API: false

Returns:

String

setSupportedClass

public void setSupportedClass(String a_SupportedClass)
                       throws WTPropertyVetoException

Sets the value of the attribute: SUPPORTED_CLASS. The class of object this template will accept. Subclasses are also accepted. This value is derived from the supportedClass attribute on the Life Cycle Template Master.

Supported API: false

Parameters:

a_SupportedClass -

Throws:

WTPropertyVetoException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE. Life Cycle description. This value is derived from the container reference attribute on the Life Cycle Template Master.

Supported API: false

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE. Life Cycle description. This value is derived from the container reference attribute on the Life Cycle Template Master.

Supported API: false

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

isRouting

public boolean isRouting()

Gets the value of the attribute: ROUTING. A boolean that notates whether the Life Cycle Template can be used to route objects. This value is derived from the routing attribute on the Life Cycle Template Master.

Supported API: false

Returns:

boolean

setRouting

public void setRouting(boolean a_Routing)
                throws WTPropertyVetoException

Sets the value of the attribute: ROUTING. A boolean that notates whether the Life Cycle Template can be used to route objects. This value is derived from the routing attribute on the Life Cycle Template Master.

Supported API: false

Parameters:

a_Routing -

Throws:

WTPropertyVetoException

isBasic

public boolean isBasic()

Gets the value of the attribute: BASIC. This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

Returns:

boolean

setBasic

public void setBasic(boolean a_Basic)
              throws WTPropertyVetoException

Sets the value of the attribute: BASIC. This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

Parameters:

a_Basic -

Throws:

WTPropertyVetoException

getPhaseTemplateId

public ObjectReference getPhaseTemplateId()

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

Supported API: false

Returns:

ObjectReference

setPhaseTemplateId

public void setPhaseTemplateId(ObjectReference a_PhaseTemplateId)
                        throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_PhaseTemplateId -

Throws:

WTPropertyVetoException

phaseTemplateIdValidate

private void phaseTemplateIdValidate(ObjectReference a_PhaseTemplateId)
                              throws WTPropertyVetoException

Parameters:

a_PhaseTemplateId -

Throws:

WTPropertyVetoException

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

Overrides:

setMaster in class IteratedFolderResident

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

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

Overrides:

setMasterReference in class IteratedFolderResident

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Returns a string that can be displayed to the user to identify the object. WTObject implements a default method that returns a string representation of this object's identifier.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class WTObject

Returns:

String

getContainer

public WTContainer getContainer()

Supported API: false

Returns:

WTContainer

setContainer

public void setContainer(WTContainerRef container)
                  throws WTPropertyVetoException,
                         WTException

Supported API: false

Parameters:

container -

Throws:

WTPropertyVetoException

WTException

getSystemDomainReference

public AdminDomainRef getSystemDomainReference()

Supported API: false

Returns:

AdminDomainRef

newLifeCycleTemplate

public static LifeCycleTemplate newLifeCycleTemplate()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

LifeCycleTemplate

Throws:

WTException

getLifeCycleTemplate

public LifeCycleTemplate getLifeCycleTemplate()
                                       throws WTException

Depending on the specific object type, return the appropriate Life Cycle Template object.

Supported API: false

Specified by:

getLifeCycleTemplate in interface LifeCycleDefinition

Returns:

LifeCycleTemplate

Throws:

WTException

getLifeCycleTemplateReference

public LifeCycleTemplateReference getLifeCycleTemplateReference()
                                                         throws WTException

Depending on the specific object type, return a reference to the appropriate Life Cycle Template object.

Supported API: false

Specified by:

getLifeCycleTemplateReference in interface LifeCycleDefinition

Returns:

LifeCycleTemplateReference

Throws:

WTException

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 IteratedFolderResident

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 IteratedFolderResident

Returns:

int

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Description copied from interface: Persistable

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException