wt.workflow.definer
Class WfSynchRobotTemplate

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

All Implemented Interfaces:

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

public class WfSynchRobotTemplate

extends WfRobotActivityTemplate

implements Externalizable

Use the newWfSynchRobotTemplate static factory method(s), not the WfSynchRobotTemplate 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	EVENT_KEY Label for the attribute.
private static int	EVENT_KEY_UPPER_LIMIT
private String	eventKey
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SYNCH_TYPE Label for the attribute; Type of the synchronization.
private static int	SYNCH_TYPE_UPPER_LIMIT
private WfSynchType	synchType
static String	TARGET_CLASS_NAME Label for the attribute.
private static int	TARGET_CLASS_NAME_UPPER_LIMIT
static String	TARGET_VARIABLE_NAME Label for the attribute; Attribute that holds name of the variable that references the object to be used for object event synchronization.
private static int	TARGET_VARIABLE_NAME_UPPER_LIMIT
private String	targetClassName
private String	targetVariableName

Fields inherited from class wt.workflow.definer.WfRobotActivityTemplate

HOST

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

WfSynchRobotTemplate()

Method Summary

WfTemplateObject	copy() Produces a transient, shallow copy of the object.
WfTemplateObject	copy(WTContainerRef context_ref) Produces a transient, shallow copy of the object.
protected void	copyAttributes(WfTemplateObject template) Copies all attributes into the template object passed as argument.
WfNode	createWfNode(WfContainer container) Creates a synchronization robot from the current template associated with a given process.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	eventKeyValidate(String a_EventKey)
String	getConceptualClassname() Deprecated.
ProcessDataInfo	getContextSignature() Returns context signature of the robot template.
String	getEventKey() Gets the value of the attribute: EVENT_KEY.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
WfSynchType	getSynchType() Gets the value of the attribute: SYNCH_TYPE.
String	getTargetClassName() Gets the value of the attribute: TARGET_CLASS_NAME.
String	getTargetVariableName() Gets the value of the attribute: TARGET_VARIABLE_NAME.
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 WfSynchRobotTemplate	newWfSynchRobotTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfSynchRobotTemplate	newWfSynchRobotTemplate(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(WfSynchRobotTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEventKey(String a_EventKey) Sets the value of the attribute: EVENT_KEY.
void	setSynchType(WfSynchType a_SynchType) Sets the value of the attribute: SYNCH_TYPE.
void	setTargetClassName(String a_TargetClassName) Sets the value of the attribute: TARGET_CLASS_NAME.
void	setTargetVariableName(String a_TargetVariableName) Sets the value of the attribute: TARGET_VARIABLE_NAME.
private void	targetClassNameValidate(String a_TargetClassName)
private void	targetVariableNameValidate(String a_TargetVariableName)
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.workflow.definer.WfRobotActivityTemplate

getHost, readVersion, setHost

Methods inherited from class wt.workflow.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, getCategory, getContainer, getContainerName, getContainerReference, getDescription, getDestinationActions, getDuration, getEventConfiguration, getIconName, getIdentity, getName, getOverdueNotificationList, getOverdueNotificationRoles, getParentLinkRef, getParentTemplate, getPredecessors, getProcessDuration, getResponsibleRole, getRouterType, getSourceEvents, getStartDelay, getStartProcessDelay, getSuccessors, getTimePastDeadline, getTimeToDeadline, getUserEventList, 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

EVENT_KEY

public static final String EVENT_KEY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

EVENT_KEY_UPPER_LIMIT

private static int EVENT_KEY_UPPER_LIMIT

eventKey

private String eventKey

TARGET_CLASS_NAME

public static final String TARGET_CLASS_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TARGET_CLASS_NAME_UPPER_LIMIT

private static int TARGET_CLASS_NAME_UPPER_LIMIT

targetClassName

private String targetClassName

TARGET_VARIABLE_NAME

public static final String TARGET_VARIABLE_NAME

Label for the attribute; Attribute that holds name of the variable that references the object to be used for object event synchronization.

Supported API: false

See Also:

Constant Field Values

TARGET_VARIABLE_NAME_UPPER_LIMIT

private static int TARGET_VARIABLE_NAME_UPPER_LIMIT

targetVariableName

private String targetVariableName

SYNCH_TYPE

public static final String SYNCH_TYPE

Label for the attribute; Type of the synchronization. Two types are possible: EVENT - for Windchill event synchronization - and EXPRESSION - for synchronization through user-defined expressions.

Supported API: false

See Also:

Constant Field Values

SYNCH_TYPE_UPPER_LIMIT

private static int SYNCH_TYPE_UPPER_LIMIT

synchType

private WfSynchType synchType

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

WfSynchRobotTemplate

public WfSynchRobotTemplate()

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 WfRobotActivityTemplate

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 WfRobotActivityTemplate

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfSynchRobotTemplate 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 WfRobotActivityTemplate

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 WfRobotActivityTemplate

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

getEventKey

public String getEventKey()

Gets the value of the attribute: EVENT_KEY.

Supported API: false

Returns:

String

setEventKey

public void setEventKey(String a_EventKey)
                 throws WTPropertyVetoException

Sets the value of the attribute: EVENT_KEY.

Supported API: false

Parameters:

a_EventKey -

Throws:

WTPropertyVetoException

eventKeyValidate

private void eventKeyValidate(String a_EventKey)
                       throws WTPropertyVetoException

Parameters:

a_EventKey -

Throws:

WTPropertyVetoException

getTargetClassName

public String getTargetClassName()

Gets the value of the attribute: TARGET_CLASS_NAME.

Supported API: false

Returns:

String

setTargetClassName

public void setTargetClassName(String a_TargetClassName)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_CLASS_NAME.

Supported API: false

Parameters:

a_TargetClassName -

Throws:

WTPropertyVetoException

targetClassNameValidate

private void targetClassNameValidate(String a_TargetClassName)
                              throws WTPropertyVetoException

Parameters:

a_TargetClassName -

Throws:

WTPropertyVetoException

getTargetVariableName

public String getTargetVariableName()

Gets the value of the attribute: TARGET_VARIABLE_NAME. Attribute that holds name of the variable that references the object to be used for object event synchronization.

Supported API: false

Returns:

String

setTargetVariableName

public void setTargetVariableName(String a_TargetVariableName)
                           throws WTPropertyVetoException

Sets the value of the attribute: TARGET_VARIABLE_NAME. Attribute that holds name of the variable that references the object to be used for object event synchronization.

Supported API: false

Parameters:

a_TargetVariableName -

Throws:

WTPropertyVetoException

targetVariableNameValidate

private void targetVariableNameValidate(String a_TargetVariableName)
                                 throws WTPropertyVetoException

Parameters:

a_TargetVariableName -

Throws:

WTPropertyVetoException

getSynchType

public WfSynchType getSynchType()

Gets the value of the attribute: SYNCH_TYPE. Type of the synchronization. Two types are possible: EVENT - for Windchill event synchronization - and EXPRESSION - for synchronization through user-defined expressions.

Supported API: false

Returns:

WfSynchType

setSynchType

public void setSynchType(WfSynchType a_SynchType)
                  throws WTPropertyVetoException

Sets the value of the attribute: SYNCH_TYPE. Type of the synchronization. Two types are possible: EVENT - for Windchill event synchronization - and EXPRESSION - for synchronization through user-defined expressions.

Supported API: false

Parameters:

a_SynchType -

Throws:

WTPropertyVetoException

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 WfRobotActivityTemplate

Returns:

String

copy

public WfTemplateObject copy()
                      throws WTException

Produces a transient, shallow copy of the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

Returns:

WfTemplateObject

Throws:

WTException

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a synchronization robot from the current template associated with a given process.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

copyAttributes

protected void copyAttributes(WfTemplateObject template)

Copies all attributes into the template object passed as argument.

Supported API: false

Overrides:

copyAttributes in class WfRobotActivityTemplate

Parameters:

template -

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

getContextSignature

public ProcessDataInfo getContextSignature()

Returns context signature of the robot template. Overrides WfTemplateObject.getContextSignature to return the signature of the parent process in case there is one.

Supported API: false

Overrides:

getContextSignature in class WfTemplateObject

Returns:

ProcessDataInfo

newWfSynchRobotTemplate

public static WfSynchRobotTemplate newWfSynchRobotTemplate()
                                                    throws WTException

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

Supported API: false

Returns:

WfSynchRobotTemplate

Throws:

WTException

newWfSynchRobotTemplate

public static WfSynchRobotTemplate newWfSynchRobotTemplate(WTContainerRef context_ref)
                                                    throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfSynchRobotTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the object. This method is abstract and should be implemented by all concrete subclasses of WfTemplateObject.

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 WfRobotActivityTemplate

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 WfRobotActivityTemplate

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