# Uses of Class
com.orchestranetworks.workflow.ProcessInstanceKey

Packages that use ProcessInstanceKey
Package
Description
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

- ## Uses of ProcessInstanceKey in com.orchestranetworks.workflow

  Methods in com.orchestranetworks.workflow that return ProcessInstanceKey
  Modifier and Type
  Method
  Description
  `ProcessInstanceKey`
  ProcessInstance.`getParentKey()`
  Returns the parent of the sub-workflow if the process instance is a sub-workflow, otherwise returns `null`.
  `ProcessInstanceKey`
  ProcessExecutionInfoContext.`getProcessInstanceKey()`
  Returns the current process instance Key.
  `ProcessInstanceKey`
  ProcessInstance.`getProcessInstanceKey()`
  Returns the identifier of this workflow.
  `ProcessInstanceKey`
  ProcessLauncherResult.`getProcessInstanceKey()`
  Returns the key of the launched workflow instance.
  `ProcessInstanceKey`
  UserTask.WorkItem.`getProcessInstanceKey()`
  Returns the `ProcessInstanceKey` of the workflow associated to the current work item.
  `ProcessInstanceKey`
  ProcessLauncher.`launchProcess()`
  Starts a new workflow instance.
  `static ProcessInstanceKey`
  ProcessInstanceKey.`parse(String aString)`
  Parses the specified string, so as to return a process instance key.
  Methods in com.orchestranetworks.workflow that return types with arguments of type ProcessInstanceKey
  Modifier and Type
  Method
  Description
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeys(PublishedProcessKey aKey)`
  Returns a list containing all existing process instance keys for the specified publication key.
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeys(String aLaunchingPublicationName)`
  Returns a list containing all existing workflow keys for the specified launching publication name.
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeysForDataContextVariable(PublishedProcessKey publishedProcessKey, String varName, String varValue)`
  Retrieves active process instances that match a specified data context value within a given published process.
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeysForDataContextVariableIncludingHistory(PublishedProcessKey publishedProcessKey, String varName, String varValue)`
  Retrieves process instance keys for a data context variable, including search in publication history.
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeysFromHistory(PublishedProcessKey aKey)`
  Returns a list containing all the process instance keys for the specified publication key, including deleted processes.
  `List<ProcessInstanceKey>`
  WorkflowEngine.`getProcessInstanceKeysFromHistory(String aLaucnhingPublicationName)`
  Returns a list containing all existing workflow keys for the specified launching publication name, including deleted workflows.
  `List<ProcessInstanceKey>`
  ProcessInstanceStep.`getSubWorkflowsKeys()`
  Returns the list including the key of each sub-workflow created by this step or `null` if this step is not a sub-workflow invocation.
  Methods in com.orchestranetworks.workflow with parameters of type ProcessInstanceKey
  Modifier and Type
  Method
  Description
  `void`
  WorkflowEngine.`cleanHistory(ProcessInstanceKey processInstanceKey)`
  Deletes the data in history for workflows terminated for a given `ProcessInstanceKey`.
  `void`
  WorkflowEngine.`forceTerminationWithoutCleaning(ProcessInstanceKey aKey)`
  Terminates the specified process instance without deleting it.
  `ProcessInstance`
  WorkflowEngine.`getProcessInstance(ProcessInstanceKey aProcessInstanceKey)`
  Returns information about the specified workflow.
  `List<ProcessInstanceComment>`
  WorkflowEngine.`getProcessInstanceComments(ProcessInstanceKey aProcessInstanceKey)`
  Returns the comments of the specified workflow.
  `ProcessInstanceHistory`
  WorkflowEngine.`getProcessInstanceHistory(ProcessInstanceKey aProcessInstanceKey)`
  Returns the history of the specified workflow.
  `boolean`
  WorkflowEngine.`isProcessInstanceRunning(ProcessInstanceKey aKey)`
  Returns `true` if the specified process instance is running, else `false`.
  `void`
  WorkflowEngine.`replayCurrentStep(ProcessInstanceKey aKey)`
  Replays the current step of the specified workflow.
  `void`
  WorkflowEngine.`terminateProcessInstance(ProcessInstanceKey aKey)`
  Terminates and cleans the specified process instance.