wt.workflow.definer
Class WfInvokedMethodTemplate

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

All Implemented Interfaces:

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

Direct Known Subclasses:

WfExternalMethodTemplate, WfInternalMethodTemplate

public abstract class WfInvokedMethodTemplate

extends WfRobotActivityTemplate

implements Externalizable

Template for creation of method robot activities. Serves as a factory.

Supported API: false

Extendable: false

See Also:

WfInvokedMethod, WfInternalInvokedMethod, WfExternalInvokedMethod, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	METHOD_NAME Label for the attribute; The name of the method within the Windchill service.
private static int	METHOD_NAME_UPPER_LIMIT
static String	METHOD_RETURN Label for the attribute; Name of the workflow process variable to hold the method return value Supported API: false
private static int	METHOD_RETURN_UPPER_LIMIT
private String	methodName
private String	methodReturn
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SERVICE_NAME Label for the attribute; The name of the windchill service exposing the method Supported API: false
private static int	SERVICE_NAME_UPPER_LIMIT
private String	serviceName
private SignatureVector	signature
static String	SIGNATURE Label for the attribute; Vector of process variable names matching the method signature Supported API: false

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

WfInvokedMethodTemplate()

Method Summary

protected void	copyAttributes(WfTemplateObject template) Copies all attributes into the template object passed as argument.
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	getMethodName() Gets the value of the attribute: METHOD_NAME.
String	getMethodReturn() Gets the value of the attribute: METHOD_RETURN.
String	getServiceName() Gets the value of the attribute: SERVICE_NAME.
SignatureVector	getSignature() Gets the value of the attribute: SIGNATURE.
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
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(WfInvokedMethodTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setMethodName(String a_MethodName) Sets the value of the attribute: METHOD_NAME.
void	setMethodReturn(String a_MethodReturn) Sets the value of the attribute: METHOD_RETURN.
void	setServiceName(String a_ServiceName) Sets the value of the attribute: SERVICE_NAME.
void	setSignature(SignatureVector a_Signature) Sets the value of the attribute: SIGNATURE.
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, toString

Methods inherited from class wt.workflow.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, copy, copy, getCategory, getContainer, getContainerName, getContainerReference, getContextSignature, getDescription, getDestinationActions, getDuration, getEventConfiguration, getExecObjClass, 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.workflow.definer.WfNodeTemplate

createWfNode

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SERVICE_NAME

public static final String SERVICE_NAME

Label for the attribute; The name of the windchill service exposing the method

Supported API: false

See Also:

Constant Field Values

SERVICE_NAME_UPPER_LIMIT

private static int SERVICE_NAME_UPPER_LIMIT

serviceName

private String serviceName

METHOD_NAME

public static final String METHOD_NAME

Label for the attribute; The name of the method within the Windchill service.

Supported API: false

See Also:

Constant Field Values

METHOD_NAME_UPPER_LIMIT

private static int METHOD_NAME_UPPER_LIMIT

methodName

private String methodName

SIGNATURE

public static final String SIGNATURE

Label for the attribute; Vector of process variable names matching the method signature

Supported API: false

See Also:

Constant Field Values

signature

private SignatureVector signature

METHOD_RETURN

public static final String METHOD_RETURN

Label for the attribute; Name of the workflow process variable to hold the method return value

Supported API: false

See Also:

Constant Field Values

METHOD_RETURN_UPPER_LIMIT

private static int METHOD_RETURN_UPPER_LIMIT

methodReturn

private String methodReturn

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

WfInvokedMethodTemplate

public WfInvokedMethodTemplate()

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

getServiceName

public String getServiceName()

Gets the value of the attribute: SERVICE_NAME. The name of the windchill service exposing the method

Supported API: false

Returns:

String

setServiceName

public void setServiceName(String a_ServiceName)

Sets the value of the attribute: SERVICE_NAME. The name of the windchill service exposing the method

Supported API: false

Parameters:

a_ServiceName -

getMethodName

public String getMethodName()

Gets the value of the attribute: METHOD_NAME. The name of the method within the Windchill service.

Supported API: false

Returns:

String

setMethodName

public void setMethodName(String a_MethodName)

Sets the value of the attribute: METHOD_NAME. The name of the method within the Windchill service.

Supported API: false

Parameters:

a_MethodName -

getSignature

public SignatureVector getSignature()

Gets the value of the attribute: SIGNATURE. Vector of process variable names matching the method signature

Supported API: false

Returns:

SignatureVector

setSignature

public void setSignature(SignatureVector a_Signature)

Sets the value of the attribute: SIGNATURE. Vector of process variable names matching the method signature

Supported API: false

Parameters:

a_Signature -

getMethodReturn

public String getMethodReturn()

Gets the value of the attribute: METHOD_RETURN. Name of the workflow process variable to hold the method return value

Supported API: false

Returns:

String

setMethodReturn

public void setMethodReturn(String a_MethodReturn)

Sets the value of the attribute: METHOD_RETURN. Name of the workflow process variable to hold the method return value

Supported API: false

Parameters:

a_MethodReturn -

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 -

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