WorkflowContext (Policy Manager Scripting API)

```
public interface WorkflowContext
```
Provides context information in a workflow scripted environment. The context of a workflow script contains information about the workflow being executed as well as the dynamic information developed during workflow execution such as the current variable set of the running workflow, and the user who triggered the workflow action that is calling the script.
You can get information about the object whose workflow is executing the script as follows:
```
    systemLog.debug("object type is " + workflowContext.getObjectType());
    systemLog.debug("object key is " + workflowContext.getObjectKey());
 
```
You can get the key of the workflow definition that contains the script being called as follows:
```
    systemLog.debug("workflow definition key is " + workflowContext.getWorkflowDefinitionKey());
 
```
You can find out information about the user who invoked the workflow action that called a script as follows:
```
    caller = workflowContext.getCallerSubject();
    systemLog.debug("workflow caller is " + caller.getInputName());
 
```
Note that this exact method (caller.getInputName()) may not work in Community Manager workflows that do not use derivatives of the com.soa.auth.credential.NameCredential
Several classes of variables can be accessed through the WorkflowContext. Any extra <arg> elements specified with the runScript function can be accessed as follows:
```
    systemLog.debug("runScript arg [myArg} is [" + workflowContext.getScriptArg("myArg"));
 
```
When the runScript function is included in the <common-functions>, then the <arg> elements specified with the <functions type="common" name="..." common function invocation can be accessed as follows: a script as follows:
```
    systemLog.debug("common function call arg [myArg} is [" + workflowContext.getFunctionArg("myArg"));
 
```
Finally, the standard workflow variables such as ${service.key}can be access as follows:
```
    systemLog.debug("service key is [" + workflowContext.getVariable("service.key"));
 
```
Note that the surrounding ${} is optional. "service.key" and "${service.key}" are equivalent.
You can also set workflow variables that can be accessed by other functions and conditions in the current workflow action as follows:
```
    workflowContext.setVariable("currentDate", new Date().toISOString()));
 
```
Again the surrounding ${} for the variable name is optional. Also be careful to not include a period in the variable name since this has special meaning to workflow that is not meaningful when setting variables.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Subject`	`getCallerSubject()` Returns the `Subject` of the user who invoked the current workflow action.
`java.lang.String`	`getFunctionArg(java.lang.String name)` Returns the value of one of the `<arg>` elements configured for the `<function>` element that called this runScript function that was defined using a `<common-function>` element,
`java.lang.String`	`getObjectKey()` Returns the key of the object being processed by the workflow.
`java.lang.String`	`getObjectType()` Returns the type of object this workflow is processing.
`java.lang.String`	`getScriptArg(java.lang.String name)` Returns the value of one of the `<arg>` elements configured for the runScript `<function>` element.
`java.lang.String`	`getVariable(java.lang.String name)` Returns the value of a workflow variable that is located using the standard OS Workflow variable resolution process.
`java.lang.String`	`getWorkflowDefinitionKey()` Returns the key of the Workflow Definition being executed.
`java.lang.String`	`setVariable(java.lang.String name, java.lang.String value)` Sets the value of a workflow variable.

- Method Detail
  - getWorkflowDefinitionKey
```
java.lang.String getWorkflowDefinitionKey()
```
    Returns the key of the Workflow Definition being executed. For Policy Manager, this is the internally configured key assigned to the Workflow XML definition loaded from the Policy Manager Console. For Community Manager, this is the key value assigned by the administrator when the Workflow XML document was loaded from the CM Portal.
    
    Returns:
    
    the String workflow definition key.
  - getObjectKey
```
java.lang.String getObjectKey()
```
    Returns the key of the object being processed by the workflow. For Policy Manager objects, this will be either the key of the Service, Contract, or Policy. For Community Manager, this will be the FDN value of the object processing the workflow (e.g. API Version)
    
    Returns:
    
    the String representation of the workflow object's unique key
  - getObjectType
```
java.lang.String getObjectType()
```
    Returns the type of object this workflow is processing. This is derived from the Java class name of the key of the object being processed by the workflow instance.
    
    Returns:
    
    the String with the type of the object being processed (e.g. 'service', 'contract', or 'policy'
  - getScriptArg
```
java.lang.String getScriptArg(java.lang.String name)
```
    Returns the value of one of the <arg> elements configured for the runScript <function> element.
    
    Parameters:
    
    name - the case-sensitive name of the <arg> value to retrieve.
    
    Returns:
    
    the String value of the script argument or null if it is not defined
  - getFunctionArg
```
java.lang.String getFunctionArg(java.lang.String name)
```
    Returns the value of one of the <arg> elements configured for the <function> element that called this runScript function that was defined using a <common-function> element,
    
    Parameters:
    
    name - the case-sensitive name of the <arg> value to retrieve.
    
    Returns:
    
    the String value of the script argument or null if it is not defined
  - getVariable
```
java.lang.String getVariable(java.lang.String name)
```
    Returns the value of a workflow variable that is located using the standard OS Workflow variable resolution process.
    
    Parameters:
    
    name - is the name of the workflow variable to be retrieved. The name can optionally be in the form of ${name}.
    
    Returns:
    
    the String value of the workflow variable or null if it is not defined
  - setVariable
```
java.lang.String setVariable(java.lang.String name,
                             java.lang.String value)
```
    Sets the value of a workflow variable. The resulting variable can be referenced in other places during the workflow's current state transition.
    
    Parameters:
    
    name - is the name of the workflow variable to be retrieved. The name can optionally be in the form of ${name}. Do not include periods in the variable name.
    
    value - is the value to be assigned to the workflow variable.
    
    Returns:
    
    the String equivalent of the value that was previously assigned to the workflow variable
  - getCallerSubject
```
Subject getCallerSubject()
```
    Returns the Subject of the user who invoked the current workflow action.
    
    Returns:
    
    Subject of the user who triggered the workflow action

This software is the confidential and proprietary information of Perforce, Inc. and is subject to copyright protection under laws of the United States of America and other countries. The use of this software should be in accordance with the license agreement terms you entered into with Perforce, Inc.

Interface WorkflowContext

Method Summary

Method Detail

getWorkflowDefinitionKey

getObjectKey

getObjectType

getScriptArg

getFunctionArg

getVariable

setVariable

getCallerSubject