Package wt.workflow.definer

Provides workflow classes responsible for the definition of processes, activities, and the other objects that compose the workflow network.

See:
          Description

Interface Summary
WfDefinerService The WfDefinerService is an interface containing the methods used both in the client and server to define workflow definitions.
WfDefinitionDelegate Defines methods that can be called from the WfDefinitionHandler.
WfNodeTemplate WfNodeTemplate is an interface representing obejcts that can play a role of a node in a workflow.
WfProcessDefinition

Supported API: false

Extendable: false
 

Class Summary
DataFlowDefect Simples class representing a data flow defect.
DataFlowDefectType Enumeration of possible data flow defect types.
EventActionTable Encapsulates event-action mapping of workflow links.
EventDefect Defect that corresponds to a user defined event that is not used.
LoadWorkflow Load workflows into the Windchill database.
LoadWorkflow.Queue  
MasterIteration Use the newMasterIteration static factory method(s), not the MasterIteration constructor, to construct instances of this class.
NodeTemplateLink The NodeTemplateLink is the class responsible for the definition of links representing flow of control.
ParameterTable Externalizable specialization of java.util.Hashtabler for holding parameter list (names and their types).
PermissionSet PermissionSet class stores a set of permissions.
PrincipalRefVector Holds a list of WfPrincipalAssignee objects.
ProcessDataInfo The ProcessDataInfo class provides information about the structure of ProcessData sets for the generated execution objects.
ProcessStepTemplateLink ProcessStepDefLink associates the process template with with constituent objects (activity and connector templates).
ProjectRefVector

Supported API: false

Extendable: false
ProxyProcessDefinitionLink Use the newProxyProcessDefinitionLink static factory method(s), not the ProxyProcessDefinitionLink constructor, to construct instances of this class.
RoleVector Container of roles assignees.
SignatureVector Externalizable specialization of java.util.Vector for holding robot method signature.
StandardWfDefinerService Standard implementation of the definer service.
TeamRefVector Holds a list of WfTeamAssignee objects.
TimeToElapse Models elapsed time in workflows.
UserEventVector Contains list of events defined for the workflow node.
VariableDefect Defect that corresponds to an INPUT variable that is not the destination of a mapping or an OUTPUT variable that is not the source of a mapping.
VariableNamePair Simple class representing a pair of variable names.
VariableRefVector

Supported API: false

Extendable: false
WfAdHocActivityTemplate Use the newWfAdHocActivityTemplate static factory method(s), not the WfAdHocActivityTemplate constructor, to construct instances of this class.
WfAdministratorProcessor The WfAdministratorProcessor creates an html page for the Calendar.
WfApplRobotTemplate Template for application robots, that is, activities that correspond to programs or applications.
WfAssignedActivityTemplate Template for creation of assigned activities.
WfBlockTemplate Class that represents a workflow block.
WfConnectorTemplate WfConnectorTemplate class serves as a template for WfConnector objects.
WfContainerTemplate Abstract class that models template objects that can contain other template objects.
WfContainerTemplateReference Reference to a container template object.
WfDefinerHelper Helper class containing variable that provides access to WfDefinerService functionality.
WfDefinerServiceEvent

Supported API: false

Extendable: false
WfDefinerServiceFwd The WfDefinerService is an interface containing the methods used both in the client and server to define workflow definitions.
WfDefinitionDefaultDelegate Defines the default behavior for all methods that can be called from the WfDefinitionHandler.
WfDefinitionDelegateFactory WfDefinitionDelegateFactor creates instances of classes that implement the WfDefinitionDelegate interface.
WfDefinitionHandler Handle the Definition of a Workflow Template.
WfDestination Enumeration of possible INPUT/OUTPUT roles a variable can play.
WfExportImportHandler Handle the Import and Export of a Wf Process Template.
WfExpression The WfExpression class represents expressions that are associated to some workflow node objects.
WfExpressionLoader Loader used to load classes associated with the workflow expressions.
WfExprRobotTemplate Use the newWfExprRobotTemplate static factory method(s), not the WfExprRobotTemplate constructor, to construct instances of this class.
WfExternalMethodTemplate Template for robot activities which are based on externally callable methods.
WfInternalMethodTemplate Template for robot activities which are based on internally callable methods.
WfInvokedMethodTemplate Template for creation of method robot activities.
WfNodeTemplateReference Use the newWfNodeTemplateReference static factory method(s), not the WfNodeTemplateReference constructor, to construct instances of this class.
WfProcessTemplate A WfProcessTemplate represents a template for a specific workflow process; it is used to create instances of a workflow process.
WfProcessTemplateCache This class implements cache service to store all iterations of a WfProcess template.
WfProcessTemplateIdentity Encapsulates process template identity information.
WfProcessTemplateKey Class that stores unique process template idenitities.
WfProcessTemplateMaster Use the newWfProcessTemplateMaster static factory method(s), not the WfProcessTemplateMaster constructor, to construct instances of this class.
WfProcessTemplateMasterIdentity Use the newWfProcessTemplateMasterIdentity static factory method(s), not the WfProcessTemplateMasterIdentity constructor, to construct instances of this class.
WfProcessTemplateMasterReference Use the newWfProcessTemplateMasterReference static factory method(s), not the WfProcessTemplateMasterReference constructor, to construct instances of this class.
WfProcessTemplateReference Reference to a process template object.
WfProxyTemplate Object that points to a template.
WfProxyType Enumeration of the possible proxy types in case a proxy references a revision controlled template.
WfRobotActivityTemplate Base template class for for classes that create robot activities.
WfSynchRobotTemplate Use the newWfSynchRobotTemplate static factory method(s), not the WfSynchRobotTemplate constructor, to construct instances of this class.
WfTemplateCategory Template category.
WfTemplateLinkType Enumerates the possible types of links.
WfTemplateObject WfTemplateObject is the base class for the workflow definition objects.
WfTemplateObjectReference Reference to a template object.
WfTemplateObjectType Enumeration of possible template object types.
WfTemplateVerification Class that encapsulates the verification of a container template.
WfTimerTemplate Use the newWfTimerTemplate static factory method(s), not the WfTimerTemplate constructor, to construct instances of this class.
WfURLRobotTemplate Used to define the URL to be executed.
WfVariableInfo Simple structure containing information pertaining to a execution object variable.
WfVariableMap Class that represents the mapping between process and step variables.
 

Exception Summary
BlockTransformationException

Supported API: false

Extendable: false
ExpressionAlreadyExistsException Exception thrown when one tries to create an expression associated with given template object/transition or with a connditional router template.
InvalidActionException Exception thrown when an attempt is made to use an object that doesn't belong to the set of actions allowed in a certain context.
InvalidDestinationException Exception thrown when an attempt is made to use a variable in a variable mapping that contradicts its destination type.
InvalidEventException Exception thrown when an attempt is made to use an object that doesn't belong to the set of events allowed in a certain context.
InvalidProxyException Exception thrown when a proxy is determined invalid.
InvalidSourceException Exception thrown when one tries to make a router the destination of a link when the source is not an activity.
InvalidTypeException

Supported API: false

Extendable: false
InvalidVariableInfoException Exception thrown when an attempt is made to use an invalid or incompletely specified (more likely) variable.
MultipleTargetException Exception thrown when a destination variable is target of two different variables in a variable mapping.
NotEnabledException Thrown when an attempt is made to create a WfProcess using a WfProcessTemplate that is disabled.
 

Package wt.workflow.definer Description

Provides workflow classes responsible for the definition of processes, activities, and the other objects that compose the workflow network.

The Workflow Definer Package

The base class for the workflow template objects is the WfTemplateObject class.  It contains identification attributes and meta information about the data manipulated by the execution object. Its subclasses — WfProcessTemplate, WfRobotActivityTemplate, WfAssignedActivityTemplate, WfAdhocActivityTemplate, and WfProxyTemplate — are templates (factories) used to generate WfProcess, WfRobotActivity, WfAssignedActivity, WfAdhocActivity, and WfProcessReference objects, respectively.

Also shown in the following figure is the relationship of WfProcessTemplate and other template objects. A process template contains zero or more templates (activity or process templates).

WfRequester objects have no template. They are generated dynamically when the WfProcess is created, based on information contained in the processes involved.  The mapping between local and global variables does not belong to the activity definition. It is part of the relationship between a process and a step. They become part of the activity execution object when it is instantiated. In this way, an activity template can be reused independently of the process in which it will be used. 

Workflow Definer package Diagram