wt.lifecycle
Class LifeCycleTemplateMaster

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Master
          extended bywt.lifecycle.LifeCycleTemplateMaster
All Implemented Interfaces:
BusinessInformation, DisplayIdentification, Externalizable, Identified, LifeCycleDefinition, Mastered, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public final class LifeCycleTemplateMaster
extends Master
implements LifeCycleDefinition, Identified, WTContained, Externalizable

The definition of a Life Cycle. It is paired with the Life Cycle Template to provide the concept of an iterated and workable Life Cycle.

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

Field Summary
private static String CLASSNAME
           
static String CONTAINER
          Label for the attribute.
private  WTContainerRef containerReference
           
private  String description
           
static String DESCRIPTION
          Label for the attribute; Life cycle description

Supported API: false
private static int DESCRIPTION_UPPER_LIMIT
           
private  boolean enabled
           
static String ENABLED
          Label for the attribute; A boolean that notates whether the Life Cycle Template Master is enabled or disabled

Supported API: false
static long EXTERNALIZATION_VERSION_UID
           
private  String name
           
static String NAME
          Label for the attribute; Unique template name.
private static int NAME_UPPER_LIMIT
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
private  boolean routing
           
static String ROUTING
          Label for the attribute; A boolean that notates whether the Life Cycle Template Master can be used for Routing objects or not

Supported API: false
(package private) static long serialVersionUID
           
static String SUPPORTED_CLASS
          Label for the attribute; The class of object this template will accept.
private static int SUPPORTED_CLASS_UPPER_LIMIT
           
private  String supportedClass
           
 
Fields inherited from class wt.enterprise.Master
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
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.Mastered
SERIES
 
Fields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITY
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
LifeCycleTemplateMaster()
           
 
Method Summary
private  void containerReferenceValidate(WTContainerRef a_ContainerReference)
           
private  void descriptionValidate(String a_Description)
           
 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()
          Gets the object for the association that plays role: CONTAINER.
 String getContainerName()
          Gets the value of the attribute: CONTAINER_NAME.
 WTContainerRef getContainerReference()
          Gets the value of the attribute: CONTAINER_REFERENCE.
 String getDescription()
          Gets the value of the attribute: DESCRIPTION.
 IdentificationObject getIdentificationObject()
          Constructs and returns an identification object.
 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.
 String getSupportedClass()
          Gets the value of the attribute: SUPPORTED_CLASS.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
 boolean isEnabled()
          Gets the value of the attribute: ENABLED.
 boolean isRouting()
          Gets the value of the attribute: ROUTING.
private  void nameValidate(String a_Name)
           
static LifeCycleTemplateMaster newLifeCycleTemplateMaster()
          Default factory for the class.
 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(LifeCycleTemplateMaster thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setContainer(WTContainer a_Container)
          Sets the object for the association that plays role: CONTAINER.
 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.
protected  void setEnabled(boolean a_Enabled)
          Sets the value of the attribute: ENABLED.
protected  void setIdentificationObject(LifeCycleTemplateMasterIdentity identity)
          

Supported API: false
protected  void setIdentity(String name)
          Sets the identity of the template.
 void setName(String a_Name)
          Sets the value of the attribute: NAME.
protected  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.
private  void supportedClassValidate(String a_SupportedClass)
           
 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.Master
getBusinessType, getSeries, readVersion, setSeries
 
Methods inherited from class wt.fc.WTObject
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, 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, 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. Required attribute.

Supported API: false

See Also:
Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

ENABLED

public static final String ENABLED
Label for the attribute; A boolean that notates whether the Life Cycle Template Master is enabled or disabled

Supported API: false

See Also:
Constant Field Values

enabled

private boolean enabled

DESCRIPTION

public static final String DESCRIPTION
Label for the attribute; Life cycle description

Supported API: false

See Also:
Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

SUPPORTED_CLASS

public static final String SUPPORTED_CLASS
Label for the attribute; The class of object this template will accept. Subclasses are also accepted. Required attribute.

Supported API: false

See Also:
Constant Field Values

SUPPORTED_CLASS_UPPER_LIMIT

private static int SUPPORTED_CLASS_UPPER_LIMIT

supportedClass

private String supportedClass

ROUTING

public static final String ROUTING
Label for the attribute; A boolean that notates whether the Life Cycle Template Master can be used for Routing objects or not

Supported API: false

See Also:
Constant Field Values

routing

private boolean routing

CONTAINER

public static final String CONTAINER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

containerReference

private WTContainerRef containerReference

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

LifeCycleTemplateMaster

public LifeCycleTemplateMaster()
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 Master
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 Master
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(LifeCycleTemplateMaster 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 Master
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 Master
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. Required attribute.

Supported API: false

Returns:
String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException
Sets the value of the attribute: NAME. Unique template name. Required attribute.

Supported API: false

Parameters:
a_Name -
Throws:
WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException
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 Master is enabled or disabled

Supported API: false

Returns:
boolean

setEnabled

protected void setEnabled(boolean a_Enabled)
Sets the value of the attribute: ENABLED. A boolean that notates whether the Life Cycle Template Master is enabled or disabled

Supported API: false

Parameters:
a_Enabled -

getDescription

public String getDescription()
Gets the value of the attribute: DESCRIPTION. Life cycle description

Supported API: false

Returns:
String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException
Sets the value of the attribute: DESCRIPTION. Life cycle description

Supported API: false

Parameters:
a_Description -
Throws:
WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException
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. Required attribute.

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. Required attribute.

Supported API: false

Parameters:
a_SupportedClass -
Throws:
WTPropertyVetoException

supportedClassValidate

private void supportedClassValidate(String a_SupportedClass)
                             throws WTPropertyVetoException
Parameters:
a_SupportedClass -
Throws:
WTPropertyVetoException

isRouting

public boolean isRouting()
Gets the value of the attribute: ROUTING. A boolean that notates whether the Life Cycle Template Master can be used for Routing objects or not

Supported API: false

Returns:
boolean

setRouting

protected void setRouting(boolean a_Routing)
Sets the value of the attribute: ROUTING. A boolean that notates whether the Life Cycle Template Master can be used for Routing objects or not

Supported API: false

Parameters:
a_Routing -

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

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 Master
Returns:
String

setIdentity

protected void setIdentity(String name)
Sets the identity of the template. Used to change the identity by the IndentityService after a request is made to change the identity of the object.

Supported API: false

Parameters:
name -
See Also:
IdentityService

setIdentificationObject

protected void setIdentificationObject(LifeCycleTemplateMasterIdentity identity)


Supported API: false

Parameters:
identity -

newLifeCycleTemplateMaster

public static LifeCycleTemplateMaster newLifeCycleTemplateMaster()
                                                          throws WTException
Default factory for the class.

Supported API: false

Returns:
LifeCycleTemplateMaster
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

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

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 Master
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 Master
Returns:
int