wt.workflow.definer
Class ProcessStepTemplateLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.workflow.definer.ProcessStepTemplateLink

All Implemented Interfaces:

BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public class ProcessStepTemplateLink

extends ObjectToObjectLink

implements Externalizable

ProcessStepDefLink associates the process template with with constituent objects (activity and connector templates). It holds the map between local and global workflow variables.

Use the newProcessStepTemplateLink static factory method(s), not the ProcessStepTemplateLink constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	INPUT_VARIABLE_MAP Label for the attribute; Maps process variables to step (activity) variables.
private static int	INPUT_VARIABLE_MAP_UPPER_LIMIT
private WfVariableMap	inputVariableMap
protected static long	OLD_FORMAT_VERSION_UID
static String	OUTPUT_VARIABLE_MAP Label for the attribute; Maps step (activity) variables to process variables.
private static int	OUTPUT_VARIABLE_MAP_UPPER_LIMIT
private WfVariableMap	outputVariableMap
static String	PROCESS_ROLE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	STEP_ROLE Label for the attribute.

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ProcessStepTemplateLink()

Method Summary

private DataFlowDefect	createDefect(WfTemplateObject node, String source, String destination, DataFlowDefectType defect_type) Creates a data flow defect given its node, source destination and type.
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.
Enumeration	getInputMapDefects() Checks if the input map is valid.
WfVariableMap	getInputVariableMap() Gets the value of the attribute: INPUT_VARIABLE_MAP.
Enumeration	getOutputMapDefects() Checks if the output map is valid.
WfVariableMap	getOutputVariableMap() Gets the value of the attribute: OUTPUT_VARIABLE_MAP.
WfContainerTemplate	getProcess() Gets the object for the association that plays role: PROCESS_ROLE.
WfTemplateObject	getStep() Gets the object for the association that plays role: STEP_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WfContainerTemplate process, WfTemplateObject step)
static ProcessStepTemplateLink	newProcessStepTemplateLink(WfContainerTemplate process, WfTemplateObject step) 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(ProcessStepTemplateLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setInputVariableMap(WfVariableMap a_InputVariableMap) Sets the value of the attribute: INPUT_VARIABLE_MAP.
void	setOutputVariableMap(WfVariableMap a_OutputVariableMap) Sets the value of the attribute: OUTPUT_VARIABLE_MAP.
void	setProcess(WfContainerTemplate process) Sets the object for the association that plays role: PROCESS_ROLE.
void	setStep(WfTemplateObject step) Sets the object for the association that plays role: STEP_ROLE.
String	toString() Returns string representation of the object.
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.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

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

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

PROCESS_ROLE

public static final String PROCESS_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

STEP_ROLE

public static final String STEP_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

INPUT_VARIABLE_MAP

public static final String INPUT_VARIABLE_MAP

Label for the attribute; Maps process variables to step (activity) variables.

Supported API: false

See Also:

Constant Field Values

INPUT_VARIABLE_MAP_UPPER_LIMIT

private static int INPUT_VARIABLE_MAP_UPPER_LIMIT

inputVariableMap

private WfVariableMap inputVariableMap

OUTPUT_VARIABLE_MAP

public static final String OUTPUT_VARIABLE_MAP

Label for the attribute; Maps step (activity) variables to process variables.

Supported API: false

See Also:

Constant Field Values

OUTPUT_VARIABLE_MAP_UPPER_LIMIT

private static int OUTPUT_VARIABLE_MAP_UPPER_LIMIT

outputVariableMap

private WfVariableMap outputVariableMap

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

ProcessStepTemplateLink

public ProcessStepTemplateLink()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ProcessStepTemplateLink 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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getProcess

public WfContainerTemplate getProcess()

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

Supported API: false

Returns:

WfContainerTemplate

setProcess

public void setProcess(WfContainerTemplate process)
                throws WTPropertyVetoException

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

Supported API: false

Parameters:

process -

Throws:

WTPropertyVetoException

getStep

public WfTemplateObject getStep()

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

Supported API: false

Returns:

WfTemplateObject

setStep

public void setStep(WfTemplateObject step)
             throws WTPropertyVetoException

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

Supported API: false

Parameters:

step -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getInputVariableMap

public WfVariableMap getInputVariableMap()

Gets the value of the attribute: INPUT_VARIABLE_MAP. Maps process variables to step (activity) variables.

Supported API: false

Returns:

WfVariableMap

setInputVariableMap

public void setInputVariableMap(WfVariableMap a_InputVariableMap)

Sets the value of the attribute: INPUT_VARIABLE_MAP. Maps process variables to step (activity) variables.

Supported API: false

Parameters:

a_InputVariableMap -

getOutputVariableMap

public WfVariableMap getOutputVariableMap()

Gets the value of the attribute: OUTPUT_VARIABLE_MAP. Maps step (activity) variables to process variables.

Supported API: false

Returns:

WfVariableMap

setOutputVariableMap

public void setOutputVariableMap(WfVariableMap a_OutputVariableMap)

Sets the value of the attribute: OUTPUT_VARIABLE_MAP. Maps step (activity) variables to process variables.

Supported API: false

Parameters:

a_OutputVariableMap -

toString

public String toString()

Returns string representation of the object. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

getInputMapDefects

public Enumeration getInputMapDefects()
                               throws WTException

Checks if the input map is valid. Returns a list of DataFlowDefect objects. Each data flow defect can be one of the following:

• missing source: source variable does not occur in source node
• wrong destination: destination variable is INPUT or LOCAL
• missing destination: destination variable does not occur in destination node
• type incompatible: source and destination variables are not compatible

Supported API: false

Returns:

Enumeration

Throws:

WTException

getOutputMapDefects

public Enumeration getOutputMapDefects()
                                throws WTException

Checks if the output map is valid. Returns a list of DataFlowDefect objects. Each data flow defect can be one of the following:

• missing source: source variable does not occur in source node
• wrong source: source variable is an OUTPUT variable
• missing destination: destination variable does not occur in destination node
• type incompatible: source and destination variables are not compatible

Supported API: false

Returns:

Enumeration

Throws:

WTException

newProcessStepTemplateLink

public static ProcessStepTemplateLink newProcessStepTemplateLink(WfContainerTemplate process,
                                                                 WfTemplateObject step)
                                                          throws WTException

Default factory for the class.

Supported API: false

Parameters:

process -

step -

Returns:

ProcessStepTemplateLink

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

initialize

protected void initialize(WfContainerTemplate process,
                          WfTemplateObject step)
                   throws WTException

Throws:

WTException

createDefect

private DataFlowDefect createDefect(WfTemplateObject node,
                                    String source,
                                    String destination,
                                    DataFlowDefectType defect_type)
                             throws WTException

Creates a data flow defect given its node, source destination and type.

Parameters:

node - - workflow template object with the defect

source - - source variable involved in the defect (may be null in case of multiple target defect type)

destination - - destination variable involved in the defect

defect_type - - type of the data flow defect

Returns:

DataFlowDefect

Throws:

WTException