wt.workflow.definer
Class WfApplRobotTemplate

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

All Implemented Interfaces:

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

public class WfApplRobotTemplate

extends WfRobotActivityTemplate

implements Externalizable

Template for application robots, that is, activities that correspond to programs or applications.

Use the newWfApplRobotTemplate static factory method(s), not the WfApplRobotTemplate 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	COMMAND_LINE Label for the attribute; String containing the application call to be made.
private static int	COMMAND_LINE_UPPER_LIMIT
private String	commandLine
private SignatureVector	environment
static String	ENVIRONMENT Label for the attribute; Environment as a list of strings of the form 'name=value,' where name is the name of an environment variable and value is its value.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private boolean	synchronous
static String	SYNCHRONOUS Label for the attribute; Variable that determines whether the application call is synchronous or asynchronous.

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

WfApplRobotTemplate()

Method Summary

private void	commandLineValidate(String a_CommandLine)
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 an application 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.
String	getCommandLine() Gets the value of the attribute: COMMAND_LINE.
String	getConceptualClassname() Deprecated.
ProcessDataInfo	getContextSignature() Returns context signature of the robot template.
SignatureVector	getEnvironment() Gets the value of the attribute: ENVIRONMENT.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isSynchronous() Gets the value of the attribute: SYNCHRONOUS.
static WfApplRobotTemplate	newWfApplRobotTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfApplRobotTemplate	newWfApplRobotTemplate(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(WfApplRobotTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCommandLine(String a_CommandLine) Sets the value of the attribute: COMMAND_LINE.
void	setEnvironment(SignatureVector a_Environment) Sets the value of the attribute: ENVIRONMENT.
void	setSynchronous(boolean a_Synchronous) Sets the value of the attribute: SYNCHRONOUS.
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, initialize, initialize, 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

COMMAND_LINE

public static final String COMMAND_LINE

Label for the attribute; String containing the application call to be made. May contain references to variables to be replaced at runtime. In this case the variable names must be surrounded by a pair of curly brackets ('{' and '}').

Supported API: false

See Also:

Constant Field Values

COMMAND_LINE_UPPER_LIMIT

private static int COMMAND_LINE_UPPER_LIMIT

commandLine

private String commandLine

ENVIRONMENT

public static final String ENVIRONMENT

Label for the attribute; Environment as a list of strings of the form 'name=value,' where name is the name of an environment variable and value is its value.

Supported API: false

See Also:

Constant Field Values

environment

private SignatureVector environment

SYNCHRONOUS

public static final String SYNCHRONOUS

Label for the attribute; Variable that determines whether the application call is synchronous or asynchronous. If synchronous (true) the robot waits for the completion of the application to change state to completed; otherwise (synchronous = false), the application is launched and the robot changes immediately the state to "completed."

Supported API: false

See Also:

Constant Field Values

synchronous

private boolean synchronous

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

WfApplRobotTemplate

public WfApplRobotTemplate()

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(WfApplRobotTemplate 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

getCommandLine

public String getCommandLine()

Gets the value of the attribute: COMMAND_LINE. String containing the application call to be made. May contain references to variables to be replaced at runtime. In this case the variable names must be surrounded by a pair of curly brackets ('{' and '}').

Supported API: false

Returns:

String

setCommandLine

public void setCommandLine(String a_CommandLine)
                    throws WTPropertyVetoException

Sets the value of the attribute: COMMAND_LINE. String containing the application call to be made. May contain references to variables to be replaced at runtime. In this case the variable names must be surrounded by a pair of curly brackets ('{' and '}').

Supported API: false

Parameters:

a_CommandLine -

Throws:

WTPropertyVetoException

commandLineValidate

private void commandLineValidate(String a_CommandLine)
                          throws WTPropertyVetoException

Parameters:

a_CommandLine -

Throws:

WTPropertyVetoException

getEnvironment

public SignatureVector getEnvironment()

Gets the value of the attribute: ENVIRONMENT. Environment as a list of strings of the form 'name=value,' where name is the name of an environment variable and value is its value.

Supported API: false

Returns:

SignatureVector

setEnvironment

public void setEnvironment(SignatureVector a_Environment)
                    throws WTPropertyVetoException

Sets the value of the attribute: ENVIRONMENT. Environment as a list of strings of the form 'name=value,' where name is the name of an environment variable and value is its value.

Supported API: false

Parameters:

a_Environment -

Throws:

WTPropertyVetoException

isSynchronous

public boolean isSynchronous()

Gets the value of the attribute: SYNCHRONOUS. Variable that determines whether the application call is synchronous or asynchronous. If synchronous (true) the robot waits for the completion of the application to change state to completed; otherwise (synchronous = false), the application is launched and the robot changes immediately the state to "completed."

Supported API: false

Returns:

boolean

setSynchronous

public void setSynchronous(boolean a_Synchronous)
                    throws WTPropertyVetoException

Sets the value of the attribute: SYNCHRONOUS. Variable that determines whether the application call is synchronous or asynchronous. If synchronous (true) the robot waits for the completion of the application to change state to completed; otherwise (synchronous = false), the application is launched and the robot changes immediately the state to "completed."

Supported API: false

Parameters:

a_Synchronous -

Throws:

WTPropertyVetoException

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 an application 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 -

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

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

newWfApplRobotTemplate

public static WfApplRobotTemplate newWfApplRobotTemplate()
                                                  throws WTException

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

Supported API: false

Returns:

WfApplRobotTemplate

Throws:

WTException

newWfApplRobotTemplate

public static WfApplRobotTemplate newWfApplRobotTemplate(WTContainerRef context_ref)
                                                  throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfApplRobotTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the object.

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