Class for interacting with Workflow definitions. Gets information from either a SavedWorkflow or via a POST. Contains information about how a workflow should be constructed including how it looks in the user interface when run. The components of a workflow are a time trigger, triggers, actions, and email messages
There are 2 different types of workflows: TYPE_ON_SAVE and TYPE_BY_TIME
Definition at line 44 of file Workflow.php.
static getTypeDropDownArray | ( | ) | [static] |
Definition at line 137 of file Workflow.php.
static getWorkflowSupportedModulesAndLabelsForCurrentUser | ( | ) | [static] |
Based on the current user, return the workflow supported modules and their display labels. Only include modules that the user has a right to access.
Definition at line 148 of file Workflow.php.
static getWorkflowSupportedModulesClassNamesCurrentUserHasAccessTo | ( | ) | [static] |
Definition at line 174 of file Workflow.php.
__toString | ( | ) |
Definition at line 194 of file Workflow.php.
getDescription | ( | ) |
Definition at line 206 of file Workflow.php.
setDescription | ( | $ | description | ) |
$description |
Definition at line 214 of file Workflow.php.
getIsActive | ( | ) |
Definition at line 223 of file Workflow.php.
setIsActive | ( | $ | isActive | ) |
bool | $isActive |
Definition at line 231 of file Workflow.php.
getModuleClassName | ( | ) |
Definition at line 240 of file Workflow.php.
setModuleClassName | ( | $ | moduleClassName | ) |
$moduleClassName |
Definition at line 248 of file Workflow.php.
getOrder | ( | ) |
Definition at line 257 of file Workflow.php.
setOrder | ( | $ | order | ) |
integer | $order |
Definition at line 265 of file Workflow.php.
getTriggerOn | ( | ) |
Definition at line 274 of file Workflow.php.
setTriggerOn | ( | $ | triggerOn | ) |
string | $triggerOn |
Definition at line 282 of file Workflow.php.
setTriggersStructure | ( | $ | triggersStructure | ) |
string | $triggersStructure |
Definition at line 292 of file Workflow.php.
getTriggersStructure | ( | ) |
Definition at line 301 of file Workflow.php.
getId | ( | ) |
Definition at line 309 of file Workflow.php.
setId | ( | $ | id | ) |
integer | $id |
Definition at line 317 of file Workflow.php.
getName | ( | ) |
Definition at line 326 of file Workflow.php.
setName | ( | $ | name | ) |
$name |
Definition at line 334 of file Workflow.php.
getType | ( | ) |
Definition at line 343 of file Workflow.php.
setType | ( | $ | type | ) |
$type |
Definition at line 351 of file Workflow.php.
isNew | ( | ) |
Definition at line 360 of file Workflow.php.
setTimeTriggerAttribute | ( | $ | timeTriggerAttribute | ) |
string | $timeTriggerAttribute |
Definition at line 372 of file Workflow.php.
getTimeTriggerAttribute | ( | ) |
Definition at line 381 of file Workflow.php.
getTimeTrigger | ( | ) |
Definition at line 389 of file Workflow.php.
setTimeTrigger | ( | TimeTriggerForWorkflowForm $ | timeTrigger | ) |
TimeTriggerForWorkflowForm | $timeTrigger |
Definition at line 397 of file Workflow.php.
removeTimeTrigger | ( | ) |
Resets timeTrigger to null
Definition at line 405 of file Workflow.php.
getTriggers | ( | ) |
Definition at line 413 of file Workflow.php.
addTrigger | ( | TriggerForWorkflowForm $ | trigger | ) |
TriggerForWorkflowForm | $trigger |
Definition at line 421 of file Workflow.php.
removeAllTriggers | ( | ) |
Resets triggers to an empty array
Definition at line 429 of file Workflow.php.
getActions | ( | ) |
Definition at line 437 of file Workflow.php.
addAction | ( | ActionForWorkflowForm $ | action | ) |
ActionForWorkflowForm | $action |
Definition at line 445 of file Workflow.php.
removeAllActions | ( | ) |
Resets actions to an empty array
Definition at line 453 of file Workflow.php.
getEmailMessages | ( | ) |
Definition at line 461 of file Workflow.php.
addEmailMessage | ( | EmailMessageForWorkflowForm $ | emailMessage | ) |
EmailMessageForWorkflowForm | $emailMessage |
Definition at line 469 of file Workflow.php.
removeAllEmailMessages | ( | ) |
Resets emailMessages to an empty array
Definition at line 477 of file Workflow.php.
doesTimeTriggerRequireChangeToProcess | ( | ) |
Definition at line 485 of file Workflow.php.
setTimeTriggerRequireChangeToProcessToFalse | ( | ) |
When processing ByTime workflow in
Definition at line 494 of file Workflow.php.