Package wt.workflow.definer

Class LoadWorkflow

java.lang.Object

wt.workflow.definer.LoadWorkflow

public class LoadWorkflow
extends Object

Load workflows into the Windchill database. Methods in this class are defined for use by the load package inside of the map file ($wt.home/loadFiles/csvmapfile.txt). These methods were written to be called by the load package using introspection not by a user interface.

Supported API: true

Extendable: false

Since:

R2

Method Summary

Modifier and Type	Method	Description
static boolean	addActorAssignee(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an actor role assignee to the current WfAssignedActivityTemplate (or WfAdHocActivityTemplate) or WfInternalMethodTemplate
static boolean	addAuditAction(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an audit action to the current WfTemplateObject
static boolean	addCreateTaskForRequiredRoleAction(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an ignoreRequiredUnresolvedRole action to the current WfTemplateObject
static boolean	addEventActionPair(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an event/action pair to the current NodeTemplateLink
static boolean	addExpression(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an expression to the current WfTemplateObject
static boolean	addIgnoreUnresolvedRoleAction(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an ignoreunresolvedrole action to the current WfTemplateObject
static boolean	addVariable(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add a variable to the current WfTemplateObject
static boolean	addVotingAction(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Add an voting action to the current WfTemplateObject
static boolean	createAssignedActivityTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Create an uninitialized WfAssignedActivityTemplate.
static boolean	createConnectorTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Create a WfConnectorTemplate.
static boolean	createExprRobotTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Create an uninitialized WfExprRobotTemplate.
static boolean	createNodeTemplateLink(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Create a NodeTemplateLink between two WfNodeTemplate objects.
static boolean	createProcessTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Create an uninitialized WfProcessTemplate.
static boolean	renderTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Set the render as choice to HTML or PDF in Assigned Activity Template
static boolean	saveAssignedActivityTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	End the definition of the current WfAssignedActivityTemplate.
static boolean	saveExprRobotTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	End the definition of the current WfExprRobotTemplate.
static boolean	saveNodeTemplateLink(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	End the definition of the current NodeTemplateLink.
static boolean	saveProcessTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	End the definition of the current WfProcessTemplate.
static boolean	saveProcessTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects, WTContainerRef container)	End the definition of the current WfProcessTemplate.
static boolean	saveTaskFormTemplate(Hashtable attributes, Hashtable cmdLineArgs, Vector returnObjects)	Set the name of TaskFormTemplate in Assigned Activity Template

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createProcessTemplate

public static boolean createProcessTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                     throws WTException

Create an uninitialized WfProcessTemplate. The template is stored in the LoadService cache and later persisted by a call to saveProcessTemplate. The WfProcessTemplateEditor class is re-used from the workflow definer client to aid in creating WfProcessTemplates. It provides some default initialiazation and contains BatchContainer support.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.WfProcessTemplateEditor

saveProcessTemplate

public static boolean saveProcessTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                   throws WTException

End the definition of the current WfProcessTemplate.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Throws:

WTException

See Also:

• TransactionContainer
• BatchContainer
• 

Supported API: true

saveProcessTemplate

public static boolean saveProcessTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects,
 WTContainerRef container)
                                   throws WTException

End the definition of the current WfProcessTemplate.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by

container - the context in which to save this template wt.load.StandardLoadService for user feedback messages.

Throws:

WTException

See Also:

• TransactionContainer
• BatchContainer
• 

Supported API: true

createAssignedActivityTemplate

public static boolean createAssignedActivityTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                              throws WTException

Create an uninitialized WfAssignedActivityTemplate. The activity template is stored in the LoadService cache and later persisted as part of a call to saveProcessTemplate which persists the parent process template. The WfAssignedActivityTemplateEditor class is re-used from the workflow definer client to aid in creating WfAssignedActivityTemplates. It provides some default initialiazation and contains BatchContainer support.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.WfAssignedActivityTemplateEditor

saveAssignedActivityTemplate

public static boolean saveAssignedActivityTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                            throws WTException

End the definition of the current WfAssignedActivityTemplate.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

createExprRobotTemplate

public static boolean createExprRobotTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                       throws WTException

Create an uninitialized WfExprRobotTemplate. The internal method template is stored in the LoadService cache and later persisted as part of a call to saveProcessTemplate which persists the parent process template. The WfExprRobotTemplateEditor class is re-used from the workflow definer client to aid in creating WfExprRobotTemplates. It provides some default initialiazation and contains BatchContainer support.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.WfExprRobotTemplateEditor

saveExprRobotTemplate

public static boolean saveExprRobotTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                     throws WTException

End the definition of the current WfExprRobotTemplate.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

createNodeTemplateLink

public static boolean createNodeTemplateLink(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                      throws WTException

Create a NodeTemplateLink between two WfNodeTemplate objects. The NodeTemplateLinkEditor class is re-used from the workflow definer client to aid in creating NodeTemplateLinks.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.NodeTemplateLinkEditor

createConnectorTemplate

public static boolean createConnectorTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                       throws WTException

Create a WfConnectorTemplate. The connector template is stored in the LoadService cache and later persisted as part of a call to saveProcessTemplate which persists the parent process template. The WfConnectorTemplateEditor class is re-used from the workflow definer client to aid in creating WfConnectorTemplates. It provides some default initialiazation and contains BatchContainer support.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.WfConnectorTemplateEditor

saveNodeTemplateLink

public static boolean saveNodeTemplateLink(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                    throws WTException

End the definition of the current NodeTemplateLink.

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

See Also:

• wt.clients.workflow.definer.NodeTemplateLinkEditor

addEventActionPair

public static boolean addEventActionPair(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                  throws WTException

Add an event/action pair to the current NodeTemplateLink

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

addActorAssignee

public static boolean addActorAssignee(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                throws WTException

Add an actor role assignee to the current WfAssignedActivityTemplate (or WfAdHocActivityTemplate) or WfInternalMethodTemplate

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

addVariable

public static boolean addVariable(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                           throws WTException

Add a variable to the current WfTemplateObject

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

addExpression

public static boolean addExpression(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                             throws WTException

Add an expression to the current WfTemplateObject

Parameters:

attributes - name/value pairs of attributes

cmdLineArgs - command line arguments that can be substituted into the load data.

returnObjects - object(s) created by this method used by wt.load.StandardLoadService for user feedback messages.

Supported API: true

Throws:

WTException

addAuditAction

public static boolean addAuditAction(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                              throws WTException

Add an audit action to the current WfTemplateObject

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

boolean

Throws:

WTException -

Supported API: true

addVotingAction

public static boolean addVotingAction(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                               throws WTException

Add an voting action to the current WfTemplateObject

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

boolean

Throws:

WTException -

Supported API: true

addIgnoreUnresolvedRoleAction

public static boolean addIgnoreUnresolvedRoleAction(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                             throws WTException

Add an ignoreunresolvedrole action to the current WfTemplateObject

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

Throws:

WTException -

Supported API: true

addCreateTaskForRequiredRoleAction

public static boolean addCreateTaskForRequiredRoleAction(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                                  throws WTException

Add an ignoreRequiredUnresolvedRole action to the current WfTemplateObject

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

Throws:

WTException -

Supported API: true

renderTemplate

public static boolean renderTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                              throws WTException

Set the render as choice to HTML or PDF in Assigned Activity Template

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

Throws:

WTException -

Supported API: true

saveTaskFormTemplate

public static boolean saveTaskFormTemplate(Hashtable attributes,
 Hashtable cmdLineArgs,
 Vector returnObjects)
                                    throws WTPropertyVetoException,
WTException

Set the name of TaskFormTemplate in Assigned Activity Template

Parameters:

attributes -

cmdLineArgs -

returnObjects -

Returns:

Throws:

WTPropertyVetoException

WTException