wt.workflow.definer
Class WfProxyTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.definer.WfTemplateObject
              wt.workflow.definer.WfProxyTemplate

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WfNodeTemplate, WTContained

public class WfProxyTemplate

extends WfTemplateObject

implements Externalizable

Object that points to a template. Contains two attributes: a reference to a target template (that could be another proxy) and a type that determines, for revision controlled templates, which iteration is being referenced.

Use the newWfProxyTemplate static factory method(s), not the WfProxyTemplate 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 String	DEFINITION Label for the attribute.
static String	DEFINITION_REFERENCE Label for the attribute.
private ObjectReference	definitionReference
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private static boolean	VERBOSE

Fields inherited from class wt.workflow.definer.WfTemplateObject

CATEGORY, CONTAINER, CONTEXT_SIGNATURE, DESCRIPTION, DURATION, EVENT_CONFIGURATION, ICON_NAME, NAME, ORG_ATTRIBUTE, OVERDUE_NOTIFICATION_LIST, PARENT_LINK_REF, PROCESS_DURATION, R30_EXTERNALIZATION_VERSION_UID, R60_EXTERNALIZATION_VERSION_UID, RESPONSIBLE_ROLE, SELF_VARIABLE_NAME, START_DELAY, START_PROCESS_DELAY, TIME_PAST_DEADLINE, TIME_TO_DEADLINE

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.workflow.definer.WfNodeTemplate

PARENT_TEMPLATE, ROUTER_TYPE, USER_EVENT_LIST, X_COORD, Y_COORD

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.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WfProxyTemplate()

Method Summary

WfTemplateObject	copy() Produces a transient, shallow copy of the proxy template.
WfTemplateObject	copy(WTContainerRef context_ref) Produces a transient, shallow copy of the proxy template.
protected void	copyAttributes(WfTemplateObject template) Copies all attributes into the template object passed as argument.
WfNode	createWfNode(WfContainer container) Creates a requester activity and a process instantiated from the target template given the containing process.
private void	definitionReferenceValidate(ObjectReference a_DefinitionReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
WfTemplateCategory	getCategory() Returns the target template's category.
String	getConceptualClassname() Deprecated.
ProcessDataInfo	getContextSignature() Returns the target template's context signature.
WfProcessDefinition	getDefinition() Gets the object for the association that plays role: DEFINITION.
ObjectReference	getDefinitionReference() Gets the value of the attribute: DEFINITION_REFERENCE.
String	getDescription() Returns the target template's description.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
String	getName() Returns the target template's name.
WfProxyType	getProxyType() Returns the type of the proxy.
WfRouterType	getRouterType() Returns the target template's router type.
WfProcessTemplate	getTargetTemplate() Returns the WfTemplateObject that is not a proxy that the proxy is referring to.
UserEventVector	getUserEventList() Returns the target template's user event list.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
protected void	initialize(WTContainerRef context_ref) Supported API: false
static WfProxyTemplate	newWfProxyTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfProxyTemplate	newWfProxyTemplate(WTContainerRef context_ref) Supported API: false
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(WfProxyTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDefinition(WfProcessDefinition a_Definition) Sets the object for the association that plays role: DEFINITION.
void	setDefinitionReference(ObjectReference a_DefinitionReference) Sets the value of the attribute: DEFINITION_REFERENCE.
String	toString() Returns a 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.workflow.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, getContainer, getContainerName, getContainerReference, getDestinationActions, getDuration, getEventConfiguration, getIconName, getIdentity, getOverdueNotificationList, getOverdueNotificationRoles, getParentLinkRef, getParentTemplate, getPredecessors, getProcessDuration, getResponsibleRole, getSourceEvents, getStartDelay, getStartProcessDelay, getSuccessors, getTimePastDeadline, getTimeToDeadline, getUserEvents, getXCoord, getYCoord, readVersion, removeOverdueNotificationRole, removeUserEvent, setAttributes, setBasicAttributes, setCategory, setContainer, setContainerReference, setContextSignature, setDescription, setDuration, setEventConfiguration, setIconName, setLinkRef, setName, setOverdueNotificationList, setParentLinkRef, setParentTemplate, setProcessDuration, setResponsibleRole, setRouterAttributes, setRouterType, setStartDelay, setStartProcessDelay, setTimePastDeadline, setTimeToDeadline, setUserEventList, setVariableMapping, setXCoord, setYCoord

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

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

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

DEFINITION

public static final String DEFINITION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DEFINITION_REFERENCE

public static final String DEFINITION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

definitionReference

private ObjectReference definitionReference

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

VERBOSE

private static boolean VERBOSE

Constructor Detail

WfProxyTemplate

public WfProxyTemplate()

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 WfTemplateObject

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 WfTemplateObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfProxyTemplate 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 WfTemplateObject

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 WfTemplateObject

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

getDefinition

public WfProcessDefinition getDefinition()

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

Supported API: false

Returns:

WfProcessDefinition

setDefinition

public void setDefinition(WfProcessDefinition a_Definition)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: false

Parameters:

a_Definition -

Throws:

WTPropertyVetoException

WTException

getDefinitionReference

public ObjectReference getDefinitionReference()

Gets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDefinitionReference

public void setDefinitionReference(ObjectReference a_DefinitionReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

definitionReferenceValidate

private void definitionReferenceValidate(ObjectReference a_DefinitionReference)
                                  throws WTPropertyVetoException

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

getTargetTemplate

public WfProcessTemplate getTargetTemplate()
                                    throws WTException

Returns the WfTemplateObject that is not a proxy that the proxy is referring to.

Supported API: false

Returns:

WfProcessTemplate

Throws:

WTException

copy

public WfTemplateObject copy()
                      throws WTException

Produces a transient, shallow copy of the proxy template.

Supported API: false

Specified by:

copy in class WfTemplateObject

Returns:

WfTemplateObject

Throws:

WTException

copyAttributes

protected void copyAttributes(WfTemplateObject template)

Copies all attributes into the template object passed as argument. Calls super.copyAttributes().

Supported API: false

Overrides:

copyAttributes in class WfTemplateObject

Parameters:

template -

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a requester activity and a process instantiated from the target template given the containing process. Returns the requester activity.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

getRouterType

public WfRouterType getRouterType()

Returns the target template's router type.

Supported API: false

Specified by:

getRouterType in interface WfNodeTemplate

Overrides:

getRouterType in class WfTemplateObject

Returns:

WfRouterType

getUserEventList

public UserEventVector getUserEventList()

Returns the target template's user event list.

Supported API: false

Specified by:

getUserEventList in interface WfNodeTemplate

Overrides:

getUserEventList in class WfTemplateObject

Returns:

UserEventVector

getName

public String getName()

Returns the target template's name.

Supported API: false

Overrides:

getName in class WfTemplateObject

Returns:

String

getDescription

public String getDescription()

Returns the target template's description.

Supported API: false

Overrides:

getDescription in class WfTemplateObject

Returns:

String

getCategory

public WfTemplateCategory getCategory()

Returns the target template's category.

Supported API: false

Overrides:

getCategory in class WfTemplateObject

Returns:

WfTemplateCategory

getContextSignature

public ProcessDataInfo getContextSignature()

Returns the target template's context signature.

Supported API: false

Overrides:

getContextSignature in class WfTemplateObject

Returns:

ProcessDataInfo

toString

public String toString()

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

Supported API: false

Overrides:

toString in class WfTemplateObject

Returns:

String

getProxyType

public WfProxyType getProxyType()

Returns the type of the proxy. The type is "CURRENT" if the process definition pointed to by the proxy is a specific process template iteration; "LATEST" if it is a master template. Returns null if the proxy doesn't refer toa process definition.

Supported API: false

Returns:

WfProxyType

getExecObjClass

public Class getExecObjClass()

Returns the class of the execution object instantiated by theis class. It is the same returned by the createWfNode method.

Supported API: false

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

newWfProxyTemplate

public static WfProxyTemplate newWfProxyTemplate()
                                          throws WTException

Deprecated. activities created with this constructor are placed in the classic container.

Supported API: false

Returns:

WfProxyTemplate

Throws:

WTException

newWfProxyTemplate

public static WfProxyTemplate newWfProxyTemplate(WTContainerRef context_ref)
                                          throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfProxyTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the proxy template.

Supported API: false

Specified by:

copy in class WfTemplateObject

Parameters:

context_ref -

Returns:

WfTemplateObject

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 WfTemplateObject

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 WfTemplateObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Simple

Supported API: false

Overrides:

initialize in class WfTemplateObject

Throws:

WTException

initialize

protected void initialize(WTContainerRef context_ref)
                   throws WTException

Description copied from class: WfTemplateObject

Supported API: false

Overrides:

initialize in class WfTemplateObject

Parameters:

context_ref -

Throws:

WTException