wt.workflow.definer
Class WfURLRobotTemplate

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

All Implemented Interfaces:

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

public class WfURLRobotTemplate

extends WfRobotActivityTemplate

implements Externalizable

Used to define the URL to be executed. The URL, as a String, will have some level of validation performed upon it; and it may contain variable that will be expanded at runtime. The response variable will capture the URL execution results. This variable maps to a Sting variable defined in the parent process. At runtime the robot may postprocess a failed execution if RouterType is set to Manual and an expression exists. Otherwise, it will abort.dsfsdfsdfsf

Use the newWfURLRobotTemplate static factory method(s), not the WfURLRobotTemplate 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
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TASK_RESPONSE_VARIABLE Label for the attribute.
private static int	TASK_RESPONSE_VARIABLE_UPPER_LIMIT
static String	TASK_URL Label for the attribute; This String contains the URL to be executed.
private static int	TASK_URL_UPPER_LIMIT
private String	taskResponseVariable
private String	taskURL

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

WfURLRobotTemplate()

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 (persistent) node instance from the template.
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.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
String	getTaskResponseVariable() Gets the value of the attribute: TASK_RESPONSE_VARIABLE.
String	getTaskURL() Gets the value of the attribute: TASK_URL.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static WfURLRobotTemplate	newWfURLRobotTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfURLRobotTemplate	newWfURLRobotTemplate(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(WfURLRobotTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setTaskResponseVariable(String a_TaskResponseVariable) Sets the value of the attribute: TASK_RESPONSE_VARIABLE.
void	setTaskURL(String a_TaskURL) Sets the value of the attribute: TASK_URL.
private void	taskResponseVariableValidate(String a_TaskResponseVariable)
private void	taskURLValidate(String a_TaskURL)
String	toString() Returns string representation of the object.
boolean	validateURL(String url) Supported API: false
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, getContextSignature, 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

TASK_URL

public static final String TASK_URL

Label for the attribute; This String contains the URL to be executed. It 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

TASK_URL_UPPER_LIMIT

private static int TASK_URL_UPPER_LIMIT

taskURL

private String taskURL

TASK_RESPONSE_VARIABLE

public static final String TASK_RESPONSE_VARIABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TASK_RESPONSE_VARIABLE_UPPER_LIMIT

private static int TASK_RESPONSE_VARIABLE_UPPER_LIMIT

taskResponseVariable

private String taskResponseVariable

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

WfURLRobotTemplate

public WfURLRobotTemplate()

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

getTaskURL

public String getTaskURL()

Gets the value of the attribute: TASK_URL. This String contains the URL to be executed. It 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

setTaskURL

public void setTaskURL(String a_TaskURL)
                throws WTPropertyVetoException

Sets the value of the attribute: TASK_URL. This String contains the URL to be executed. It 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_TaskURL -

Throws:

WTPropertyVetoException

taskURLValidate

private void taskURLValidate(String a_TaskURL)
                      throws WTPropertyVetoException

Parameters:

a_TaskURL -

Throws:

WTPropertyVetoException

getTaskResponseVariable

public String getTaskResponseVariable()

Gets the value of the attribute: TASK_RESPONSE_VARIABLE.

Supported API: false

Returns:

String

setTaskResponseVariable

public void setTaskResponseVariable(String a_TaskResponseVariable)
                             throws WTPropertyVetoException

Sets the value of the attribute: TASK_RESPONSE_VARIABLE.

Supported API: false

Parameters:

a_TaskResponseVariable -

Throws:

WTPropertyVetoException

taskResponseVariableValidate

private void taskResponseVariableValidate(String a_TaskResponseVariable)
                                   throws WTPropertyVetoException

Parameters:

a_TaskResponseVariable -

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

getExecObjClass

public Class getExecObjClass()

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

Supported API: false

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

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

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 -

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a (persistent) node instance from the template. This method has to be implemented by all classes that implement WfNodeTemplate.

For activity templates, the pattern is the following:

 public WfNode createWfNode (WfContainer container)
          throws WTException {
     instance = .new (container);
    setAttributes (instance);
    return (WfNode) PersistenceHelper.manager.save (instance);
 }
 

where is the name of the class of the instance object. For example "WfAssignedActivity". Note that every activity type must have a constructor that that takes a WfContainer object as argument. This container is the parent container and must be passed to the super classes for initialization.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

validateURL

public boolean validateURL(String url)

Supported API: false

Parameters:

url -

Returns:

boolean

newWfURLRobotTemplate

public static WfURLRobotTemplate newWfURLRobotTemplate()
                                                throws WTException

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

Supported API: false

Returns:

WfURLRobotTemplate

Throws:

WTException

newWfURLRobotTemplate

public static WfURLRobotTemplate newWfURLRobotTemplate(WTContainerRef context_ref)
                                                throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfURLRobotTemplate

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