ProcessServiceSession (Oracle BPM Process API)

Overview

Package

Class

Tree

Deprecated

Index

Help

BPM Process API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

fuego.papi
Interface ProcessServiceSession

All Superinterfaces:: Serializable

All Known Subinterfaces:: ProcessServiceAdminSession

public interface ProcessServiceSession
extends Serializable
extends Serializable

ProcessServiceSession contains methods for creating, storing and managing views and presentations, for getting activities, attachments, instances, notes, and processes, for adding attachments and notes, and for processing activities and instances.

Example:

        // Creates the ProcessService.
        ProcessService processService = ProcessService.create(...);

        // Creates the passport which will connect the user.
        ConnectionPassport passport = processService.createPassport("userId);

        // Sets the password of the user.
        passport.setPassword("userPassport");

        // Fills the passport.
        passport.fillPassport();

        // Creates a new session with the passport and the user's host.
        ProcessServiceSession session = processService.createSession(passport, "userHost");

Field Summary
`static long`	`serialCheck`
`static long`	`serialVersionUID`

Method Summary
`void`	`abortActivity(String instanceId, String activityName, int taskIn)` Deprecated. use `activityAbort(String, int, String)` instead
`void`	`activityAbort(Activity activity, InstanceId instanceId)` Deprecated. use `activityAbort(Activity, InstanceInfo)`
`void`	`activityAbort(Activity activity, InstanceInfo instance)` Locates instance in activity and aborts the main task.
`void`	`activityAbort(Activity activity, int taskIn, InstanceId instanceId)` Deprecated. use `activityAbort(Activity, int, InstanceInfo)`
`void`	`activityAbort(Activity activity, int taskIn, InstanceInfo instance)` Locates instance in activity and aborts the running task identified by taskIn.
`void`	`activityAbort(String activityName, int taskIn, String instanceId)` Locates instance identified by instanceId in activity activityName and aborts the running task identified by taskIn.
`void`	`activityAbort(String activityName, String instanceId)` Locates instance identified by instanceId in activity activityName and aborts the main task.
`InstanceInfo`	`activityCommit(Activity activity, InstanceInfo instance, Arguments args)` Executes the commit method of an external activity using the specified activit and the instance.
`InstanceInfo`	`activityCommit(String activityName, String instanceId, Arguments args)` Executes the commit method of an external activity using the specified activit name and the instance id.
`InstanceInfo`	`activityExecute(Activity activity, InstanceInfo instance, Arguments args)` Executes the main task for the instance given an instanceStampId.
`InstanceInfo`	`activityExecute(Activity activity, InstanceInfo instance, int taskToExecute, Arguments args)` Executes the specified task for this instance given an activity, instance identification and a task identification number.
`InstanceInfo`	`activityExecute(Activity activity, InstanceInfo instance, Task taskToExecute, Arguments args)` Executes the specified task for this instance given an activity, instance identification and a task identification number.
`InstanceInfo`	`activityExecute(String activityName, String instanceId, Arguments args)` Executes the main task for the instance given an instanceStampId.
`InstanceInfo`	`activityExecute(String activityName, String instanceId, int taskToExecute, Arguments args)` Executes the specified task for this instance given an activity, instance identification and a task identification number.
`InstanceInfo`	`activityExecuteApplication(Activity activity)` Runs the specified Global Activity with no arguments.
`InstanceInfo`	`activityExecuteApplication(Activity activity, Arguments arguments)` Runs the specified Global Activity with the specified arguments The global activity cannot interact with a user; if user interaction is required, use `activityExecuteApplication(String, String, Arguments)`.
`InstanceInfo`	`activityExecuteApplication(String activityName, String processId)` Runs the specified Global Activity with no arguments.
`InstanceInfo`	`activityExecuteApplication(String activityName, String processId, Arguments arguments)` Runs the specified Global Activity with the specified arguments The global activity cannot interact with a user; if user interaction is required, use `activityExecuteApplication(String, String, Arguments)`.
`String`	`activityGetDocumentation(Activity activity, Locale locale)` Gets the full path to the localized documentation for the specified activityId and Locale.
`String`	`activityGetDocumentation(String activityName, String processId, Locale locale)` Returns the local path of the HTML documentation for the given activity. The activity documentation is retrieved from the engine and stored in the path indicated, along with the images used by the documentation. The HTML file is always stored using UTF-8 encoding.
`InstanceInfoList`	`activityGetGrabbableInstances(Activity activity)` Returns all the instances that can be grabbed from the activity specified by the activity.
`InstanceInfoList`	`activityGetGrabbableInstances(String activityName, String processId)` Returns all the instances that can be grabbed from the activity specified by the activity name and the process id.
`TaskExecution`	`activityPost(Activity activity, InstanceInfo instance, Arguments args)` Executes the main task for this instance using an instanceId and activityId. Allows a PAPI client to customize client-side invocations.
`TaskExecution`	`activityPost(Activity activity, InstanceInfo instance, int taskToExecute, Arguments args)` Executes the activity task number over the instance.
`TaskExecution`	`activityPost(String activityName, String instanceId, Arguments args)` Executes the main task for this instance using an instanceId and activityId. Allows a PAPI client to customize client-side invocations.
`TaskExecution`	`activityPost(String activityName, String instanceId, int taskToExecute, Arguments args)` Executes the task for this instance using an instanceId, activityId, and task identification number. Allows a PAPI client to customize client-side invocations.
`GlobalExecution`	`activityPostApplication(Activity activity, Arguments arguments)` Runs a global activity and returns a GlobalExecution to complete the activity. activityPostApplication can have user interaction, whereas runGlobalActivity cannot.
`GlobalExecution`	`activityPostApplication(String activityName, String processId, Arguments arguments)` Runs a global activity and returns a GlobalExecution to complete the activity. activityPostApplication can have user interaction, whereas runGlobalActivity cannot.
`Arguments`	`activityPrepare(Activity activity, InstanceInfo instance, Arguments args)` Executes the prepare method for the main task of the activity given an instanceId and an activityId.
`Arguments`	`activityPrepare(String activityName, String instanceId, Arguments args)` Executes the prepare method for the main task of the activity given an instanceId and an activityId.
`void`	`addBookmarks(InstanceStamp[] instancesStamp)` Deprecated. use `instancesAddBookmark(InstanceActivityPairSet)` instead
`void`	`addHistories(InstanceStamp[] instancesStamp)` Deprecated.
`void`	`attachmentCheckIn(Attachment attachment, String remarks, File file)` Checks in an attachment. If successful, this will always generate a new attachment version.
`void`	`attachmentCheckIn(String attachmentId, String remarks, File file)` Checks in an attachment. If successful, this will always generate a new attachment version.
`void`	`attachmentCheckOut(Attachment attachment, String folder)` Writes the attachment to the specified folder. To check out the attachment, first call attachmentEdit(Attachment).
`void`	`attachmentCheckOutToStream(Attachment attachment, OutputStream stream)` Writes the attachment to the specified output stream. To check out the attachment, first call attachmentEdit(Attachment).
`void`	`attachmentCheckOutToStream(String attachmentId, OutputStream stream)` Writes the attachment to the specified output stream.
`void`	`attachmentEdit(Attachment attachment)` Obtains a version lock for the attachment.
`void`	`attachmentEdit(String attachmentId)` Obtains a version lock for the attachment.
`Attachment`	`attachmentGet(String attachmentId)` Gets the Attachment for this attachmentId.
`AttachmentList`	`attachmentGetAllVersions(String attachmentId)` Gets all the Attachments associated with this attachment.
`Attachment`	`attachmentGetLastVersion(String attachmentId)` Gets the last version of the Attachment specified by attachmentId.
`void`	`attachmentRelease(Attachment attachment)` Releases the version lock for the attachment.
`void`	`attachmentRelease(Attachment attachment, File file)` Releases the version lock for the attachment and deletes the specified file.
`void`	`attachmentRelease(String attachmentId)` Releases the version lock for the attachment.
`void`	`checkInAttachment(Attachment attachment, String remarks, File file)` Deprecated. use `attachmentCheckIn(Attachment, String, File)` instead
`void`	`checkOutAttachment(Attachment attachment, String directory)` Deprecated. use `attachmentCheckOut(Attachment, String)` instead
`void`	`checkOutAttachmentToStream(Attachment attachment, OutputStream stream)` Deprecated. use `attachmentCheckOutToStream(Attachment, OutputStream)` instead
`void`	`close()` Closes the session. For reuse this session you need recreate it.
`InstanceInfo`	`commitExternalActivity(String instanceStampId, int taskIn, Arguments args)` Deprecated. use `activityCommit(String, String, Arguments)` instead
`InstanceInfo`	`commitExternalActivity(String instanceId, String activityName, Arguments args)` Deprecated. use `activityCommit(String, String, Arguments)` instead
`InstanceInfo`	`commitExternalActivity(String instanceId, String activityName, int taskIn, Arguments args)` Deprecated. use `activityCommit(String, String, Arguments)` instead.
`Presentation`	`createPresentation(PresentationType presentationType, String id, Presentation.Column[] columns)` Deprecated. use `presentationCreate(PresentationType, String, Presentation.Column[])` instead
`InstanceInfo`	`createProcessInstance(String targetProcessId, Arguments arguments)` Deprecated. use `processCreateInstance(String, Arguments)` instead
`InstanceInfo`	`createProcessInstance(String targetProcessId, String argumentsSetName, Arguments arguments)` Deprecated. use `processCreateInstance(String, String, Arguments)` instead
`EditableView`	`createView(ViewType viewType, String viewId, String[] assignedProcesses)` Deprecated. use `viewCreate(ViewType, String, String[])` instead
`TaskExecution`	`customRunActivity(String instanceId, String activityName, Arguments args)` Deprecated. use `activityPost(String, String, Arguments)` instead
`TaskExecution`	`customRunActivity(String instanceId, String activityName, int taskIn, Arguments args)` Deprecated. use `activityPost(String, String, int, Arguments)` instead
`TaskExecution`	`customRunGlobal(String instanceId, String activityName, Arguments args)` Deprecated. use `activityPost(String, String, Arguments)` instead
`GlobalExecution`	`customRunGlobalActivity(String activityId, Arguments arguments)` Deprecated. use `activityPostApplication(String, String, Arguments)` instead
`TaskExecution`	`customRunTask(String instanceStampId, int taskIn, Arguments args)` Deprecated. use `activityPost(String, String, int, Arguments)` instead.
`String`	`getActiveProcessId(String process)` Deprecated. use `processGetActiveVersion(String)` instead
`String[]`	`getActiveProcessIdsByView(View view)` Deprecated. use `View.getAssignedProcesses()` and then use `processGetActiveVersion(String)` over each process in the array.
`String`	`getActivityDocumentation(String activityId, Locale locale)` Deprecated. use `activityGetDocumentation(Activity, Locale)` instead
`Activity`	`getActivityForView(ActivityView view)` Deprecated. The ActivityScope is deprecated
`String[]`	`getAllProcessVersions(String process)` Deprecated. use `processGetAllVersions(String)` instead
`String[]`	`getAllProcessVersions(String[] processes)` Deprecated. use `processesGetAllVersions(fuego.papi.collections.ProcessIdSet)` instead
`Activity[]`	`getApplicationsByView(ApplicationsView view)` Deprecated. use `viewGetApplications(ApplicationsView)` instead
`Attachment`	`getAttachment(String attachmentId)` Deprecated. use `attachmentGet(String)` instead
`Attachment`	`getAttachmentLastVersion(String attachmentId)` Deprecated. use `attachmentGetLastVersion(String)` instead
`Attachment[]`	`getAttachmentsByInstance(String instanceId)` Deprecated. use `instanceGetAttachments(String)` instead
`Attachment[]`	`getAttachmentsByView(AttachmentsView view)` Deprecated. use `viewGetAttachments(AttachmentsView)` instead
`Attachment[]`	`getAttachmentVersions(String attachmentId)` Deprecated. use `attachmentGetAllVersions(String)` instead
`String[]`	`getBookmarks()` Deprecated. use `instancesGetBookmarks()` instead
`Calendar`	`getCalendar()` Deprecated. use `participantCalendar()` instead
`Map`	`getChildrenViews(String viewId)` Deprecated. use `viewGetChildren(String)` instead
`Consult`	`getConsult(String instanceId)` Deprecated. use `instanceGetLastConsult(InstanceInfo)` instead
`String[]`	`getConsults()` Deprecated. use `instancesGetConsults()` instead
`Presentation`	`getDefaultPresentation(PresentationType presentationType)` Deprecated. use `presentationGetDefault(PresentationType)` instead
`Presentation`	`getDefaultPresentation(ViewType viewType)` Deprecated. use `presentationGetDefault(ViewType)` instead
`List`	`getDelegateParticipants(InstanceStamp instance)` Deprecated. use `instanceGetParticipants(String, String, ParticipantFor)` instead. [instanceGetParticipants("/OU/ProcessName#Default-1.0/1/0", "MyActivity", ParticipantFor.DELEGATE)]
`EditableView`	`getEditableView(View view)` Deprecated. use `viewEdit(View)` instead
`List`	`getEscalateParticipants(InstanceStamp instance)` Deprecated. use `instanceGetParticipants(String, String, ParticipantFor)` instead. [instanceGetParticipants("/OU/ProcessName#Default-1.0/1/0", "MyActivity", ParticipantFor.ESCALATE)]
`Activity[]`	`getGlobalActivities(Process[] processes)` Deprecated. use `processesGetGlobalActivities(ProcessIdSet)` instead
`Activity[]`	`getGlobalActivities(Process[] processes, int taskType, boolean hasInstanceAccess)` Deprecated. `processesGetGlobalActivities(ProcessIdSet, int, boolean)` instead
`Activity[]`	`getGlobalActivities(String[] processIds)` Deprecated. use `processesGetGlobalActivities(fuego.papi.collections.ProcessIdSet)` instead.
`Activity[]`	`getGlobalActivities(String[] processIds, int activityType, boolean hasInstanceAccess)` Deprecated. use `processesGetGlobalActivities(ProcessIdSet, int, boolean)` instead.
`Activity[]`	`getGrabActivitiesForInstance(InstanceInfo instance)` Deprecated. use `instanceGrabbableFrom(InstanceInfo)` instead
`InstanceInfo[]`	`getGrabbableInstances(String activityId)` Deprecated. `activityGetGrabbableInstances(String, String)` instead.
`String`	`getHost()` Deprecated. use `participantHost()` instead
`String`	`getId()` Returns the session identification assigned to this session or null if this session does not have identification.
`InstanceInfo`	`getInstance(InstanceStamp stamp)` Deprecated. use `processGetInstance(String, String)` instead
`InstanceInfo`	`getInstance(String instanceId)` Deprecated. use `processGetInstance(String)` instead
`InstanceInfo`	`getInstanceByCorrelation(String processId, String correlationName, Object[] correlationValues)` Deprecated. use `processGetInstanceByCorrelation(String, String, Object[])` instead
`DynamicObject`	`getInstanceData(String instanceId)` Deprecated. use `instanceGetData(String)` instead
`InstanceEvent[]`	`getInstanceEvents(String instanceId)` Deprecated. use `instanceGetEvents(String)` instead
`Note[]`	`getInstanceNotes(String instanceId)` Deprecated. use `instanceGetNotes(String)` instead
`InstanceInfo[]`	`getInstances(String processId)` Deprecated. use `processGetInstances(String)` instead
`InstanceInfo[]`	`getInstancesByFilter(String[] processIds, Filter filter)` Deprecated. use `processesGetInstancesByFilter(fuego.papi.collections.ProcessIdSet, Filter)` instead
`InstanceInfo[]`	`getInstancesByView(InstancesView view)` Deprecated. use `viewGetInstances(InstancesView)` instead
`Locale`	`getLocale()` Deprecated. use `participantLocale()` instead
`Note`	`getNote(String noteId)` Deprecated. use `noteGet(String)` instead
`String`	`getOrganization()` Deprecated. use `organization()` instead
`View`	`getParentView(View view)` Deprecated. use `viewGetParent(String)` instead
`String`	`getParentViewId(String viewId)` Deprecated. use `View.getParentId()` instead.
`Participant`	`getParticipant()` Deprecated. use `participantCurrent()` instead
`Participant`	`getParticipant(String uid)` Deprecated. use `participantFind(String)` instead
`List`	`getParticipantsForInstance(InstanceStamp instance)` Deprecated. use `instanceGetParticipants(String, String, ParticipantFor)` instead. [instanceGetParticipants("/OU/Process#Default-1.0/1/0", "MyActivity", ParticipantFor.REASSIGN)]
`Presentation`	`getPresentation(PresentationType presentationType, String presentationId)` Deprecated. use `presentationGet(PresentationType, String)` instead
`Presentation`	`getPresentation(String presentationId)` Deprecated. use `presentationGet(String)` instead
`Presentation`	`getPresentation(ViewType viewType, String presentationId)` Deprecated. use `presentationGet(ViewType, String)` instead
`String[]`	`getPresentationIds(PresentationType presentationType)` Deprecated. use `presentationsGetIds(PresentationType)` instead
`Process`	`getProcess(int processIn)` Deprecated. use `processGet(int)` instead. 'In' is not a valid identifier in all environments. Use process id instead.
`Process`	`getProcess(String processId)` Deprecated. use `processGet(String)` instead
`ProcessDiagram`	`getProcessDiagram(int processIn)` Deprecated. use `processGetDiagram(Process)` instead
`ProcessDiagram`	`getProcessDiagram(Process process)` Deprecated. use `processGetDiagram(Process)` instead
`ProcessDiagram`	`getProcessDiagram(String processId)` Deprecated. use `processGetDiagram(String)` instead
`String`	`getProcessDocumentation(String processId, Locale locale)` Deprecated. use `processGetDocumentation(String, Locale)` instead
`Process[]`	`getProcesses(boolean force)` Deprecated. use `processesGet(boolean)` instead
`Process[]`	`getProcesses(boolean onlyActiveProcess, boolean force)` Deprecated. use `processesGet(boolean, boolean)` instead
`String`	`getProcessId(InstanceInfo instance)` Deprecated. use `instanceGetProcessId(InstanceInfo)` instead
`String`	`getProcessId(int processIn)` Deprecated. use `processGetId(int)` instead
`String[]`	`getProcessIds()` Deprecated. use `processesGetIds()` instead
`String[]`	`getProcessIds(boolean onlyActiveProcess)` Deprecated. use `processesGetIds(boolean)` instead
`String`	`getProcessImage(String processId)` Deprecated. use `processGetDiagram(Process)` instead
`int`	`getProcessIn(String processId)` Deprecated. 'In' is not a valid identifier in all environments.
`ProcessService`	`getProcessService()` Returns the `ProcessService` used to create this session.
`Map<String,?>`	`getSecureEngines()`
`Object`	`getSessionProperty(String key)` Gets PAPI Session scope property.
`TimeZone`	`getTimeZone()` Deprecated. use `participantTimeZone()` instead
`Locale`	`getUserLocale()` Deprecated. use `participantLocale()` instead
`TimeZone`	`getUserTimeZone()` Deprecated. use `participantTimeZone()` instead
`VarDefinition`	`getVar(String variableId)` Deprecated. use `variableGet(String)` instead
`VarDefinition[]`	`getVars()` Deprecated. use `variablesGet()` instead
`View`	`getView(String viewId)` Deprecated. use `viewGet(String)` instead
`String[]`	`getViewIds()` Deprecated. use `viewsGetIds()` instead
`String[]`	`getVisibleActivities(String processId)` Deprecated. use `processGetVisibleActivities(String)` instead
`Attachment[]`	`getWorkingAttachments(String processId)` Deprecated. use `processGetWorkingAttachments(String)` instead
`boolean`	`hasNewInstances()` Deprecated. Use #viewsHaveNewInstances instead.
`boolean`	`hasNewInstances(String viewId)` Deprecated. use `viewHasNewInstances(String)` instead
`void`	`instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file)` Attaches a file attachment to this process instance.
`void`	`instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file, String contentType)` Attaches a file with the specified content type to this process instance.
`void`	`instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file, String contentType, Locale locale)` Attaches a file with the specified content type to this process instance.
`void`	`instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file, String contentType, Locale locale, AttachmentStorageType storageType)` Attaches a file with the specified content type to this process instance.
`void`	`instanceAttach(String instanceId, String name, String description, String remarks, File file, String contentType, Locale locale)` Attaches a file with the specified content type to this process instance.
`void`	`instanceAttach(String instanceId, String name, String description, String remarks, File file, String contentType, Locale locale, AttachmentStorageType storageType)` Attaches a file with the specified content type to this process instance.
`boolean`	`instanceCanBeAborted(InstanceInfo instance)` Returns `true` if the instance can be aborted.
`boolean`	`instanceCanBeAborted(String instanceId)` Returns `true` if the instance can be aborted.
`boolean`	`instanceCanBeBack(InstanceInfo instance)` Deprecated. use `instanceCanBeSentBack(InstanceInfo)` instead.
`boolean`	`instanceCanBeDelegate(InstanceInfo instance)` Deprecated. use `instanceCanBeDelegated(InstanceInfo)` instead.
`boolean`	`instanceCanBeDelegated(InstanceInfo instance)` Returns `true` if the instance can be delegated.
`boolean`	`instanceCanBeDelegated(String instanceId)` Returns `true` if the instance can be delegated.
`boolean`	`instanceCanBeEscalate(InstanceInfo instance)` Deprecated. use `instanceCanBeEscalated(InstanceInfo)` instead.
`boolean`	`instanceCanBeEscalated(InstanceInfo instance)` Returns `true` if this instance can be escalated.
`boolean`	`instanceCanBeEscalated(String instanceId)` Returns `true` if this instance can be escalated.
`boolean`	`instanceCanBeProcessed(InstanceInfo instance)` Returns `true` if the instance can be processed.
`boolean`	`instanceCanBeProcessed(String instanceId)` Returns `true` if the instance can be processed.
`boolean`	`instanceCanBeReassign(InstanceInfo instance)` Deprecated. use `instanceCanBeReassigned(InstanceInfo)` instead.
`boolean`	`instanceCanBeReassigned(InstanceInfo instance)` Returns `true` if the instance can be reassigned.
`boolean`	`instanceCanBeReassigned(String instanceId)` Returns `true` if the instance can be reassigned.
`boolean`	`instanceCanBeReassignedToPeer(InstanceInfo instance)` Returns `true` if this instance can be reassigned to a peer.
`boolean`	`instanceCanBeReassignedToPeer(String instanceId)` Returns `true` if this instance can be reassigned to a peer.
`boolean`	`instanceCanBeResumed(InstanceInfo instance)` Returns `true` if the instance can be resumed.
`boolean`	`instanceCanBeResumed(String instanceId)` Returns `true` if the instance can be resumed.
`boolean`	`instanceCanBeSelected(InstanceInfo instance)` Returns `true` if the instance can be selected by the current participant.
`boolean`	`instanceCanBeSelected(String instanceId)` Returns `true` if the instance can be selected by the current participant.
`boolean`	`instanceCanBeSent(InstanceInfo instance)` Returns `true` if the instance can be sent.
`boolean`	`instanceCanBeSent(String instanceId)` Returns `true` if the instance can be sent.
`boolean`	`instanceCanBeSentBack(InstanceInfo instance)` Returns `true` if the instance can be routed back.
`boolean`	`instanceCanBeSentBack(String instanceId)` Returns `true` if the instance can be routed back.
`boolean`	`instanceCanBeSuspended(InstanceInfo instance)` Returns `true` if the instance can be suspended.
`boolean`	`instanceCanBeSuspended(String instanceId)` Returns `true` if the instance can be suspended.
`boolean`	`instanceCanBeUngrabbed(InstanceInfo instance)` Returns `true` if the instance can be ungrabbed.
`boolean`	`instanceCanBeUngrabbed(String instanceId)` Returns `true` if the instance can be ungrabbed.
`boolean`	`instanceCanBeUnselected(InstanceInfo instance)` Returns `true` if the instance can be unselected by the current participant An instance can be unselected if the instance is currently selected by the participant
`boolean`	`instanceCanBeUnselected(String instanceId)` Returns `true` if the instance can be unselected by the current participant An instance can be unselected if the instance is currently selected by the participant
`AttachmentList`	`instanceGetAttachments(InstanceInfo instance)` Gets all the Attachments associated with this instance.
`AttachmentList`	`instanceGetAttachments(String instanceId)` Returns an array with all the attachments related with the passed instance.
`DynamicObject`	`instanceGetData(InstanceInfo instance)` Gets the instance component associated with this instance. The instance component is the instance of the class generated during the deployment.
`DynamicObject`	`instanceGetData(String instanceId)` Gets the instance component associated with this instance identification. The instance component is the instance of the class generated during the deployment.
`InstanceEventList`	`instanceGetEvents(InstanceInfo instance)` Returns the InstanceEvents for the specified instance.
`InstanceEventList`	`instanceGetEvents(String instanceId)` Returns the InstanceEvents for the specified instanceId.
`ActivityList`	`instanceGetGlobalActivities(InstanceInfo instance)` Returns all Global activities which can be called for the specified instance.
`ActivityList`	`instanceGetGlobalActivities(String instanceId)` Returns all Global activities which can be called for the specified instance.
`Consult`	`instanceGetLastConsult(InstanceInfo instance)` Gets the Consult associated with the specified instanceId, or `null` if there is no consultation.
`Consult`	`instanceGetLastConsult(String instanceId)` Gets the last Consult associated with the specified instanceId, or `null` if there is no consultation.
`NoteList`	`instanceGetNotes(InstanceInfo instance)` Gets all the Notes associated with the specified instance.
`NoteList`	`instanceGetNotes(String instanceId)` Gets all the Notes associated with the specified instance.
`ParticipantList`	`instanceGetParticipants(InstanceInfo instance, ParticipantFor participantFor)` Gets a list of participants that the specified instance can be assigned to.
`ParticipantList`	`instanceGetParticipants(String instanceId, ParticipantFor participantFor)` Deprecated. use `instanceGetParticipants(String, String, ParticipantFor, String, int)` instead
`ParticipantList`	`instanceGetParticipants(String instanceId, String activityName, ParticipantFor participantFor)` Deprecated. use `instanceGetParticipants(String, String, ParticipantFor, String, int)` instead
`ParticipantList`	`instanceGetParticipants(String instanceId, String activityName, ParticipantFor participantFor, String filter, int max)` Gets a list of participants that the specified instance can be assigned to.
`String`	`instanceGetProcessId(InstanceInfo instance)` Gets the processId from the specified instanceInfo.
`String`	`instanceGetProcessId(String instanceId)` Gets the processId for the specified InstanceId.
`Object`	`instanceGetVariable(InstanceInfo instance, String variableId)` Returns the value of the variable in the given instance.
`Object`	`instanceGetVariable(String instanceId, String variableId)` Returns the value of the variable in the given instance.
`ActivityList`	`instanceGrabbableFrom(InstanceInfo instance)` Gets all the grab activities that can grab this instance.
`ActivityList`	`instanceGrabbableFrom(String instanceId)` Gets all the grab activities that can grab this instance.
`boolean`	`instanceHasAttachments(InstanceInfo instance)` Returns `true` if the specified instance has attachments.
`boolean`	`instanceHasAttachments(String instanceId)` Returns `true` if the specified instance has attachments.
`boolean`	`instanceHasNotes(InstanceInfo instance)` Returns `true` if the specified instance has notes.
`boolean`	`instanceHasNotes(String instanceId)` Returns `true` if the specified instance has notes.
`void`	`instanceLinkExternalAttachment(InstanceInfo instanceInfo, String externalId, AttachmentStorageType storageType)` Links an external attachment (stored in an external storage repository) to the instance.
`void`	`instanceLinkExternalAttachment(String instanceId, String externalId, AttachmentStorageType storageType)` Links an external attachment (stored in an external storage repository) to the instance.
`void`	`instanceReassign(InstanceInfo instance, String participant)` Reassigns the instance to the specified participant.
`void`	`instanceReassign(InstanceStamp instance, String participant)` Deprecated. use `instanceReassign(String, String, String)` instead
`void`	`instanceReassign(String instanceId, String activityName, String participant)` Reassigns the instance to the specified participant.
`InstanceInfo`	`instanceRefresh(InstanceInfo instanceInfo)` Forces the reload of the specified InstanceInfo.
`InstanceInfo`	`instanceRefresh(String instanceId)` Forces the reload of the specified InstanceInfo.
`String`	`instanceRetrieveProperty(InstanceInfo instanceInfo, String key)` Retrieves an instance scope property from the specified instance.
`String`	`instanceRetrieveProperty(String instanceId, String key)` Retrieves an instance scope property from the specified instance.
`void`	`instancesAbort(InstanceActivityPairSet instanceActivityPairs)` Aborts the specified instances.
`void`	`instancesAbort(InstanceStamp[] instances)` Deprecated. use `instancesAbort(InstanceActivityPairSet)` instead
`void`	`instancesAddBookmark(InstanceActivityPairSet instanceActivityPairs)` Adds bookmarks.
`void`	`instancesAddConsult(InstanceActivityPairSet instanceActivityPairs, String consult, String toParticipant)` Adds consultations for the specified instances for the specified participant.
`void`	`instancesAddConsult(InstanceStamp[] instances, String consult, String toParticipant)` Deprecated. use `instancesAddConsult(InstanceActivityPairSet, String, String)` instead
`void`	`instancesAddHistory(InstanceActivityPairSet instances)`
`void`	`instancesAddNote(InstanceActivityPairSet instanceActivityPairs, String note)` Adds a note to the specified instances.
`void`	`instancesAddNote(InstanceStamp[] instances, String note)` Deprecated. use `instancesAddNote(InstanceActivityPairSet, String)` instead
`fuego.collections.lists.StringList`	`instancesGetBookmarks()` Gets bookmarks for the current participant.
`fuego.collections.lists.StringList`	`instancesGetConsults()` Gets all the Consults for this session.
`ParticipantList`	`instancesGetParticipants(InstanceActivityPairSet instanceActivityPairSet, ParticipantFor participantFor)` Deprecated. use `instancesGetParticipants(fuego.papi.collections.InstanceActivityPairSet, ParticipantFor, String, int)` instead
`ParticipantList`	`instancesGetParticipants(InstanceActivityPairSet instanceActivityPairSet, ParticipantFor participantFor, String filter, int max)` Gets a list of participants that the specified set of instances can be assigned to.
`fuego.collections.lists.StringList`	`instancesGetTargetActivities(InstanceActivityPairSet instanceActivityPairs)` Returns the activities that can receive the specified group of instances.
`ActivityList`	`instancesGetTargetActivitiesList(InstanceActivityPairSet instanceActivityPairs)` Returns the activities that can receive the specified group of instances.
`ParticipantsForActivities`	`instancesGetTargetParticipants(InstanceActivityPairSet instanceActivityPairs)` Deprecated. use `instancesGetTargetActivities(fuego.papi.collections.InstanceActivityPairSet)` and `instancesGetTargetParticipantsForActivity(fuego.papi.collections.InstanceActivityPairSet, java.lang.String, java.lang.String, int)` instead.
`Map`	`instancesGetTargetParticipantsForActivity(InstanceActivityPairSet instanceActivityPairs, String activityName, String filter, int max)` Returns the participants who can receive the specified group of instances in the specified activity.
`void`	`instancesGrab(InstanceActivityPairSet instanceActivityPairs, String grabActivityName)` Grabs a group of instances by the specified activity.
`void`	`instancesGrab(InstanceStamp[] instances, String grabActivityName)` Deprecated. use `instancesGrab(InstanceActivityPairSet, String)` instead
`void`	`instancesReassign(InstanceActivityPairSet instanceActivityPairSet, String participant)` Reassigns the instance to the specified participant.
`void`	`instancesRemoveBookmark(InstanceActivityPairSet instanceActivityPairs)` Removes bookmarks.
`void`	`instancesResume(InstanceActivityPairSet instanceActivityPairs)` Resumes a group of instances.
`void`	`instancesResume(InstanceStamp[] instances)` Deprecated. use `instancesResume(fuego.papi.collections.InstanceActivityPairSet)` instead
`void`	`instancesSelect(InstanceActivityPairSet instanceActivityPairs)` Selects a group of instances by the current participant.
`void`	`instancesSelect(InstanceStamp[] instances)` Deprecated. use `instancesSelect(fuego.papi.collections.InstanceActivityPairSet)` instead
`void`	`instancesSend(InstanceActivityPairSet instanceActivityPairs)` Sends a group of instances.
`void`	`instancesSend(InstanceStamp[] instances)` Deprecated. use `instancesSend(InstanceActivityPairSet)` instead
`void`	`instancesSendBack(InstanceActivityPairSet instanceActivityPairs, boolean skip)` Sends back a group of instances.
`void`	`instancesSendBack(InstanceStamp[] instances, boolean skip)` Deprecated. use `instancesSendBack(InstanceActivityPairSet, boolean)` instead
`void`	`instancesSendTo(InstanceActivityPairSet instanceActivityPairs, String activityName)` Routes a group of instances to the specified activity.
`void`	`instancesSendTo(InstanceActivityPairSet instanceActivityPairs, String activityName, String participant)` Routes a group of instances to the specified activity and participant.
`void`	`instancesSendTo(InstanceStamp[] instances, String activityName)` Deprecated. use `instancesSendTo(InstanceActivityPairSet, String)` instead
`void`	`instancesSendTo(InstanceStamp[] instances, String activityName, String participant)` Deprecated. use `instancesSendTo(InstanceActivityPairSet, String, String)` instead
`void`	`instancesSuspend(InstanceActivityPairSet instanceActivityPairs)` Suspends a group of instances.
`void`	`instancesSuspend(InstanceStamp[] instances)` Deprecated. use `instancesSuspend(InstanceActivityPairSet)` instead
`ParticipantsForActivities`	`instancesTargetParticipants(InstanceStamp[] instances)` Deprecated. use `instancesGetTargetParticipants(InstanceActivityPairSet)` instead
`void`	`instanceStoreProperty(InstanceInfo instanceInfo, String key, String value)` Stores an instance scope property in the specified instance.
`void`	`instanceStoreProperty(String instanceId, String key, String value)` Stores an instance scope property in the specified instance.
`void`	`instancesUngrab(InstanceActivityPairSet instanceActivityPairs)` Ungrabs a group of instances.
`void`	`instancesUngrab(InstanceStamp[] instances)` Deprecated. use `instancesUngrab(InstanceActivityPairSet)` instead
`void`	`instancesUnselect(InstanceActivityPairSet instanceActivityPairs)` Unselects a group of instances.
`void`	`instancesUnselect(InstanceStamp[] instances)` Deprecated. use `instancesUnselect(InstanceActivityPairSet)` instead
`boolean`	`isChangeParticipantPasswordSupported()` Deprecated. use `participantChangePasswordEnabled()` instead
`boolean`	`isOpened()` Returns true if this session is open.
`Note`	`noteGet(String noteId)` Gets the Note specified by this noteId.
`ObjectClassInstance`	`objectClassInstanceFetchByName(String objectClass, String name)` Retrieves an instance of the specified object class and name.
`ObjectClassInstance[]`	`objectClassInstanceFetchByParticipants(String objectClass, String[] participants)` Retrieves an array of instances for the specified object class that is visible to any of the participants.
`ObjectClassInstance[]`	`objectClassInstanceFetchByRoles(String objectClass, String[] roles)` Retrieves an array of instances for the specified object class that is visible to any of the roles.
`ObjectClassInstance[]`	`objectClassInstanceFetchByRolesAndParticipants(String objectClass, String[] roles, String[] participants)` Retrieves an array of instances for the specified object class that is visible to any of the roles and participants.
`void`	`obtainEditionLock(Attachment attachment)` Deprecated. use `attachmentEdit(Attachment)` instead
`String`	`organization()` Gets the organization name.
`fuego.collections.lists.StringList`	`organizations()` Gets all organization names which the Session is connected to.
`Calendar`	`participantCalendar()` Gets the calendar set with the session Locale and TimeZone.
`boolean`	`participantChangePasswordEnabled()` Returns `true` if the directory supports changing the current participant password.
`Participant`	`participantCurrent()` Gets the Participant for this session.
`void`	`participantEnableMailReception(boolean enableMailReception)` Sets whether or not the current participant can receive mail.
`Participant`	`participantFind(String uid)` Gets the Participant specified by participantUid.
`ParticipantList`	`participantFindByName(String name)` Returns an array of Participants that match the specified name using a substring search.
`String`	`participantHost()` Returns the host where the owner of this session is connected from.
`Locale`	`participantLocale()` Returns the current participant Locale.
`Map`	`participantRetrieveProperties(String category)` Returns a Map with all participant properties for the specified category.
`String`	`participantRetrieveProperty(String category, String key)` Returns a participant property.
`void`	`participantStoreProperties(String category, Map<String,Object> properties)` Stores current participant properties.
`void`	`participantStoreProperty(String category, String key, Object value)` Stores current participant property.
`TimeZone`	`participantTimeZone()` Gets the TimeZone for the current participant.
`void`	`participantUpdateLocale(Locale locale)` Updates the current participant locale and stores it.
`void`	`participantUpdatePassword(String oldPassword, String newPassword)` Updates the current participant password.
`void`	`participantUpdateTimeZone(TimeZone timezone)` Updates the current participant time zone and stores it.
`Arguments`	`prepareExternalActivity(String instanceStampId, int taskIn, Arguments args)` Deprecated. use `activityPrepare(String, String, Arguments)` instead
`Arguments`	`prepareExternalActivity(String instanceId, String activityName, Arguments args)` Deprecated. use `activityPrepare(String, String, Arguments)` instead
`Arguments`	`prepareExternalActivity(String instanceId, String activityName, int taskIn, Arguments args)` Deprecated. use `activityPrepare(String, String, Arguments)` instead
`Presentation`	`presentationCreate(PresentationType presentationType, String id, Presentation.Column[] columns)` Creates a Presentation.
`EditablePresentation`	`presentationEdit(Presentation presentation)` Gets an EditablePresentation from a Presentation.
`Presentation`	`presentationGet(PresentationType presentationType, String presentationId)` Gets the Presentation for the specified PresentationType and presentationId.
`Presentation`	`presentationGet(String presentationId)` Gets the Presentation specified by this presentationId.
`Presentation`	`presentationGet(ViewType viewType, String presentationId)` Gets the Presentation for the specified ViewType and presentationId.
`Presentation`	`presentationGetDefault(PresentationType presentationType)` Gets the predefined default Presentation for the specified PresentationType.
`Presentation`	`presentationGetDefault(ViewType viewType)` Gets the default Presentation for the specified viewType.
`Presentation`	`presentationRefresh(String presentationId)` Forces the reload of the specified Presentation.
`void`	`presentationRemove(String presentationId)` Removes the presentation specified by presentationId.
`fuego.collections.lists.StringList`	`presentationsGetIds(PresentationType presentationType)` Gets all the presentationIds for the specified PresentationType.
`void`	`presentationStore(Presentation presentation)` Stores a presentation.
`InstanceInfo`	`processCreateInstance(String targetProcessId, Arguments arguments)` Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process.
`InstanceInfo`	`processCreateInstance(String targetProcessId, String argumentsSetName, Arguments arguments)` Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process with the specified argument set name.
`InstanceInfo`	`processCreateInstance(String targetProcessId, String argumentsSetName, Arguments arguments, String name, String description, String remarks, File file, String contentType, Locale locale)`
`InstanceInfo`	`processCreateInstance(String targetProcessId, String argumentsSetName, Arguments arguments, String name, String description, String remarks, File file, String contentType, Locale locale, AttachmentStorageType storageType)`
`ProcessList`	`processesGet(boolean force)` Gets all deployed Processes for the session.
`ProcessList`	`processesGet(boolean onlyActiveProcess, boolean force)` Gets all deployed Processes for the session.
`fuego.collections.lists.StringList`	`processesGetAllVersions(ProcessIdSet processes)` Returns all process identifications for the specific processes.
`ActivityList`	`processesGetApplications(ProcessIdSet processes)` Gets all the Interactive Global Activities for the specified processes, not include Global Automatic and Global with instance access.
`ActivityList`	`processesGetGlobalActivities(ProcessIdSet processes)` Gets all the Global Activities in the current participant roles for the specified processes.
`ActivityList`	`processesGetGlobalActivities(ProcessIdSet processes, boolean hasInstanceAccess)` Gets all the Global Activities in the current participant roles for the specified processes, and instance access.
`ActivityList`	`processesGetGlobalActivities(ProcessIdSet processes, int taskType, boolean hasInstanceAccess)` Gets all the Global Activities in the current participant roles for the specified processes, task type, and instance access.
`fuego.collections.lists.StringList`	`processesGetIds()` Gets the Ids of all deployed processes (Active and Deprecated versions) for this session.
`fuego.collections.lists.StringList`	`processesGetIds(boolean onlyActiveProcess)` Gets the Ids of all deployed processes for this session, and optionally only active processes.
`InstanceInfoList`	`processesGetInstancesByFilter(ProcessIdSet processes, Filter filter)` Gets `InstanceInfo`s from the specified ProcessIds and match with the specified Filter.
`Process`	`processGet(int processIn)` Deprecated. 'In' is not a valid identifier in all environments. Use process id instead.
`Process`	`processGet(String processId)` Returns a Process object for the specified process identification or for the active process if you use the consolidated process id.
`String`	`processGetActiveVersion(String process)` Gets the full active process identification for the specific process from the consolidated process Id or full process Id. For example, the consolidated process id could be "/East/Expense", and the active process id "/East/Expense#Default-2.1"; or the process id could be "/East/Expense#Default-1.0", and the active process id "/East/Expense#Default-2.1".
`fuego.collections.lists.StringList`	`processGetAllVersions(String process)` Returns all process Id versions for the specified process.
`ProcessDiagram`	`processGetDiagram(Process process)` Gets the ProcessDiagram for the specified process.
`ProcessDiagram`	`processGetDiagram(String processId)` Gets the ProcessDiagram for the specified processId.
`String`	`processGetDocumentation(String processId, Locale locale)` Gets the local path of the process documentation, created in Studio, for the specified locale.
`String`	`processGetId(int processIn)` Gets the processId from the specified process identification number.
`int`	`processGetIn(String processId)` Deprecated. 'In' is not a valid identifier in all environments.
`InstanceInfo`	`processGetInstance(String instanceId)` Gets the InstanceInfo specified by instanceId.
`InstanceInfo`	`processGetInstance(String instanceId, String activityName)` Gets the InstanceInfo specified by this Instance identification and the activity where the instance is supposed to be.
`InstanceInfo`	`processGetInstanceByCorrelation(String processId, String correlationName, Object[] correlationValues)` Gets the instance specified by the process id, correlation name, and correlation values.
`InstanceInfoList`	`processGetInstances(String process)` Gets the `InstanceInfo`s from the specified Process or Consolidated Process.
`ActivityList`	`processGetVisibleActivities(String processId)` Gets all the activities visible to the current participant in the specified process.
`AttachmentList`	`processGetWorkingAttachments(String processId)` Returns all Attachments locked by the current participant in the specified process.
`void`	`processRun(String targetProcessId, String argumentsSetName, Arguments arguments, long timeout)` Creates a new process instance in the specified Process and waits for the instance to reach the End activity up to the specified timeout.
`void`	`processSendNotification(String targetInstanceOrProcessId, String activityName, String targetArgumentsSetName, Arguments notification)` Sends a external notification to a process instance.
`void`	`processSendNotification(String targetInstanceOrProcessId, String activityName, String targetArgumentsSetName, Arguments notification, String sourceInstanceId)` Sends a notification to a process in a parent/child relationship or for an external wait/interruption with the specified argument set.
`void`	`putSessionProperty(String key, Object value)` Puts PAPI Session scope property.
`void`	`refresh(InstanceInfo instanceInfo)` Deprecated. use `instanceRefresh(InstanceInfo)` instead
`void`	`releaseEditionLock(Attachment attachment)` Deprecated. use `attachmentRelease(Attachment)` instead
`void`	`releaseEditionLock(Attachment attachment, File file)` Deprecated. use `attachmentRelease(Attachment, File)` instead
`void`	`removeBookmarks(InstanceStamp[] instancesStamp)` Deprecated. use `instancesRemoveBookmark(InstanceActivityPairSet)` instead
`void`	`removePresentation(String presentationId)` Deprecated. use `presentationRemove(String)` instead
`void`	`removeView(String viewId)` Deprecated. use `viewRemove(String)` instead
`Map`	`retrieveRoleProperties(String roleId, String category)` Deprecated. use `roleRetrieveProperties(String, String)` instead
`Map`	`retrieveUserProperties(String category)` Deprecated. use `participantRetrieveProperties(String)` instead
`String`	`retrieveUserStringProperty(String category, String key)` Deprecated. use `participantRetrieveProperty(String, String)` instead
`Map`	`roleRetrieveProperties(String roleId, String category)` Returns a Map with all properties for the specified category for the specified role.
`InstanceInfo`	`runActivity(String instanceStampId, Arguments args)` Deprecated. use `activityExecute(String, String, Arguments)` instead
`InstanceInfo`	`runActivity(String instanceStampId, int taskIn, Arguments args)` Deprecated. use `activityExecute(String, String, int, Arguments)` instead
`InstanceInfo`	`runActivity(String instanceId, String activityName, Arguments args)` Deprecated. use `activityExecute(String, String, Arguments)` instead
`InstanceInfo`	`runActivity(String instanceId, String activityName, int taskIn, Arguments args)` Deprecated. use `activityExecute(String, String, int, Arguments)` instead
`InstanceInfo`	`runGlobal(String instanceId, String activityName, Arguments args)` Deprecated. use `activityExecute(String, String, Arguments)` instead
`InstanceInfo`	`runGlobalActivity(String activityId)` Deprecated. use `activityExecuteApplication(String, String)` instead
`InstanceInfo`	`runGlobalActivity(String activityId, Arguments arguments)` Deprecated. use `activityExecuteApplication(String, String, Arguments)` instead
`void`	`runProcess(String targetProcessId, String argumentsSetName, Arguments arguments, long timeout)` Deprecated. use `processRun(String, String, Arguments, long)` instead
`Participant[]`	`searchParticipantsByName(String name)` Deprecated. use `participantFindByName(String)` instead
`void`	`sendNotification(String targetInstanceOrProcessId, String activityName, String targetArgumentsSetName, Arguments notification)` Deprecated. use `processSendNotification(String, String, String, Arguments)` instead
`void`	`sendNotification(String targetInstanceOrProcessId, String activityName, String targetArgumentsSetName, Arguments notification, String sourceInstanceId)` Deprecated. use `processSendNotification(String, String, String, Arguments, String)` instead
`void`	`setCanReceiveMail(boolean canReceiveMail)` Deprecated. use `participantEnableMailReception(boolean)` instead
`void`	`setDefaultOrderByForViews(String variable, boolean ascendingOrder)` Deprecated. use `viewsSetDefaultOrder(String, boolean)` instead
`void`	`setLocale(Locale locale)` Deprecated. use `participantUpdateLocale(Locale)` instead
`void`	`setTimeZone(TimeZone timezone)` Deprecated. use `participantUpdateTimeZone(TimeZone)` instead
`void`	`storePresentation(Presentation presentation)` Deprecated. use `presentationStore(Presentation)` instead
`void`	`storeUserProperties(String category, Map<String,Object> properties)` Deprecated. use `#participantStoreProperties(String, Map)` instead
`void`	`storeView(View view)` Deprecated. use `viewStore(View)` instead
`boolean`	`taskCanBeProcessed(InstanceInfo instance, int taskNumber)` Returns true if the specified task for this instance can be executed by the current participant.
`boolean`	`taskCanBeProcessed(int taskNumber, String activityName, String instanceId)` Returns true if the specified task for this instance can be executed by the current participant.
`boolean`	`taskCanBeSelected(InstanceInfo instance, int taskNumber)` Returns true if the specified task for this instance can be selected by the current participant.
`boolean`	`taskCanBeSelected(int taskNumber, String activityName, String instanceId)` Returns true if the specified task for this instance can be selected by the current participant.
`boolean`	`taskCanBeUnselected(InstanceInfo instance, int taskNumber)` Returns `true` if the specified task for this instance can be unselected by the current participant.
`boolean`	`taskCanBeUnselected(int taskNumber, String activityName, String instanceId)` Returns `true` if the specified task for this instance can be unselected by the current participant.
`void`	`tasksSelect(InstanceInfo instance, int[] taskNumbers)` Selects a process instance item. Selected items can only be processed by the participant which has them selected. Repeatable process instance items can be selected even if they have already been completed Note: Status is not changed to SELECTED when selecting a COMPLETED process instance item.
`void`	`tasksSelect(int[] taskNumbers, String activityName, String instanceId)` Selects a process instance item. Selected items can only be processed by the participant which has them selected. Repeatable process instance items can be selected even if they have already been completed Note: Status is not changed to SELECTED when selecting a COMPLETED process instance item.
`void`	`tasksSelect(String instanceId, String activityName, int[] taskNumbers)` Deprecated. use `tasksSelect(int[], String, String)` instead
`void`	`tasksUnselect(InstanceInfo instance, int[] taskNumbers)` Uselects this process instance item. Process instance items that are not selected by any participant can be processed by any participant in the role of the current activity. Repeatable process instance items can be selected even if they have already been completed. Note: Status is not changed to PENDING when unselecting a COMPLETED process instance item.
`void`	`tasksUnselect(int[] taskNumbers, String activityName, String instanceId)` Uselects this process instance item. Process instance items that are not selected by any participant can be processed by any participant in the role of the current activity. Repeatable process instance items can be selected even if they have already been completed. Note: Status is not changed to PENDING when unselecting a COMPLETED process instance item.
`void`	`tasksUnselect(String instanceId, String activityName, int[] taskNumbers)` Deprecated. use `tasksUnselect(int[], String, String)` instead
`String`	`toString()` Returns the name of the class.
`void`	`updateSecurityToken(String tokenType, Object token)` Updates the current session security token type and token.
`void`	`updateUserLocale(Locale locale)` Deprecated. use `participantUpdateLocale(java.util.Locale)` instead
`void`	`updateUserPassword(String oldPassword, String newPassword)` Deprecated. use `participantUpdatePassword(String, String)` instead
`void`	`updateUserTimeZone(TimeZone timeZone)` Deprecated. use `participantUpdateTimeZone(java.util.TimeZone)` instead
`ProcessServiceAdminSession`	`upgradeToAdminSession()` Creates an administration session based on this `ProcessServiceSession`.
`VarDefinition`	`variableGet(String variableId)` Gets a VarDefinition from the loaded processes in this session.
`VarDefinitionList`	`variablesGet()` Returns all the variable definitions from all the processes in this session.
`EditableView`	`viewCreate(ViewType viewType, String viewId, String[] assignedProcesses)` Creates an EditableView.
`EditableView`	`viewEdit(View view)` Gets an EditableView from a View.
`View`	`viewGet(String viewId)` Returns the View specified by viewId.
`ActivityList`	`viewGetActivity(ActivityView view)` Deprecated. The ActivityScope is deprecated
`ActivityList`	`viewGetApplications(ApplicationsView view)` Returns all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified ApplicationsView.
`ActivityList`	`viewGetApplications(String applicationViewId)` Returns all the Global Activities for a given ApplicationsView
`AttachmentList`	`viewGetAttachments(AttachmentsView view)` Gets the Attachments from this AttachmentsView.
`Map<String,View>`	`viewGetChildren(String viewId)` Gets the children views of the view specified by view Id.
`InstanceInfoList`	`viewGetInstances(InstancesView view)` Gets the InstanceInfos from the specified instances view.
`InstanceInfoList`	`viewGetInstances(String viewId)` Gets the InstanceInfos from the specified instances view.
`View`	`viewGetParent(String viewId)` Gets the parent View of the specified View.
`View`	`viewGetParent(View view)` Gets the parent View of the specified View.
`String`	`viewGetParentId(String viewId)` Gets the parent id of the specified view.
`boolean`	`viewHasNewInstances(String viewId)` Returns true if this view has new instances since the last access.
`View`	`viewRefresh(String viewId)` Forces the reload of the specified View.
`void`	`viewRemove(String viewId)` Removes the view specified by viewId.
`fuego.collections.lists.StringList`	`viewsGetIds()` Gets all the viewIds available to the current participant.
`boolean`	`viewsHaveNewInstances()` Returns true if any view has new instances since the last access to it.
`void`	`viewsSetDefaultOrder(String variable, boolean ascendingOrder)` Sets the default sort order for instance views.
`void`	`viewStore(View view)` Stores the specified view.

Field Detail

serialCheck

static final long serialCheck

See Also:: Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:: Constant Field Values

Method Detail

getProcessService

ProcessService getProcessService()

Returns the ProcessService used to create this session.

Returns:: ProcessService used to create this session.

getGlobalActivities

@Deprecated
Activity[] getGlobalActivities(Process[] processes,
                                          int taskType,
                                          boolean hasInstanceAccess)
                               throws BatchOperationException

Deprecated. processesGetGlobalActivities(ProcessIdSet, int, boolean) instead

Gets all the Global Activities in the current participant roles for the specified processes, task type, and instance access.

Parameters:

processes - array of processes to check for global activities. Cannot be null.

taskType - one of Task.CIL, Task.COMPONENT, Task.DECISION, Task.DISPLAY, Task.DISPLAY_INSTANCE, Task.EXTERNAL, Task.INPUT, Task.PROCEDURE, Task.SCREENFLOW, Task.SHOW_DASHBOARD, Task.SHOW_PROCESS_IMAGE or Task.SHOW_WORKLOAD.

hasInstanceAccess - whether the global activity has instance access or not.

Returns:

Global Activities for the specified processes, type, and instance access.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.

processesGetGlobalActivities

ActivityList processesGetGlobalActivities(ProcessIdSet processes,
                                          int taskType,
                                          boolean hasInstanceAccess)
                                          throws BatchOperationException

Gets all the Global Activities in the current participant roles for the specified processes, task type, and instance access.

Parameters:

processes - ProcessIdSet of processes to check for global activities. Cannot be null.

hasInstanceAccess - whether the global activity has instance access or not.

Returns:

Global Activities for the specified processes, type, and instance access.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.

getGlobalActivities

@Deprecated
Activity[] getGlobalActivities(Process[] processes)
                               throws BatchOperationException

Deprecated. use processesGetGlobalActivities(ProcessIdSet) instead

Gets all the Global Activities in the current participant roles for the specified processes.

Parameters:

processes - array of processes to check for global activities. Cannot be null.

Returns:

Global Activities for the specified processes.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be performed on a process.

processesGetGlobalActivities

ActivityList processesGetGlobalActivities(ProcessIdSet processes)
                                          throws BatchOperationException

Gets all the Global Activities in the current participant roles for the specified processes.

Parameters:

processes - ProcessIdSet of processes to check for global activities. Cannot be null.

Returns:

Global Activities for the specified processes.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be performed on a process.

processesGetGlobalActivities

ActivityList processesGetGlobalActivities(ProcessIdSet processes,
                                          boolean hasInstanceAccess)
                                          throws BatchOperationException

Gets all the Global Activities in the current participant roles for the specified processes, and instance access.

Parameters:

processes - ProcessIdSet of processes to check for global activities. Cannot be null.

hasInstanceAccess - if the activity must has instance access.

Returns:

Global Activities for the specified processes and instance access.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be performed on a process.

processesGetApplications

ActivityList processesGetApplications(ProcessIdSet processes)
                                      throws BatchOperationException

Gets all the Interactive Global Activities for the specified processes, not include Global Automatic and Global with instance access.

Parameters:

processes - ProcessIdSet of processes to check for applications. Cannot be null.

Returns:

Interactive Global Activities for the specified processes, not include Global Automatic and Global with instance access.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be perform on a process.

getGlobalActivities

@Deprecated
Activity[] getGlobalActivities(String[] processIds,
                                          int activityType,
                                          boolean hasInstanceAccess)
                               throws BatchOperationException,
                                      OperationException

Deprecated. use processesGetGlobalActivities(ProcessIdSet, int, boolean) instead.

Gets all the Global Activities for the specified processes, type, and instance access.

Parameters:

processIds - array of processes to check for global activities. Cannot be null.

activityType - one of Activity.GLOBAL_AUTOMATIC, Activity.GLOBAL_CREATION or Activity.GLOBAL.

hasInstanceAccess - whether the global activity has access to instance variables.

Returns:

Global Activities for the specified processes, type, and instance access.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be perform on a process.

OperationException - if the session could not perform the operation.

getGlobalActivities

@Deprecated
Activity[] getGlobalActivities(String[] processIds)
                               throws BatchOperationException,
                                      OperationException

Deprecated. use processesGetGlobalActivities(fuego.papi.collections.ProcessIdSet) instead.

Gets all the Global Activities for the specified processIds.

Parameters:

processIds - array of processIds to check for global activities. Cannot be null.

Returns:

Global Activities for the specified processIds.

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all activities requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the operation could not be perform on a process.

instanceHasAttachments

boolean instanceHasAttachments(String instanceId)
                               throws OperationException

Returns true if the specified instance has attachments.

Parameters:

instanceId - Id of the instance to check for attachments. Cannot be null.

Returns:

true if the specified instance has attachments.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process of the instance is not available.
InstanceNotFoundException if the instance does not exist.

See Also:

Attachment

instanceHasAttachments

boolean instanceHasAttachments(InstanceInfo instance)
                               throws OperationException

Returns true if the specified instance has attachments.

Parameters:

instance - Instance to check for attachments. Cannot be null.

Returns:

true if the specified instance has attachments.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process of the instance is not available.
InstanceNotFoundException if the instance does not exist.

See Also:

Attachment

instanceHasNotes

boolean instanceHasNotes(String instanceId)
                         throws OperationException

Returns true if the specified instance has notes.

Parameters:

instanceId - Id of the instance to check for notes. Cannot be null.

Returns:

true if the specified instance has notes.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process of the instance is not available.
InstanceNotFoundException if the instance does not exist.

instanceHasNotes

boolean instanceHasNotes(InstanceInfo instance)
                         throws OperationException

Returns true if the specified instance has notes.

Parameters:

instance - Instance to check for notes. Cannot be null.

Returns:

true if the specified instance has notes.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process of the instance is not available.
InstanceNotFoundException if the instance does not exist.

setCanReceiveMail

@Deprecated
void setCanReceiveMail(boolean canReceiveMail)
                       throws OperationException

Deprecated. use participantEnableMailReception(boolean) instead

Sets whether or not the current participant can receive mail.

Parameters:: canReceiveMail - true if the current participant can receive mail
Throws:: OperationException - if the session could not perform the operation.

participantEnableMailReception

void participantEnableMailReception(boolean enableMailReception)
                                    throws OperationException

Sets whether or not the current participant can receive mail.

Parameters:: enableMailReception - true if the current participant can receive mail
Throws:: OperationException - if the session could not perform the operation.

isChangeParticipantPasswordSupported

@Deprecated
boolean isChangeParticipantPasswordSupported()
                                             throws OperationRuntimeException

Deprecated. use participantChangePasswordEnabled() instead

Returns true if the directory supports changing the participant password.

Returns:: true if the directory supports changing the participant password
Throws:: OperationRuntimeException - if the session could not perform the operation.

participantChangePasswordEnabled

boolean participantChangePasswordEnabled()
                                         throws OperationRuntimeException

Returns true if the directory supports changing the current participant password.

Returns:: true if the directory supports changing the current participant password
Throws:: OperationRuntimeException - if the session could not perform the operation.

getDelegateParticipants

@Deprecated
List getDelegateParticipants(InstanceStamp instance)
                             throws OperationException,
                                    BatchOperationException

Deprecated. use instanceGetParticipants(String, String, ParticipantFor) instead.
[instanceGetParticipants("/OU/ProcessName#Default-1.0/1/0", "MyActivity", ParticipantFor.DELEGATE)]

Gets a list of participants that this instance can be delegated to.

An instance can only be assigned if the interactive acitivity has been defined as assignable in Studio
and only participants who have been given permission to delegate in Process Administrator
can assign instances to participants with a lower category in the same role.
Role category is also assigned in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instance - InstanceStamp to get the list of participants; cannot be null

Returns:

list of participants that this instance can be delegated to or an empty list if there are no participants that this instance can be delegated to

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

activityGetGrabbableInstances

InstanceInfoList activityGetGrabbableInstances(String activityName,
                                               String processId)
                                               throws OperationException,
                                                      BatchOperationException

Returns all the instances that can be grabbed from the activity specified by the activity name and the process id.

Parameters:

activityName - name of the grab activity; cannot be null

processId - process identification where the activity is.

Returns:

instances that can be grabbed from the activity specified by activityId or a zero-length array if there are no grabbable instances

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available

BatchOperationException - if the session could not perform the operation on every activity
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all instances are available to perform the operation..
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

activityGetGrabbableInstances

InstanceInfoList activityGetGrabbableInstances(Activity activity)
                                               throws OperationException,
                                                      BatchOperationException

Returns all the instances that can be grabbed from the activity specified by the activity.

Parameters:

activity - Grab activity; cannot be null

Returns:

instances that can be grabbed from the activity specified by activityId or a zero-length array if there are no grabbable instances

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available

BatchOperationException - if the session could not perform the operation on every activity
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all instances are available to perform the operation..
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

instanceGetParticipants

@Deprecated
ParticipantList instanceGetParticipants(String instanceId,
                                                   ParticipantFor participantFor)
                                        throws OperationException,
                                               BatchOperationException

Deprecated. use instanceGetParticipants(String, String, ParticipantFor, String, int) instead

Gets a list of participants that the specified instance can be assigned to. (delegate, escalate, reassign or reassign to peer).

Parameters:

instanceId - Instance Identification to get the list of participants; cannot be null

participantFor - the assignment that you want to execute (delegate, escalate, reassign or reassign to peer).

Returns:

list of participants that this instance can be assign to or an empty list if there are no participants that this instance can be delegated to

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instanceGetParticipants

@Deprecated
ParticipantList instanceGetParticipants(String instanceId,
                                                   String activityName,
                                                   ParticipantFor participantFor)
                                        throws OperationException,
                                               BatchOperationException

Deprecated. use instanceGetParticipants(String, String, ParticipantFor, String, int) instead

Gets a list of participants that the specified instance can be assigned to. (delegate, escalate, reassign or reassign to peer).

Parameters:

instanceId - Id of the instance to get the list of participants; cannot be null

activityName - Activity name where yous suppose that the instance is.

participantFor - the assignation that you want to do (delegate, escalate, reassign or reassign to peer).

Returns:

list of participants that this instance can be assign to or an empty list if there are no participants that this instance can be assigned to.

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instanceGetParticipants

ParticipantList instanceGetParticipants(String instanceId,
                                        String activityName,
                                        ParticipantFor participantFor,
                                        String filter,
                                        int max)
                                        throws OperationException,
                                               BatchOperationException

Gets a list of participants that the specified instance can be assigned to. (delegate, escalate, reassign or reassign to peer).

Parameters:

instanceId - Id of the instance to get the list of participants; cannot be null

activityName - Activity name where yous suppose that the instance is.

participantFor - the assignation that you want to do (delegate, escalate, reassign or reassign to peer).

filter - pattern used to filter participants

max - maximum number of participants to be returned; if it is exceeded, MaxSizeParticipantsExceededException will be thrown

Returns:

list of participants that this instance can be assign to or an empty list if there are no participants that this instance can be assigned to.

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instanceGetParticipants

ParticipantList instanceGetParticipants(InstanceInfo instance,
                                        ParticipantFor participantFor)
                                        throws OperationException,
                                               BatchOperationException

Gets a list of participants that the specified instance can be assigned to. (delegate, escalate, reassign or reassign to peer).

An instance can only be assigned if the interactive activity has been defined as assignable in Studio
and only participants who have been given permission to delegate in Process Administrator
can assign instances to participants with a lower category in the same role.
Role category is also assigned in Process Administrator.

Parameters:

instance - InstanceInfo to get the list of participants; cannot be null

participantFor - the assignation that you want to do (delegate, escalate, reassign or reassign to peer).

Returns:

list of participants that this instance can be assign to or an empty list if there are no participants that this instance can be assigned to.

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instancesGetParticipants

@Deprecated
ParticipantList instancesGetParticipants(InstanceActivityPairSet instanceActivityPairSet,
                                                    ParticipantFor participantFor)
                                         throws OperationException,
                                                BatchOperationException

Deprecated. use instancesGetParticipants(fuego.papi.collections.InstanceActivityPairSet, ParticipantFor, String, int) instead

Gets a list of participants that the specified set of instances can be assigned to. (delegate, escalate, reassign or reassign to peer).

Parameters:

instanceActivityPairSet - set of Instance-Activity pairs with the instances to get the list of participants; cannot be null

participantFor - the assignation that you want to do (delegate, escalate, reassign or reassign to peer).

Returns:

list of participants that this set of instances can be assign to or an empty list if there are no participants that this set of instances can be assigned to.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the pair specify.

instancesGetParticipants

ParticipantList instancesGetParticipants(InstanceActivityPairSet instanceActivityPairSet,
                                         ParticipantFor participantFor,
                                         String filter,
                                         int max)
                                         throws OperationException,
                                                BatchOperationException

Gets a list of participants that the specified set of instances can be assigned to. (delegate, escalate, reassign or reassign to peer).

Parameters:

instanceActivityPairSet - set of Instance-Activity pairs with the instances to get the list of participants; cannot be null

participantFor - the assignation that you want to do (delegate, escalate, reassign or reassign to peer).

filter - pattern used to filter participants

max - maximum number of participants to be returned; if it is exceeded, MaxSizeParticipantsExceededException will be thrown

Returns:

list of participants that this set of instances can be assign to or an empty list if there are no participants that this set of instances can be assigned to.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the pair specify.

attachmentCheckIn

void attachmentCheckIn(Attachment attachment,
                       String remarks,
                       File file)
                       throws OperationException

Checks in an attachment.
If successful, this will always generate a new attachment version. If attachments are stored in an external repository that does not support versioning,
no new version will be created, only the external reference will be updated.

Parameters:

attachment - the attachment to check in; cannot be null

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to check in for the new attachment version; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InvalidAttachmentArgumentLengthException if the remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment could not be checked in

attachmentCheckIn

void attachmentCheckIn(String attachmentId,
                       String remarks,
                       File file)
                       throws OperationException

Parameters:

attachmentId - id of the attachment to check in; cannot be null

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to check in for the new attachment version; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InvalidAttachmentArgumentLengthException if the remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment could not be checked in

attachmentCheckOut

void attachmentCheckOut(Attachment attachment,
                        String folder)
                        throws OperationException

Writes the attachment to the specified folder.
To check out the attachment, first call attachmentEdit(Attachment).

Parameters:

attachment - attachment to write; cannot be null

folder - folder where the file will be written; this directory must already exist; if this is a relative directory, it is relative to where the PAPI program is running

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the attachment could not be written to the specified directory, if a version lock has not been obtained, or if the current participant does not hold the version lock

getActiveProcessId

@Deprecated
String getActiveProcessId(String process)

Deprecated. use processGetActiveVersion(String) instead

Gets the full active process identification for the specific process from the consolidated process Id or full process Id.
For example, the consolidated process id could be "/East/Expense", and the active process id "/East/Expense#Default-2.1";
or the process id could be "/East/Expense#Default-1.0", and the active process id "/East/Expense#Default-2.1".

Parameters:: process - full process id in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" or consolidated process Id in the format "/OrganizationalUnit/ProcessName". Cannot be null.
Returns:: the full active process identification for the specific process.

processGetActiveVersion

String processGetActiveVersion(String process)

Parameters:: process - full process id in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" or consolidated process Id in the format "/OrganizationalUnit/ProcessName". Cannot be null.
Returns:: the full active process identification for the specific process.

getActiveProcessIdsByView

@Deprecated
String[] getActiveProcessIdsByView(View view)

Deprecated. use View.getAssignedProcesses() and then use processGetActiveVersion(String) over each process in the array.

Gets the ids of the processes that are active in the specified View.

Parameters:: view - View to check for active processes. Cannot be null.
Returns:: the ids of the processes that are active in the specified View.

getActivityDocumentation

@Deprecated
String getActivityDocumentation(String activityId,
                                           Locale locale)
                                throws OperationException

Deprecated. use activityGetDocumentation(Activity, Locale) instead

Gets the full path to the localized documentation for the specified activityId and Locale.

Parameters:

activityId - Id of the activity that contains the localized documentation. Cannot be null.

locale - locale of the localized documentation. Cannot be null.

Returns:

the full path to the localized documentation for the specified activityId and locale.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ActivityNotFoundException if the activity does not exist.

activityGetDocumentation

String activityGetDocumentation(String activityName,
                                String processId,
                                Locale locale)
                                throws OperationException

Returns the local path of the HTML documentation for the given activity.
The activity documentation is retrieved from the engine and stored in the path indicated, along with the images used by the documentation.
The HTML file is always stored using UTF-8 encoding.

Parameters:: activityName - The activity to obtain the documentation.; processId - The process where the activity is.; locale - Locale for the documentation.
Returns:: String The local path of the HTML documentation for the given activity, or null if the activity has no documentation for the specified locale.
Throws:: OperationException - if a problem occured while getting the process information.; ProcessNotAvailableException - is the process referenced by activityID is not valid.

activityGetDocumentation

String activityGetDocumentation(Activity activity,
                                Locale locale)
                                throws OperationException

Gets the full path to the localized documentation for the specified activityId and Locale.

Parameters:

activity - Activity that contains the localized documentation. Cannot be null.

locale - locale of the localized documentation. Cannot be null.

Returns:

the full path to the localized documentation for the specified activityId and locale.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ActivityNotFoundException if the activity does not exist.

See Also:

Activity.getDocumentationMap()

getActivityForView

@Deprecated
Activity getActivityForView(ActivityView view)

Deprecated. The ActivityScope is deprecated

Gets the Activity associated with this ActivityView.

Parameters:: view - ActivityView to test.
Returns:: Activity associated with this ActivityView.

viewGetActivity

@Deprecated
ActivityList viewGetActivity(ActivityView view)

Deprecated. The ActivityScope is deprecated

Gets all versions of the Activity associated with this ActivityView.

Parameters:: view - ActivityView to test.
Returns:: ActivityList with all versions of the activity associated with this ActivityView.

getAllProcessVersions

@Deprecated
String[] getAllProcessVersions(String process)

Deprecated. use processGetAllVersions(String) instead

Returns all process Id versions for the specified process.

Parameters:: process - process Id or consolidated process Id. Cannot be null.
Returns:: all process Id versions for the specified process.

getAllProcessVersions

@Deprecated
String[] getAllProcessVersions(String[] processes)

Deprecated. use processesGetAllVersions(fuego.papi.collections.ProcessIdSet) instead

Returns all process identifications for the specific processes.

Parameters:: processes - Process identification or consolidated processes identification to obtain versions.
Returns:: All process identification

processGetAllVersions

fuego.collections.lists.StringList processGetAllVersions(String process)

Returns all process Id versions for the specified process.

Parameters:: process - process Id or consolidated process Id. Cannot be null.
Returns:: all process Id versions for the specified process.

processesGetAllVersions

fuego.collections.lists.StringList processesGetAllVersions(ProcessIdSet processes)

Returns all process identifications for the specific processes.

Parameters:: processes - Process identification or consolidated processes identification to obtain versions.
Returns:: All process identification

getApplicationsByView

@Deprecated
Activity[] getApplicationsByView(ApplicationsView view)
                                 throws OperationException,
                                        BatchOperationException

Deprecated. use viewGetApplications(ApplicationsView) instead

Returns all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified ApplicationsView.

Parameters:

view - applications view to check. Cannot be null.

Returns:

all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified applications view.

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation over every view.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all applications (activities) requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the process is not available.

viewGetApplications

ActivityList viewGetApplications(ApplicationsView view)
                                 throws OperationException,
                                        BatchOperationException

Returns all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified ApplicationsView.

Parameters:

view - applications view to check. Cannot be null.

Returns:

all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified applications view.

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation over every view.
May be one of the following subclasses of BatchOperationException:

ApplicationsNotAvailableException if not all applications (activities) requested are available.
You can find inside the batch exception:
- ApplicationsNotAvailableInProcessException if the process is not available.

viewGetApplications

ActivityList viewGetApplications(String applicationViewId)
                                 throws OperationException,
                                        BatchOperationException

Returns all the Global Activities for a given ApplicationsView

Parameters:: applicationViewId - View Id of the View to obtain the applications.
Returns:: List of Activity with all global activities for the view.
Throws:: OperationException - if the operation fails; BatchOperationException - if the operation fails

getAttachment

@Deprecated
Attachment getAttachment(String attachmentId)
                         throws OperationException

Deprecated. use attachmentGet(String) instead

Gets the Attachment for this attachmentId.

Parameters:

attachmentId - attachment Id. Cannot be null.

Returns:

Attachment for this attachmentId.

Throws:

OperationException - if the session was unable to retrieve this attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

attachmentGet

Attachment attachmentGet(String attachmentId)
                         throws OperationException

Gets the Attachment for this attachmentId.

Parameters:

attachmentId - attachment Id. Cannot be null.

Returns:

Attachment for this attachmentId.

Throws:

OperationException - if the session was unable to retrieve this attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

getAttachmentLastVersion

@Deprecated
Attachment getAttachmentLastVersion(String attachmentId)
                                    throws OperationException

Deprecated. use attachmentGetLastVersion(String) instead

Gets the last version of the Attachment specified by attachmentId.

Parameters:

attachmentId - Id of the attachment to retrieve. Cannot be null.

Returns:

last version of the Attachment specified by attachmentId.

Throws:

OperationException - if the session was unable to retrieve the last version of the attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

attachmentGetLastVersion

Attachment attachmentGetLastVersion(String attachmentId)
                                    throws OperationException

Gets the last version of the Attachment specified by attachmentId.

Parameters:

attachmentId - Id of the attachment to retrieve. Cannot be null.

Returns:

last version of the Attachment specified by attachmentId.

Throws:

OperationException - if the session was unable to retrieve the last version of the attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

getAttachmentVersions

@Deprecated
Attachment[] getAttachmentVersions(String attachmentId)
                                   throws OperationException

Deprecated. use attachmentGetAllVersions(String) instead

Gets all the Attachments associated with this attachment. This does not return the Attachments in any specific order.

A new attachment version is created when an attachment is checked out and a new version is checked in.

Parameters:

attachmentId - Id of the attachment to test. Cannot be null.

Returns:

Array of attachment versions associated with this attachment.

Throws:

OperationException - if the session was unable to retrieve the all versions of the attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

attachmentGetAllVersions

AttachmentList attachmentGetAllVersions(String attachmentId)
                                        throws OperationException

Gets all the Attachments associated with this attachment. This does not return the Attachments in any specific order.

A new attachment version is created when an attachment is checked out and a new version is checked in.

Parameters:

attachmentId - Id of the attachment to test. Cannot be null.

Returns:

List of attachment versions associated with this attachment.

Throws:

OperationException - if the session was unable to retrieve the all versions of the attachment.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

See Also:

to get the last attachment.

getAttachmentsByInstance

@Deprecated
Attachment[] getAttachmentsByInstance(String instanceId)
                                      throws OperationException

Deprecated. use instanceGetAttachments(String) instead

Gets all the Attachments associated with this instance.

Parameters:

instanceId - Id of the instance to test. Cannot be null.

Returns:

array of attachments associated with this instance, or 0-length array if there are no associated attachments.

Throws:

OperationException - if the session was unable to retrieve the attachments for the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

instanceGetAttachments

AttachmentList instanceGetAttachments(String instanceId)
                                      throws OperationException

Returns an array with all the attachments related with the passed instance.

Parameters:: instanceId - Identificator of the instance where to gather all the attachments
Returns:: An Attachment list with all attachments of the given instance.
Throws:: OperationException - if the operation fails

instanceGetAttachments

AttachmentList instanceGetAttachments(InstanceInfo instance)
                                      throws OperationException

Gets all the Attachments associated with this instance.

Parameters:

instance - Instance to test. Cannot be null.

Returns:

array of attachments associated with this instance, or 0-length array if there are no associated attachments.

Throws:

OperationException - if the session was unable to retrieve the attachments for the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
AttachmentNotFoundException if the attachment does not exist.

getAttachmentsByView

@Deprecated
Attachment[] getAttachmentsByView(AttachmentsView view)
                                  throws BatchOperationException

Deprecated. use viewGetAttachments(AttachmentsView) instead

Gets the Attachments from this AttachmentsView.

Parameters:

view - attachments view. An attachment view is a view of checked-out attachments. Cannot be null.

Returns:

Array of Attachments from this AttachmentsView, or zero-length array if there are no attachments in this attachments view.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

AttachmentsNotAvailableException if not all the attachments requested are available.
You can find inside the batch exception:
- AttachmentsNotAvailableInProcessException if the operation could not be perform on a process.

viewGetAttachments

AttachmentList viewGetAttachments(AttachmentsView view)
                                  throws BatchOperationException

Gets the Attachments from this AttachmentsView.

Parameters:

view - attachments view. An attachment view is a view of checked-out attachments. Cannot be null.

Returns:

Array of Attachments from this AttachmentsView, or zero-length array if there are no attachments in this attachments view.

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

AttachmentsNotAvailableException if not all the attachments requested are available.
You can find inside the batch exception:
- AttachmentsNotAvailableInProcessException if the operation could not be perform on a process.

getBookmarks

@Deprecated
String[] getBookmarks()
                      throws OperationException

Deprecated. use instancesGetBookmarks() instead

Gets bookmarks for the current participant.

Returns:: array of bookmarked instanceIds.
Throws:: OperationException - if the session was unable to retrieve the bookmarks.

instancesGetBookmarks

fuego.collections.lists.StringList instancesGetBookmarks()
                                                         throws OperationException

Gets bookmarks for the current participant.

Returns:: array of bookmarked instanceIds.
Throws:: OperationException - if the session was unable to retrieve the bookmarks.
See Also:: instancesAddBookmark(fuego.papi.collections.InstanceActivityPairSet)

getCalendar

@Deprecated
Calendar getCalendar()

Deprecated. use participantCalendar() instead

Gets the calendar set with the session Locale and TimeZone.

Returns:: calendar set with the session Locale and TimeZone.

participantCalendar

Calendar participantCalendar()
                             throws OperationException

Gets the calendar set with the session Locale and TimeZone.

Returns:: calendar set with the session Locale and TimeZone.
Throws:: OperationException - if the session was unable ot retrive the participant calendar.

getChildrenViews

@Deprecated
Map getChildrenViews(String viewId)

Deprecated. use viewGetChildren(String) instead

Gets the children views of the view specified by view Id.

Parameters:: viewId - Id of View to check for children. Cannot be null.
Returns:: Map where keys are viewIds and values are Views. If the view does not have children returns an empty Map.

viewGetChildren

Map<String,View> viewGetChildren(String viewId)

Gets the children views of the view specified by view Id.

Parameters:: viewId - Id of View to check for children. Cannot be null.
Returns:: Map where keys are viewIds and values are Views. If the view does not have children returns an empty Map.

getConsult

@Deprecated
Consult getConsult(String instanceId)
                   throws OperationException

Deprecated. use instanceGetLastConsult(InstanceInfo) instead

Gets the last Consult associated with the specified instance, or null if there is no consultation.

Parameters:: instanceId - instance Id to check. Cannot be null.
Returns:: Consult associated with the specified instanceId, or null if there is no Consult.
Throws:: OperationException - if the session was unable to retrieve the consultations for the instance.

instanceGetLastConsult

Consult instanceGetLastConsult(String instanceId)
                               throws OperationException

Gets the last Consult associated with the specified instanceId, or null if there is no consultation.

Parameters:: instanceId - instance Id to check. Cannot be null.
Returns:: Consult associated with the specified instanceId, or null if there is no Consult.
Throws:: OperationException - if the session was unable to retrieve the consultations for the instance.

instanceGetLastConsult

Consult instanceGetLastConsult(InstanceInfo instance)
                               throws OperationException

Gets the Consult associated with the specified instanceId, or null if there is no consultation.

Parameters:: instance - Instance to check. Cannot be null.
Returns:: Consult associated with the specified instanceId, or null if there is no Consult.
Throws:: OperationException - if the session was unable to retrieve the consultations for the instance.
See Also:: instancesAddConsult(fuego.papi.collections.InstanceActivityPairSet, String, String)

getConsults

@Deprecated
String[] getConsults()
                     throws OperationException

Deprecated. use instancesGetConsults() instead

Gets all the Consults for this session.

Returns:: array of instanceIds for instances what have Consults.
Throws:: OperationException - if the session was unable to retrieve the consultations.

instancesGetConsults

fuego.collections.lists.StringList instancesGetConsults()
                                                        throws OperationException

Gets all the Consults for this session.

Returns:: array of instanceIds for instances what have Consults.
Throws:: OperationException - if the session was unable to retrieve the consultations.

setDefaultOrderByForViews

@Deprecated
void setDefaultOrderByForViews(String variable,
                                          boolean ascendingOrder)
                               throws InvalidVariableIdException

Deprecated. use viewsSetDefaultOrder(String, boolean) instead

Sets the default sort order for instance views.

Parameters:: variable - an Id from one of the VarDefinitions specified in VarDefinition.createInstanceDefaults() or an External VarDefinition added to a Process. Cannot be null.; ascendingOrder - ascending if true descending if false.
Throws:: InvalidVariableIdException - if the variable does not exists.





viewsSetDefaultOrder
void viewsSetDefaultOrder(String variable,
                          boolean ascendingOrder)
                          throws InvalidVariableIdException


Sets the default sort order for instance views.

Parameters:: variable - an Id from one of the VarDefinitions specified in VarDefinition.createInstanceDefaults() or an External VarDefinition added to a Process. Cannot benull.; ascendingOrder - ascending if true descending if false.
Throws:: InvalidVariableIdException - if the variable does not exists.





getDefaultPresentation
@Deprecated
Presentation getDefaultPresentation(PresentationType presentationType)

Deprecated. use presentationGetDefault(PresentationType) instead

Gets the predefined default Presentation for the specified PresentationType.





Parameters:
presentationType - one of the static PresentationType. Cannot be null.
Returns:
default Presentation for the specified presentationType.





presentationGetDefault
Presentation presentationGetDefault(PresentationType presentationType)

Gets the predefined default Presentation for the specified PresentationType.





Parameters:
presentationType - one of the static PresentationType. Cannot be null.
Returns:
default Presentation for the specified presentationType.





getDefaultPresentation
@Deprecated
Presentation getDefaultPresentation(ViewType viewType)

Deprecated. use presentationGetDefault(ViewType) instead

Gets the default Presentation for the specified viewType.





Parameters:
viewType - one of the static ViewType. Cannot be null.
Returns:
default Presentation for the specified viewType.





presentationGetDefault
Presentation presentationGetDefault(ViewType viewType)

Gets the default Presentation for the specified viewType.





Parameters:
viewType - one of the static ViewType. Cannot be null.
Returns:
default Presentation for the specified viewType.





getEditableView
@Deprecated
EditableView getEditableView(View view)
                             throws ViewOperationException

Deprecated. use viewEdit(View) instead

Gets an EditableView from a View. A view cannot be edited directly; first call this method, then make

 changes on the view, and then call ProcessServiceSession.storeView(View) to store the view.
 
 You could edit a view only if you are the owner or the view is not read only.





Parameters:
view - readable view. Cannot be null.
Returns:
Editable view if the view is readable; otherwise null.
Throws:
ViewOperationException - if the session could not get the editable view.





viewEdit
EditableView viewEdit(View view)
                      throws ViewOperationException

Gets an EditableView from a View. A view cannot be edited directly; first call this method, then make

 changes on the view, and then call ProcessServiceSession.viewStore(View) to store the view.
 
 You could edit a view only if you are the owner or the view is not read only.





Parameters:
view - readable view. Cannot be null.
Returns:
Editable view if the view is readable; otherwise null.
Throws:
ViewOperationException - if the session could not get the editable view.
See Also:
viewStore(View)





getGrabActivitiesForInstance
@Deprecated
Activity[] getGrabActivitiesForInstance(InstanceInfo instance)
                                        throws OperationException

Deprecated. use instanceGrabbableFrom(InstanceInfo) instead

Gets all the grab activities that can grab this instance.





Parameters:
instance - InstanceInfo to check. Cannot be null.
Returns:
Array of activities that can grab this instance, or a zero-length array if there are no grab activities.
Throws:
OperationException - if the session was unable to retrieve the activities.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              InstanceNotFoundException if the instance does not exist.
              





instanceGrabbableFrom
ActivityList instanceGrabbableFrom(String instanceId)
                                   throws OperationException

Gets all the grab activities that can grab this instance.





Parameters:
instanceId - Instance identification to check. Cannot be null.
Returns:
List of activities that can grab this instance, or a zero-length array if there are no grab activities.
Throws:
OperationException - if the session was unable to retrieve the activities.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              InstanceNotFoundException if the instance does not exist.
              





instanceGrabbableFrom
ActivityList instanceGrabbableFrom(InstanceInfo instance)
                                   throws OperationException

Gets all the grab activities that can grab this instance.





Parameters:
instance - InstanceInfo to check. Cannot be null.
Returns:
List of activities that can grab this instance, or a zero-length array if there are no grab activities.
Throws:
OperationException - if the session was unable to retrieve the activities.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              InstanceNotFoundException if the instance does not exist.
              





getHost
@Deprecated
String getHost()

Deprecated. use participantHost() instead

Returns the host where the owner of this session is connected from.






Returns:
the host where the owner of this session is connected from.





participantHost
String participantHost()

Returns the host where the owner of this session is connected from.






Returns:
the host where the owner of this session is connected from.





getInstance
@Deprecated
InstanceInfo getInstance(InstanceStamp stamp)
                         throws OperationException

Deprecated. use processGetInstance(String, String) instead

Gets the InstanceInfo specified by this InstanceStamp.
 This operation is NOT supported in a federated environment.





Parameters:
stamp - InstanceStamp, which contains the instanceId and activityName. Cannot be null.
Returns:
InstanceInfo specified by this instanceStamp.
Throws:
OperationException - if the session was unable to retrieve the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance in this instanceStamp could
              not be found.
              InstanceNotInActivityException if the instance in this instanceStamp
              is no longer in the specified Activity.
              





processGetInstance
InstanceInfo processGetInstance(String instanceId,
                                String activityName)
                                throws OperationException

Gets the InstanceInfo specified by this Instance identification and the activity where the instance
 is supposed to be.





Parameters:
instanceId - Instance identification of the required process instance.
activityName - Activity name where the instance is supposed to be.
Returns:
InstanceInfo specified by this instanceStamp.
Throws:
OperationException - if the session was unable to retrieve the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              InstanceNotInActivityException if the instance is no longer in the specified Activity.
              





getInstance
@Deprecated
InstanceInfo getInstance(String instanceId)
                         throws OperationException

Deprecated. use processGetInstance(String) instead

Gets the InstanceInfo specified by instanceId.





Parameters:
instanceId - Id of instance to retrieve. Cannot be null.
Returns:
InstanceInfo specified by instanceId.
Throws:
OperationException - if the session was unable to retrieve the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance in this instance Id could
              not be found.
              





processGetInstance
InstanceInfo processGetInstance(String instanceId)
                                throws OperationException

Gets the InstanceInfo specified by instanceId.





Parameters:
instanceId - Id of instance to retrieve. Cannot be null.
Returns:
InstanceInfo specified by instanceId.
Throws:
OperationException - if the session was unable to retrieve the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance in this instance Id could
              not be found.
              





getInstanceByCorrelation
@Deprecated
InstanceInfo getInstanceByCorrelation(String processId,
                                                 String correlationName,
                                                 Object[] correlationValues)
                                      throws OperationException

Deprecated. use processGetInstanceByCorrelation(String, String, Object[]) instead

Gets the instance specified by the process id, correlation name, and correlation values.
 
 Correlations are set during Argument Mapping in Studio. Unlike arguments, there is no way
 to retrieve the correlation name or values programmatically.





Parameters:
processId - id of process to check. Cannot be null.
correlationName - correlation name. Cannot be null.
correlationValues - correlation values.
Returns:
instance specified by the process id, correlation name, and correlation values.
Throws:
OperationException - if the session was unable to retrieve the the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process requested is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              





processGetInstanceByCorrelation
InstanceInfo processGetInstanceByCorrelation(String processId,
                                             String correlationName,
                                             Object[] correlationValues)
                                             throws OperationException

Gets the instance specified by the process id, correlation name, and correlation values.
 
 Correlations are set during Argument Mapping in Studio. Unlike arguments, there is no way
 to retrieve the correlation name or values programmatically.





Parameters:
processId - id of process to check. Cannot be null.
correlationName - correlation name. Cannot be null.
correlationValues - correlation values.
Returns:
instance specified by the process id, correlation name, and correlation values.
Throws:
OperationException - if the session was unable to retrieve the the instance.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process requested is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              





getInstanceData
@Deprecated
DynamicObject getInstanceData(String instanceId)
                              throws OperationException

Deprecated. use instanceGetData(String) instead

Gets the instance component associated with this instance.

 The instance component is the instance of the class generated during the deployment.





Parameters:
instanceId - instance to check. Cannot be null.
Returns:
DynamicObject containing instance component.
Throws:
OperationException - if the session was unable to retrieve the instance data.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process requested is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              





instanceGetData
DynamicObject instanceGetData(String instanceId)
                              throws OperationException

Gets the instance component associated with this instance identification.

 The instance component is the instance of the class generated during the deployment.





Parameters:
instanceId - Instance identification of the instance to check. Cannot be null.
Returns:
DynamicObject containing instance component.
Throws:
OperationException - if the session was unable to retrieve the instance data.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process requested is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              





instanceGetData
DynamicObject instanceGetData(InstanceInfo instance)
                              throws OperationException

Gets the instance component associated with this instance.

 The instance component is the instance of the class generated during the deployment.





Parameters:
instance - instance to check. Cannot be null.
Returns:
DynamicObject containing instance component.
Throws:
OperationException - if the session was unable to retrieve the instance data.

              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process requested is not available.
              ProcessControlNotAvailableException if the remote process is
              not available.
              InstanceNotFoundException if the instance could not be found.
              





getInstanceEvents
@Deprecated
InstanceEvent[] getInstanceEvents(String instanceId)
                                  throws OperationException


Deprecated. use instanceGetEvents(String) instead

Returns the InstanceEvents for the specified instanceId.


Parameters:

instanceId - instance Id to check. Cannot be null.

Returns:

InstanceEvents for the specified instanceId.

Throws:

OperationException - if the session was unable to retrieve the instance events.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

instanceGetEvents

InstanceEventList instanceGetEvents(String instanceId)
                                    throws OperationException

Returns the InstanceEvents for the specified instanceId.

Parameters:

instanceId - instance Id to check. Cannot be null.

Returns:

InstanceEvents for the specified instanceId.

Throws:

OperationException - if the session was unable to retrieve the instance events.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

instanceGetEvents

InstanceEventList instanceGetEvents(InstanceInfo instance)
                                    throws OperationException

Returns the InstanceEvents for the specified instance.

Parameters:

instance - instance to check. Cannot be null.

Returns:

InstanceEvents for the specified instanceId.

Throws:

OperationException - if the session was unable to retrieve the instance events.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

getInstanceNotes

@Deprecated
Note[] getInstanceNotes(String instanceId)
                        throws OperationException

Deprecated. use instanceGetNotes(String) instead

Gets all the Notes associated with the specified instance.

Parameters:

instanceId - Id of instance to check for notes. Cannot be null.

Returns:

array of Notes associated with the specified instance, or zero-length array if there are no Notes associated with this instance

Throws:

OperationException - if the session was unable to retrieve the instance notes.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

instanceGetNotes

NoteList instanceGetNotes(String instanceId)
                          throws OperationException

Gets all the Notes associated with the specified instance.

Parameters:

instanceId - Id of instance to check for notes. Cannot be null.

Returns:

array of Notes associated with the specified instance, or zero-length array if there are no Notes associated with this instance

Throws:

OperationException - if the session was unable to retrieve the instance notes.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

instanceGetNotes

NoteList instanceGetNotes(InstanceInfo instance)
                          throws OperationException

Gets all the Notes associated with the specified instance.

Parameters:

instance - Instance to check for notes. Cannot be null.

Returns:

array of Notes associated with the specified instance, or zero-length array if there are no Notes associated with this instance

Throws:

OperationException - if the session was unable to retrieve the instance notes.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance could not be found.

getInstances

@Deprecated
InstanceInfo[] getInstances(String processId)
                            throws OperationException

Deprecated. use processGetInstances(String) instead

Gets the InstanceInfos from the specified Process.

Parameters:

processId - process Id. Cannot be null.
If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get instances from all process versions.

Returns:

array of InstanceInfo from the specified Process, or zero-length array if there are no instances in the specified Process.

Throws:

OperationException - if the session was unable to retrieve the process instances.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.

processGetInstances

InstanceInfoList processGetInstances(String process)
                                     throws OperationException

Gets the InstanceInfos from the specified Process or Consolidated Process.

Parameters:

process - process id or consolidated process id. Cannot be null.
If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get instances from all process versions.

Returns:

array of InstanceInfo from the specified Process, or zero-length array if there are no instances in the specified Process.

Throws:

OperationException - if the session was unable to retrieve the process instances.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process requested is not available.
ProcessControlNotAvailableException if the remote process is not available.

getInstancesByFilter

@Deprecated
InstanceInfo[] getInstancesByFilter(String[] processIds,
                                               Filter filter)
                                    throws BatchOperationException

Deprecated. use processesGetInstancesByFilter(fuego.papi.collections.ProcessIdSet, Filter) instead

Gets InstanceInfos from the specified ProcessIds and match with the specified Filter.

Parameters:

processIds - process Ids. Cannot be null.

filter - Filter to restrict and order the instances returned. Cannot be null.

Returns:

array of InstanceInfo from the specified Processes and Filter, or zero-length array if there are no matching instances

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

FilterBatchOperationException if not all instances requested are available.
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

processesGetInstancesByFilter

InstanceInfoList processesGetInstancesByFilter(ProcessIdSet processes,
                                               Filter filter)
                                               throws BatchOperationException

Gets InstanceInfos from the specified ProcessIds and match with the specified Filter.

Ex.

     // Search instances which begin with a specific string in an external variable value and
     // stay in a specific activity.
     Filter filter = ProcessService.createFilter();
     filter.setSearchScope(ParticipantScope.ALL_IN_ROLE, StatusScope.INPROCESS);
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("MyExternalVariable"), Comparison.BEGIN_WITH, "Fuego");
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityName");

     ProcessIdSet processSet = ProcessIdSet.create();
     processSet.add(session.processesGetAllVersions("/OU/MyProcess"));

     // Search instances.
     InstanceInfo[] instances = session.getInstancesByFilter(processSet, filter);

Parameters:

processes - ProcessIdSet with all processes where the filter will be executed. Cannot be null.

filter - Filter to restrict and order the instances returned. Cannot be null.

Returns:

array of InstanceInfo from the specified Processes and Filter, or zero-length array if there are no matching instances

Throws:

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

FilterBatchOperationException if not all instances requested are available.
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

getInstancesByView

@Deprecated
InstanceInfo[] getInstancesByView(InstancesView view)
                                  throws OperationException,
                                         BatchOperationException

Deprecated. use viewGetInstances(InstancesView) instead

Gets the InstanceInfos from the specified instances view.

Ex.

     // Gets the view to obtain its instances
     InstancesView instancesView = (InstancesView) session.getView("MyInstancesViewId");

     // Search instances.
     InstanceInfo[] instances = session.getInstancesByView(instancesView);

Parameters:

view - View to retrieve instances from. Cannot be null.

Returns:

array of InstanceInfo from the specified view, or zero-length array if there are no instances in the specified View.

Throws:

OperationException - if the session was unable to retrieve the process instances.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if a process in the view is not available.
ProcessControlNotAvailableException if the remote process is not available.

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

FilterBatchOperationException if not all instances requested are available.
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

viewGetInstances

InstanceInfoList viewGetInstances(String viewId)
                                  throws OperationException,
                                         BatchOperationException

Gets the InstanceInfos from the specified instances view.

Ex.

     // Search instances.
     InstanceInfo[] instances = session.getInstancesByView("/MyViewId");

Parameters:

viewId - View Id to retrieve instances from. Cannot be null.

Returns:

array of InstanceInfo from the specified view, or zero-length array if there are no instances in the specified View.

Throws:

OperationException - if the session was unable to retrieve the process instances.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if a process in the view is not available.
ProcessControlNotAvailableException if the remote process is not available.

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

FilterBatchOperationException if not all instances requested are available.
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

viewGetInstances

InstanceInfoList viewGetInstances(InstancesView view)
                                  throws OperationException,
                                         BatchOperationException

Gets the InstanceInfos from the specified instances view.

Ex.

     // Gets the view to obtain its instances
     InstancesView instancesView = (InstancesView) session.getView("MyInstancesViewId");

     // Search instances.
     InstanceInfo[] instances = session.getInstancesByView(instancesView);

Parameters:

view - View to retrieve instances from. Cannot be null.

Returns:

array of InstanceInfo from the specified view, or zero-length array if there are no instances in the specified View.

Throws:

OperationException - if the session was unable to retrieve the process instances.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if a process in the view is not available.
ProcessControlNotAvailableException if the remote process is not available.

BatchOperationException - if the session could not perform the operation over every process.
May be one of the following subclasses of BatchOperationException:

FilterBatchOperationException if not all instances requested are available.
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

setLocale

@Deprecated
void setLocale(Locale locale)
               throws OperationException

Deprecated. use participantUpdateLocale(Locale) instead

Sets the locale for this session for receiving messages from PAPI.

Parameters:: locale - for receiving messages from PAPI. Cannot be null.
Throws:: OperationException - if the session was unable to set the new locale.

participantUpdateLocale

void participantUpdateLocale(Locale locale)
                             throws OperationException

Updates the current participant locale and stores it.

Parameters:: locale - new participant locale;
Throws:: OperationException - if the session could not perform the operation

getLocale

@Deprecated
Locale getLocale()

Deprecated. use participantLocale() instead

Gets the Locale for this session.

Returns:: Locale for this session.

participantLocale

Locale participantLocale()
                         throws OperationException

Returns the current participant Locale.

Returns:: the current participant locale;
Throws:: OperationException - if the session could not perform the operation

getNote

@Deprecated
Note getNote(String noteId)
             throws OperationException

Deprecated. use noteGet(String) instead

Gets the Note specified by this noteId.

Parameters:

noteId - Id of the note to retrieve. Cannot be null.

Returns:

Note specified by this noteId.

Throws:

OperationException - if the session was unable to retrieve the note.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

noteGet

Note noteGet(String noteId)
             throws OperationException

Gets the Note specified by this noteId.

Parameters:

noteId - Id of the note to retrieve. Cannot be null.

Returns:

Note specified by this noteId.

Throws:

OperationException - if the session was unable to retrieve the note.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

isOpened

boolean isOpened()

Returns true if this session is open.

Returns:: true if this session is open.
See Also:: close()

organization

String organization()

Gets the organization name. This operation is NOT supported in a federated environment.

Returns:: organization name.

organizations

fuego.collections.lists.StringList organizations()

Gets all organization names which the Session is connected to.

Returns:: organization names.

getOrganization

@Deprecated
String getOrganization()

Deprecated. use organization() instead

Gets the organization name.

Returns:: organization name.

getParentView

@Deprecated
View getParentView(View view)
                   throws OperationException

Deprecated. use viewGetParent(String) instead

Gets the parent View of the specified View.

Parameters:

view - child view. Cannot be null.

Returns:

parent View of the specified view, or null if the specified view does not have a parent.

Throws:

OperationException - if the session was unable to retrieve the parent view.
May be one of the following subclasses of OperationException:

ViewOperationException if was unable tor retrieve the parent view.

viewGetParent

View viewGetParent(String viewId)
                   throws OperationException

Gets the parent View of the specified View.

Parameters:

viewId - View Id of the child view. Cannot be null.

Returns:

parent View of the specified view, or null if the specified view does not have a parent.

Throws:

OperationException - if the session was unable to retrieve the parent view.
May be one of the following subclasses of OperationException:

ViewOperationException if was unable tor retrieve the parent view.

viewGetParent

View viewGetParent(View view)
                   throws OperationException

Gets the parent View of the specified View.

Parameters:

view - child view. Cannot be null.

Returns:

parent View of the specified view, or null if the specified view does not have a parent.

Throws:

OperationException - if the session was unable to retrieve the parent view.
May be one of the following subclasses of OperationException:

ViewOperationException if was unable tor retrieve the parent view.

getParentViewId

@Deprecated
String getParentViewId(String viewId)

Deprecated. use View.getParentId() instead.

Gets the parent id of the specified view. null if the view does not have parent.

Parameters:: viewId - Id of the view to obtain its parent id.
Returns:: the parent view id of the specified view or null if the view does not have parent.

viewGetParentId

String viewGetParentId(String viewId)

Gets the parent id of the specified view. null if the view does not have parent.

Parameters:: viewId - Id of the view to obtain its parent id.
Returns:: the parent view id of the specified view or null if the view does not have parent.
See Also:: View.getParentId()

getParticipant

@Deprecated
Participant getParticipant()

Deprecated. use participantCurrent() instead

Gets the Participant for this session.

Returns:: Participant for this session.

participantCurrent

Participant participantCurrent()

Gets the Participant for this session.

Returns:: Participant for this session.

getParticipant

@Deprecated
Participant getParticipant(String uid)
                           throws OperationException

Deprecated. use participantFind(String) instead

Gets the Participant specified by participantUid.

Parameters:

uid - Uid of participant. Cannot be null.

Returns:

Participant specified by participantUid.

Throws:

OperationException - if the session was unable to retrieve the participant.
May be one of the following subclasses of OperationException:

ParticipantException if was unable to retrieve the participant.
ParticipantNotFoundException if the participant does not exit.

participantFind

Participant participantFind(String uid)
                            throws OperationException

Gets the Participant specified by participantUid.

Parameters:

uid - Uid of participant. Cannot be null.

Returns:

Participant specified by participantUid.

Throws:

OperationException - if the session was unable to retrieve the participant.
May be one of the following subclasses of OperationException:

ParticipantException if was unable to retrieve the participant.
ParticipantNotFoundException if the participant does not exit.

getPresentation

@Deprecated
Presentation getPresentation(String presentationId)

Deprecated. use presentationGet(String) instead

Gets the Presentation specified by this presentationId.

Parameters:: presentationId - Presentation Id. Cannot be null.
Returns:: Presentation specified by presentationId.

presentationGet

Presentation presentationGet(String presentationId)

Gets the Presentation specified by this presentationId.

Parameters:: presentationId - Presentation Id. Cannot be null.
Returns:: Presentation specified by presentationId.

getPresentation

@Deprecated
Presentation getPresentation(PresentationType presentationType,
                                        String presentationId)
                             throws OperationException

Deprecated. use presentationGet(PresentationType, String) instead

Gets the Presentation for the specified PresentationType and presentationId.

If presentationId is "default", returns the default presentation for presentationType.

Parameters:

presentationType - one of the static PresentationTypes. Cannot be null.

presentationId - Id of presentation to retrieve. Cannot be null.

Returns:

Presentation specified by presentationType and presentationId.

Throws:

OperationException - if the session was unable to retrieve the presentation.
May be one of the following subclasses of OperationException:

PresentationNotFoundException if the presentation does not exist.

presentationGet

Presentation presentationGet(PresentationType presentationType,
                             String presentationId)
                             throws OperationException

Gets the Presentation for the specified PresentationType and presentationId.

If presentationId is "default", returns the default presentation for presentationType.

Parameters:

presentationType - one of the static PresentationTypes. Cannot be null.

presentationId - Id of presentation to retrieve. Cannot be null.

Returns:

Presentation specified by presentationType and presentationId.

Throws:

OperationException - if the session was unable to retrieve the presentation.
May be one of the following subclasses of OperationException:

PresentationNotFoundException if the presentation does not exist.

getPresentation

@Deprecated
Presentation getPresentation(ViewType viewType,
                                        String presentationId)
                             throws OperationException

Deprecated. use presentationGet(ViewType, String) instead

Gets the Presentation for the specified ViewType and presentationId.

If presentationId is "default", returns the default presentation for presentationType.

Parameters:

viewType - one of the static ViewTypes. Cannot be null.

presentationId - Id of presentation to retrieve. Cannot be null.

Returns:

Presentation specified by presentationType and presentationId.

Throws:

OperationException - if the session was unable to retrieve the presentation.
May be one of the following subclasses of OperationException:

PresentationNotFoundException if the presentation does not exist.

presentationGet

Presentation presentationGet(ViewType viewType,
                             String presentationId)
                             throws OperationException

Gets the Presentation for the specified ViewType and presentationId.

If presentationId is "default", returns the default presentation for presentationType.

Parameters:

viewType - one of the static ViewTypes. Cannot be null.

presentationId - Id of presentation to retrieve. Cannot be null.

Returns:

Presentation specified by presentationType and presentationId.

Throws:

OperationException - if the session was unable to retrieve the presentation.
May be one of the following subclasses of OperationException:

PresentationNotFoundException if the presentation does not exist.

getPresentationIds

@Deprecated
String[] getPresentationIds(PresentationType presentationType)
                            throws OperationException

Deprecated. use presentationsGetIds(PresentationType) instead

Gets all the presentationIds for the specified PresentationType.

Parameters:: presentationType - one of the static PresentationTypes. Cannot be null.
Returns:: array of presentationIds.
Throws:: OperationException - if the session was unable to retrieve the presentations.

presentationsGetIds

fuego.collections.lists.StringList presentationsGetIds(PresentationType presentationType)
                                                       throws OperationException

Gets all the presentationIds for the specified PresentationType.

Parameters:: presentationType - one of the static PresentationTypes. Cannot be null.
Returns:: array of presentationIds.
Throws:: OperationException - if the session was unable to retrieve the presentations.

getProcess

@Deprecated
Process getProcess(int processIn)

Deprecated. use processGet(int) instead. 'In' is not a valid identifier in all environments. Use process id instead.

Gets the Process for this process identification number.

Parameters:: processIn - process identification number.
Returns:: Process specified by processIn.

processGet

@Deprecated
Process processGet(int processIn)

Deprecated. 'In' is not a valid identifier in all environments. Use process id instead.

Gets the Process for this process identification number. This operation is NOT supported in a federated environment.

Parameters:: processIn - process identification number.
Returns:: Process specified by processIn.

getProcess

@Deprecated
Process getProcess(String processId)
                   throws OperationException

Deprecated. use processGet(String) instead

Returns a Process object for the specified process identification or for the active process if you use the consolidated process id.

Parameters:: processId - Process identification or Consolidated process identification for the active process. Note: It must not be a null value.
Returns:: a Process object
Throws:: ProcessNotAvailableException - the process can't be reached; NullPointerException - if processId is null.; OperationException
See Also:: Process

processGet

Process processGet(String processId)
                   throws OperationException

Returns a Process object for the specified process identification or for the active process if you use the consolidated process id.

Parameters:: processId - Process identification or Consolidated process identification for the active process. Note: It must not be a null value.
Returns:: a Process object
Throws:: ProcessNotAvailableException - the process can't be reached; NullPointerException - if processId is null.; OperationException
See Also:: Process

getProcessDiagram

@Deprecated
ProcessDiagram getProcessDiagram(String processId)
                                 throws OperationException

Deprecated. use processGetDiagram(String) instead

Gets the ProcessDiagram for the specified processId.

Parameters:

processId - Id of the process for this ProcessDiagram. Cannot be null. If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get the active process from this consolidated id.

Returns:

ProcessDiagram

Throws:

OperationException - if the session was unable to retrieve the process diagram.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

getProcessDiagram

@Deprecated
ProcessDiagram getProcessDiagram(int processIn)
                                 throws OperationException

Deprecated. use processGetDiagram(Process) instead

Gets the ProcessDiagram for the specified process by process identification number. This operation is NOT supported in a federated environment.

Parameters:

processIn - process identification number.

Returns:

ProcessDiagram

Throws:

OperationException - if the session was unable to retrieve the process diagram.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

getProcessDiagram

@Deprecated
ProcessDiagram getProcessDiagram(Process process)
                                 throws OperationException

Deprecated. use processGetDiagram(Process) instead

Gets the ProcessDiagram for the specified Process.

Parameters:

process - Process. Cannot be null.

Returns:

ProcessDiagram

Throws:

OperationException - if the session was unable to retrieve the process diagram.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

See Also:

ProcessDiagram

processGetDiagram

ProcessDiagram processGetDiagram(String processId)
                                 throws OperationException

Gets the ProcessDiagram for the specified processId.

Parameters:

Returns:

ProcessDiagram

Throws:

OperationException - if the session was unable to retrieve the process diagram.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

See Also:

ProcessDiagram

processGetDiagram

ProcessDiagram processGetDiagram(Process process)
                                 throws OperationException

Gets the ProcessDiagram for the specified process.

Parameters:

process - the process for this ProcessDiagram. Cannot be null.

Returns:

ProcessDiagram

Throws:

OperationException - if the session was unable to retrieve the process diagram.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

See Also:

ProcessDiagram

getProcessDocumentation

@Deprecated
String getProcessDocumentation(String processId,
                                          Locale locale)
                               throws OperationException

Deprecated. use processGetDocumentation(String, Locale) instead

Gets the local path of the process documentation, created in Studio, for the specified locale.

The process documentation is retrieved from the engine and stored in the returned path, along with the images used by the documentation. The HTML file is always stored using UTF-8 encoding.

Parameters:

processId - Id of the process to check. Cannot be null.

locale - of the requested documentation. Cannot be null.

Returns:

local path of the process documentation for the specified locale, or null if there is no documentation for the specified locale.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

processGetDocumentation

String processGetDocumentation(String processId,
                               Locale locale)
                               throws OperationException

Gets the local path of the process documentation, created in Studio, for the specified locale.

The process documentation is retrieved from the engine and stored in the returned path, along with the images used by the documentation. The HTML file is always stored using UTF-8 encoding.

Parameters:

processId - Id of the process to check. Cannot be null.

locale - of the requested documentation. Cannot be null.

Returns:

local path of the process documentation for the specified locale, or null if there is no documentation for the specified locale.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.

getProcessId

@Deprecated
String getProcessId(InstanceInfo instance)

Deprecated. use instanceGetProcessId(InstanceInfo) instead

Gets the processId from the specified instanceInfo.

Parameters:: instance - InstanceInfo to check. Cannot be null.
Returns:: processId from the specified instanceInfo.

instanceGetProcessId

String instanceGetProcessId(InstanceInfo instance)

Gets the processId from the specified instanceInfo.

Parameters:: instance - InstanceInfo to check. Cannot be null.
Returns:: processId from the specified instanceInfo.

instanceGetProcessId

String instanceGetProcessId(String instanceId)

Gets the processId for the specified InstanceId.

Parameters:: instanceId - InstanceId to check. Cannot be null.
Returns:: processId for the specified InstanceId.

instanceGetVariable

Object instanceGetVariable(InstanceInfo instance,
                           String variableId)

Returns the value of the variable in the given instance.

Parameters:: instance - The instance to obtain the variable value.; variableId - The variable identification to obtain its value in the given instance.
Returns:: The value of the given variable in the given instance.

instanceGetVariable

Object instanceGetVariable(String instanceId,
                           String variableId)

Returns the value of the variable in the given instance.

Parameters:: instanceId - The instanceId of the instance to obtain the variable value.; variableId - The variable identification to obtain its value in the given instance.
Returns:: The value of the given variable in the given instance.

getProcessId

@Deprecated
String getProcessId(int processIn)
                    throws ProcessNotAvailableException

Deprecated. use processGetId(int) instead

Gets the processId from the specified process identification number.

Parameters:: processIn - process identification number
Returns:: processId from the specified process identification number.
Throws:: ProcessNotAvailableException - if the process is not available.

processGetId

String processGetId(int processIn)
                    throws ProcessNotAvailableException

Gets the processId from the specified process identification number. This operation is NOT supported in a federated environment.

Parameters:: processIn - process identification number
Returns:: processId from the specified process identification number.
Throws:: ProcessNotAvailableException - if the process is not available.

getProcessIds

@Deprecated
String[] getProcessIds()

Deprecated. use processesGetIds() instead

Gets the Ids of all deployed processes (Active and Deprecated versions) for this session.

Returns:: Ids of all deployed processes (Active and Deprecated versions) for this session.

processesGetIds

fuego.collections.lists.StringList processesGetIds()

Gets the Ids of all deployed processes (Active and Deprecated versions) for this session.

Returns:: Ids of all deployed processes (Active and Deprecated versions) for this session.

getProcessIds

@Deprecated
String[] getProcessIds(boolean onlyActiveProcess)

Deprecated. use processesGetIds(boolean) instead

Gets the Ids of all deployed processes for this session, and optionally only active processes.

Parameters:: onlyActiveProcess - if true, then only active processes. If false, then active and deprecated processes.
Returns:: Ids of all deployed processes for this session, and optionally only active processes.

processesGetIds

fuego.collections.lists.StringList processesGetIds(boolean onlyActiveProcess)

Gets the Ids of all deployed processes for this session, and optionally only active processes.

Parameters:: onlyActiveProcess - if true, then only active processes. If false, then active and deprecated processes.
Returns:: Ids of all deployed processes for this session, and optionally only active processes.

getProcessImage

@Deprecated
String getProcessImage(String processId)

Deprecated. use processGetDiagram(Process) instead

Gets the process image in XML format for the specified processId.

Parameters:: processId - Id of the process for this process image
Returns:: process image in XML format for the specified processId.

getProcessIn

@Deprecated
int getProcessIn(String processId)
                 throws ProcessNotAvailableException

Deprecated. 'In' is not a valid identifier in all environments.

Gets the process identification number for this processId.

Parameters:: processId - process Id. Cannot be null.
Returns:: process identification number for this processId.
Throws:: ProcessNotAvailableException - if the process is not available.

processGetIn

@Deprecated
int processGetIn(String processId)
                 throws ProcessNotAvailableException

Deprecated. 'In' is not a valid identifier in all environments.

Gets the process identification number for this processId. This operation is NOT supported in a federated environment.

Parameters:: processId - process Id. Cannot be null.
Returns:: process identification number for this processId.
Throws:: ProcessNotAvailableException - if the process is not available.

getProcesses

@Deprecated
Process[] getProcesses(boolean force)
                       throws BatchOperationException

Deprecated. use processesGet(boolean) instead

Gets all deployed Processes for the session.

Parameters:

force - true to return all processes. And false to return only loaded process and do not throw exceptions if the load process failed.

Returns:

Array of deployed Processes.

Throws:

BatchOperationException - if not all deployed processes are available.
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all processes available.
You can find inside the batch exception:
- ProcessNotAvailableException if a process is not available.

processesGet

ProcessList processesGet(boolean force)
                         throws BatchOperationException

Gets all deployed Processes for the session.

Parameters:

force - true to return all processes. And false to return only loaded process and do not throw exceptions if the load process failed.

Returns:

Array of deployed Processes.

Throws:

BatchOperationException - if not all deployed processes are available.
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all processes available.
You can find inside the batch exception:
- ProcessNotAvailableException if a process is not available.

getProcesses

@Deprecated
Process[] getProcesses(boolean onlyActiveProcess,
                                  boolean force)
                       throws BatchOperationException

Deprecated. use processesGet(boolean, boolean) instead

Gets all deployed Processes for the session.

Parameters:

onlyActiveProcess - true gets only active processes. false gets active and deprecated processes.

force - true returns all processes, and throw exceptions if the load process failed. false returns only loaded process and do not throw exceptions if the load process failed.

Returns:

all deployed Processes.

Throws:

BatchOperationException - if not all deployed processes are available.
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all processes available.
You can find inside the batch exception:
- ProcessNotAvailableException if a process is not available.

processesGet

ProcessList processesGet(boolean onlyActiveProcess,
                         boolean force)
                         throws BatchOperationException

Gets all deployed Processes for the session.

Parameters:

onlyActiveProcess - true gets only active processes. false gets active and deprecated processes.

force - true returns all processes, and throw exceptions if the load process failed. false returns only loaded process and do not throw exceptions if the load process failed.

Returns:

all deployed Processes.

Throws:

BatchOperationException - if not all deployed processes are available.
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all processes available.
You can find inside the batch exception:
- ProcessNotAvailableException if a process is not available.

setTimeZone

@Deprecated
void setTimeZone(TimeZone timezone)

Deprecated. use participantUpdateTimeZone(TimeZone) instead

Sets the TimeZone.

Parameters:: timezone - new TimeZone.

participantUpdateTimeZone

void participantUpdateTimeZone(TimeZone timezone)
                               throws OperationException

Updates the current participant time zone and stores it.

Parameters:: timezone - new participant time zone;
Throws:: OperationException - if the session could not perform the operation

getTimeZone

@Deprecated
TimeZone getTimeZone()

Deprecated. use participantTimeZone() instead

Gets the TimeZone for this session.

Returns:: TimeZone for this session.

participantTimeZone

TimeZone participantTimeZone()
                             throws OperationException

Gets the TimeZone for the current participant.

Returns:: TimeZone for this session.
Throws:: OperationException - if the session could not perform the operation.

getVar

@Deprecated
VarDefinition getVar(String variableId)

Deprecated. use variableGet(String) instead

Gets a VarDefinition from the loaded processes in this session.

Parameters:: variableId - Id of VarDefinition associated with a Process.
Returns:: VarDefinition from the loaded processes in this session, or null if there is no matching VarDefinition.

variableGet

VarDefinition variableGet(String variableId)

Gets a VarDefinition from the loaded processes in this session.

Parameters:: variableId - Id of VarDefinition associated with a Process.
Returns:: VarDefinition from the loaded processes in this session, or null if there is no matching VarDefinition.

getVars

@Deprecated
VarDefinition[] getVars()

Deprecated. use variablesGet() instead

Returns all the variable definitions from all the processes in this session.

Returns:: all the variable definitions from all the processes in this session.

variablesGet

VarDefinitionList variablesGet()

Returns all the variable definitions from all the processes in this session.

Returns:: all the variable definitions from all the processes in this session.

getView

@Deprecated
View getView(String viewId)
             throws OperationException

Deprecated. use viewGet(String) instead

Returns the View specified by viewId.

Parameters:

viewId - view Id. Cannot be null. To retrieve the default inbox view, use View.INBOX_DEFAULT_ID

Returns:

the View specified by viewId.

Throws:

OperationException - if the session could not retreive the view.
May be one of the following subclasses of OperationException:

ViewNotFoundException if the view does not exist.

viewGet

View viewGet(String viewId)
             throws OperationException

Returns the View specified by viewId.

Parameters:

viewId - view Id. Cannot be null. To retrieve the default inbox view, use View.INBOX_DEFAULT_ID

Returns:

the View specified by viewId.

Throws:

OperationException - if the session could not retreive the view.
May be one of the following subclasses of OperationException:

ViewNotFoundException if the view does not exist.

getViewIds

@Deprecated
String[] getViewIds()
                    throws OperationException,
                           BatchOperationException

Deprecated. use viewsGetIds() instead

Gets all the viewIds available to the current participant.

Returns:: Array of viewIds available to the current participant, or a zero-length array if no processes were found for this session.
Throws:: OperationException - if the session could not perform the operation.; BatchOperationException - if the session could not retrieve all view ids.

viewsGetIds

fuego.collections.lists.StringList viewsGetIds()
                                               throws OperationException,
                                                      BatchOperationException

Gets all the viewIds available to the current participant.

Returns:: Array of viewIds available to the current participant, or a zero-length array if no processes were found for this session.
Throws:: OperationException - if the session could not perform the operation.; BatchOperationException - if the session could not retrieve all view ids.

getVisibleActivities

@Deprecated
String[] getVisibleActivities(String processId)
                              throws OperationException

Deprecated. use processGetVisibleActivities(String) instead

Gets all the activities visible to the current participant in the specified process.

Parameters:

processId - the process to search for visible activities. Cannot be null. If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get the active process from this consolidated id.

Returns:

array of activityIds

Throws:

OperationException - if the session could not retrieve the activities.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

processGetVisibleActivities

ActivityList processGetVisibleActivities(String processId)
                                         throws OperationException

Gets all the activities visible to the current participant in the specified process.

Parameters:

Returns:

array of activityIds

Throws:

OperationException - if the session could not retrieve the activities.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

getWorkingAttachments

@Deprecated
Attachment[] getWorkingAttachments(String processId)
                                   throws OperationException

Deprecated. use processGetWorkingAttachments(String) instead

Returns all Attachments locked by the current participant in the specified process.

Parameters:

processId - Id of process to check for locked attachments. Cannot be null.

Returns:

array of locked Attachments

Throws:

OperationException - if the session could not retrieve the working attachemnts.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

processGetWorkingAttachments

AttachmentList processGetWorkingAttachments(String processId)
                                            throws OperationException

Returns all Attachments locked by the current participant in the specified process.

Parameters:

processId - Id of process to check for locked attachments. Cannot be null.

Returns:

array of locked Attachments

Throws:

OperationException - if the session could not retrieve the working attachemnts.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.

close

void close()

Closes the session.

For reuse this session you need recreate it.

createPresentation

@Deprecated
Presentation createPresentation(PresentationType presentationType,
                                           String id,
                                           Presentation.Column[] columns)
                                throws ViewOperationException

Deprecated. use presentationCreate(PresentationType, String, Presentation.Column[]) instead

Creates a Presentation.

Parameters:: presentationType - one of the static PresentationType.; id - presentation id. Cannot be null or contain any of the characters listed in ProcessService.invalidIdCharacters().; columns - array of Presentation.Column listing the columns to display. Cannot be null.
Returns:: new presentation. Note that the presentation has to be stored before it can be retrieved using getPresentation(String).
Throws:: ViewOperationException - if the session could not craete the presentation.

presentationCreate

Presentation presentationCreate(PresentationType presentationType,
                                String id,
                                Presentation.Column[] columns)
                                throws ViewOperationException

Creates a Presentation.

Parameters:: presentationType - one of the static PresentationType.; id - presentation id. Cannot be null or contain any of the characters listed in ProcessService.invalidIdCharacters().; columns - array of Presentation.Column listing the columns to display. Cannot be null.
Returns:: new presentation. Note that the presentation has to be stored before it can be retrieved using getPresentation(String).
Throws:: ViewOperationException - if the session could not craete the presentation.

presentationEdit

EditablePresentation presentationEdit(Presentation presentation)
                                      throws ViewOperationException

Gets an EditablePresentation from a Presentation. A presntation cannot be edited directly;
first call this method, then make changes on the presentation,
and then call ProcessServiceSession.presentationStore(Presentation) to store the presentation.

You could edit a view only if you are the owner or the view is not read only.

Parameters:: presentation - readable presentation. Cannot be null.
Returns:: Editable presentation if the presentation is readable; otherwise null.
Throws:: ViewOperationException - if the session could not get the editable presentation.
See Also:: presentationStore(Presentation)

createProcessInstance

@Deprecated
InstanceInfo createProcessInstance(String targetProcessId,
                                              Arguments arguments)
                                   throws OperationException

Deprecated. use processCreateInstance(String, Arguments) instead

Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process.

Parameters:

targetProcessId - id of process to create the instance in. If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get the active process from this consolidated id.

arguments - arguments defined in the Begin activity of the process specified by targetProcessId. Get the arguments by calling Process.getArgumentSets().

Returns:

Newly created process instance.

Throws:

OperationException - if the session could not create the new instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ParticipantNotInRoleException if the participant does not have roles in the process.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

processCreateInstance

InstanceInfo processCreateInstance(String targetProcessId,
                                   Arguments arguments)
                                   throws OperationException

Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process.

Ex.

       String                participantId = "myAlias";
       String                password = "myPassword";

       ProcessService        service = ProcessService.create(new java.util.Properties());

       ConnectionPassport    passport = service.createPassport(participantId);
       passport.setPassword(password);
       passport.fillPassport();

       ProcessServiceSession session = service.createSession(passport, "localhost");

       String                processId = "MyProcessId";

       String argumentName = "MyArgument";
       Object argumentValue = new Object();

       Arguments arguments = Arguments.create();
       arguments.putArgument(argumentName, argumentValue);

       session.createProcessInstance(processId, arguments);

Parameters:

arguments - arguments defined in the Begin activity of the process specified by targetProcessId. Get the arguments by calling Process.getArgumentSets().

Returns:

Newly created process instance.

Throws:

OperationException - if the session could not create the new instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ParticipantNotInRoleException if the participant does not have roles in the process.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

createProcessInstance

@Deprecated
InstanceInfo createProcessInstance(String targetProcessId,
                                              String argumentsSetName,
                                              Arguments arguments)
                                   throws OperationException

Deprecated. use processCreateInstance(String, String, Arguments) instead

Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process with the specified argument set name.

Ex.

       String                participantId = "myAlias";
       String                password = "myPassword";

       ProcessService        service = ProcessService.create(new java.util.Properties());

       ConnectionPassport    passport = service.createPassport(participantId);
       passport.setPassword(password);
       passport.fillPassport();

       ProcessServiceSession session = service.createSession(passport, "localhost");

       String                processId = "MyProcessId";
       String                argumentsSet = "BeginIn";

       String argumentName = "MyArgument";
       Object argumentValue = new Object();

       Arguments arguments = Arguments.create();
       arguments.putArgument(argumentName, argumentValue);

       session.createProcessInstance(processId, argumentsSet, arguments);

Parameters:

targetProcessId - Id of process to create the instance in. If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get the active process from this consolidated id.

argumentsSetName - name of argument set defined in the Begin activity of the process specified by targetProcessId.

arguments - arguments defined in the Begin activity of the process specified by targetProcessId. Get the arguments by calling Process.getArgumentSets().

Returns:

Newly created process instance.

Throws:

OperationException - if the session could not create the new instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ParticipantNotInRoleException if the participant does not have roles in the process.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

processCreateInstance

InstanceInfo processCreateInstance(String targetProcessId,
                                   String argumentsSetName,
                                   Arguments arguments)
                                   throws OperationException

Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process with the specified argument set name.

Ex.

       String                participantId = "myAlias";
       String                password = "myPassword";

       ProcessService        service = ProcessService.create(new java.util.Properties());

       ConnectionPassport    passport = service.createPassport(participantId);
       passport.setPassword(password);
       passport.fillPassport();

       ProcessServiceSession session = service.createSession(passport, "localhost");

       String                processId = "MyProcessId";
       String                argumentsSet = "BeginIn";

       String argumentName = "MyArgument";
       Object argumentValue = new Object();

       Arguments arguments = Arguments.create();
       arguments.putArgument(argumentName, argumentValue);

       session.createProcessInstance(processId, argumentsSet, arguments);

Parameters:

argumentsSetName - name of argument set defined in the Begin activity of the process specified by targetProcessId.

arguments - arguments defined in the Begin activity of the process specified by targetProcessId. Get the arguments by calling Process.getArgumentSets().

Returns:

Newly created process instance.

Throws:

OperationException - if the session could not create the new instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ParticipantNotInRoleException if the participant does not have roles in the process.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

processCreateInstance

InstanceInfo processCreateInstance(String targetProcessId,
                                   String argumentsSetName,
                                   Arguments arguments,
                                   String name,
                                   String description,
                                   String remarks,
                                   File file,
                                   String contentType,
                                   Locale locale)
                                   throws OperationException,
                                          IOException

Throws:: OperationException; IOException

processCreateInstance

InstanceInfo processCreateInstance(String targetProcessId,
                                   String argumentsSetName,
                                   Arguments arguments,
                                   String name,
                                   String description,
                                   String remarks,
                                   File file,
                                   String contentType,
                                   Locale locale,
                                   AttachmentStorageType storageType)
                                   throws OperationException,
                                          IOException

Throws:: OperationException; IOException

createView

@Deprecated
EditableView createView(ViewType viewType,
                                   String viewId,
                                   String[] assignedProcesses)
                        throws OperationException

Deprecated. use viewCreate(ViewType, String, String[]) instead

Creates an EditableView.

If the viewType is ViewType.APPLICATIONS, an EditableApplicationsView will be created.
If the viewType is ViewType.ATTACHMENTS, an EditableAttachmentsView will be created.
If the viewType is ViewType.INSTANCES an EditableInstancesView will be created.
If the viewType is not one of the specified ViewTypes, throws a InvalidViewTypeException.

Before calling this method, check that the viewId does not contain any of the characters in ProcessService.invalidIdCharacters().
Note that the created view cannot be retrieved by its viewId until storeView(View) is called.

Parameters:: viewType - one of the static ViewType.; viewId - view Id. Cannot be null. Check that the view Id does not contain any of the characters in ProcessService.invalidIdCharacters().; assignedProcesses - ids of processes to assign to this view. Cannot be null.
Returns:: EditableView of type EditableApplicationsView, EditableAttachmentsView or EditableInstancesView, depending on the viewType.
Throws:: OperationException - if the session could not create the editable view.

viewCreate

EditableView viewCreate(ViewType viewType,
                        String viewId,
                        String[] assignedProcesses)
                        throws OperationException

Creates an EditableView.

Parameters:: viewType - one of the static ViewType.; viewId - view Id. Cannot be null. Check that the view Id does not contain any of the characters in ProcessService.invalidIdCharacters().; assignedProcesses - ids of processes to assign to this view. Cannot be null.
Returns:: EditableView of type EditableApplicationsView, EditableAttachmentsView or EditableInstancesView, depending on the viewType.
Throws:: OperationException - if the session could not create the editable view.
See Also:: ProcessService.invalidIdCharacters(), View.getAssignedProcesses(), storeView(View)

viewRefresh

View viewRefresh(String viewId)
                 throws OperationException

Forces the reload of the specified View.

Parameters:: viewId - Id of the view to reload. Cannot be null.
Returns:: the view refreshed.
Throws:: OperationException - if the session could not refresh the view.

presentationRefresh

Presentation presentationRefresh(String presentationId)
                                 throws OperationException

Forces the reload of the specified Presentation.

Parameters:: presentationId - Id of the presentation to reload. Cannot be null.
Returns:: the presentation refreshed.
Throws:: OperationException - if the session could not refresh the presentation.

customRunGlobalActivity

@Deprecated
GlobalExecution customRunGlobalActivity(String activityId,
                                                   Arguments arguments)
                                        throws OperationException

Deprecated. use activityPostApplication(String, String, Arguments) instead

Runs a global activity and returns a GlobalExecution to complete the activity.
customRunGlobalActivity can have user interaction, whereas runGlobalActivity cannot.

Parameters:

activityId - id of the Global activity. Cannot be null.
Use getGlobalActivities to get an array of Global Activities.

Returns:

GlobalExecution to continue the execution.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityPostApplication

GlobalExecution activityPostApplication(String activityName,
                                        String processId,
                                        Arguments arguments)
                                        throws OperationException

Runs a global activity and returns a GlobalExecution to complete the activity.
activityPostApplication can have user interaction, whereas runGlobalActivity cannot.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     String targetProcess = "/OU/MyProcessName";
     String targetActivityName = "MyGlobalActivity";

     // Execute the activity.
     GlobalExecution execution = session.activityPostApplication(targetActivityName, targetProcess, arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

     // Get instance info created
     InstanceInfo instance = execution.getReturnValue();

Parameters:

activityName - The name of the Global activity to execute. Cannot be null.
Use getGlobalActivities to get an array of Global Activities.

processId - The id of the process where the activity is.
If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will runs over the active process versions.

Returns:

GlobalExecution to continue the execution.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityPostApplication

GlobalExecution activityPostApplication(Activity activity,
                                        Arguments arguments)
                                        throws OperationException

Runs a global activity and returns a GlobalExecution to complete the activity.
activityPostApplication can have user interaction, whereas runGlobalActivity cannot.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     String targetProcess = "/OU/MyProcessName";
     String targetActivityName = "MyGlobalActivity";

     // Get the active process.
     Process process = session.processGet(targetProcess);

     Activity activity = process.getActivity(targetActivityName);

     // Execute the activity.
     GlobalExecution execution = session.activityPostApplication(activity, arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

     // Get instance info created
     InstanceInfo instance = execution.getReturnValue();

Parameters:

activity - The name of the Global activity to execute. Cannot be null.
Use getGlobalActivities to get an array of Global Activities.

Returns:

GlobalExecution to continue the execution.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

hasNewInstances

@Deprecated
boolean hasNewInstances(String viewId)

Deprecated. use viewHasNewInstances(String) instead

Returns true if this view has new instances since the last access.

Parameters:: viewId - id of the view to check for new instances.
Returns:: true if this view has new instances.

viewHasNewInstances

boolean viewHasNewInstances(String viewId)

Returns true if this view has new instances since the last access.

Parameters:: viewId - id of the view to check for new instances.
Returns:: true if this view has new instances.

hasNewInstances

@Deprecated
boolean hasNewInstances()
                        throws OperationException

Deprecated. Use #viewsHaveNewInstances instead.

Returns true if any view has new instances since the last access to it.

Returns:: true if any view has new instances.
Throws:: OperationException - if the session could not perform the operation.

viewsHaveNewInstances

boolean viewsHaveNewInstances()
                              throws OperationException

Returns true if any view has new instances since the last access to it.

Returns:: true if any view has new instances.
Throws:: OperationException - if the session could not perform the operation.

refresh

@Deprecated
void refresh(InstanceInfo instanceInfo)
             throws OperationException

Deprecated. use instanceRefresh(InstanceInfo) instead

Forces the reload of the specified InstanceInfo.

Parameters:

instanceInfo - InstanceInfo to reload. Cannot be null.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance does not exist.

instanceRefresh

InstanceInfo instanceRefresh(InstanceInfo instanceInfo)
                             throws OperationException

Forces the reload of the specified InstanceInfo.

Parameters:

instanceInfo - InstanceInfo to reload. Cannot be null.

Returns:

the instance refreshed.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance does not exist.

instanceRefresh

InstanceInfo instanceRefresh(String instanceId)
                             throws OperationException

Forces the reload of the specified InstanceInfo.

Parameters:

instanceId - Id for the instance to reload. Cannot be null.

Returns:

the instance refreshed.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance does not exist.

instanceStoreProperty

void instanceStoreProperty(InstanceInfo instanceInfo,
                           String key,
                           String value)
                           throws OperationException

Stores an instance scope property in the specified instance.

Parameters:: instanceInfo - The instance that will store the property.; key - The property key.; value - The property value.
Throws:: OperationException - if the property could not be stored successfully.

instanceStoreProperty

void instanceStoreProperty(String instanceId,
                           String key,
                           String value)
                           throws OperationException

Stores an instance scope property in the specified instance.

Parameters:: instanceId - Id of the instance that will store the property.; key - The property key.; value - The property value.
Throws:: OperationException - if the property could not be stored successfully.

instanceRetrieveProperty

String instanceRetrieveProperty(InstanceInfo instanceInfo,
                                String key)
                                throws OperationException

Retrieves an instance scope property from the specified instance.

Parameters:: instanceInfo - The instance that stores the property.; key - The property key.
Returns:: The stored property value.
Throws:: OperationException - if the property could not be retrieved successfully.

instanceRetrieveProperty

String instanceRetrieveProperty(String instanceId,
                                String key)
                                throws OperationException

Retrieves an instance scope property from the specified instance.

Parameters:: instanceId - Id of the instance that stores the property.; key - The property key.
Returns:: The stored property value.
Throws:: OperationException - if the property could not be retrieved successfully.

retrieveRoleProperties

@Deprecated
Map retrieveRoleProperties(String roleId,
                                      String category)
                           throws OperationException

Deprecated. use roleRetrieveProperties(String, String) instead

Returns a Map with all properties for the specified category for the specified role.

Parameters:: roleId - role to check. Cannot be null.; category - properties category
Returns:: Map with all properties for the specified category for the specified role.
The key of the map is the property key and the value of the map is the property value.
Throws:: OperationException - if the session could not retrieve the properties.

roleRetrieveProperties

Map roleRetrieveProperties(String roleId,
                           String category)
                           throws OperationException

Returns a Map with all properties for the specified category for the specified role.

Parameters:: roleId - role to check. Cannot be null.; category - properties category
Returns:: Map with all properties for the specified category for the specified role.
The key of the map is the property key and the value of the map is the property value.
Throws:: OperationException - if the session could not retrieve the properties.

retrieveUserProperties

@Deprecated
Map retrieveUserProperties(String category)
                           throws OperationException

Deprecated. use participantRetrieveProperties(String) instead

Returns a Map with all participant properties for the specified category.

Parameters:: category - properties category
Returns:: Map with all participant properties for the specified category.
The key of the map is the property key and the value of the map is the property value.
Throws:: OperationException - if the session could not retrieve the properties.

participantRetrieveProperties

Map participantRetrieveProperties(String category)
                                  throws OperationException

Returns a Map with all participant properties for the specified category.

Parameters:: category - properties category
Returns:: Map with all participant properties for the specified category.
The key of the map is the property key and the value of the map is the property value.
Throws:: OperationException - if the session could not retrieve the properties.

retrieveUserStringProperty

@Deprecated
String retrieveUserStringProperty(String category,
                                             String key)
                                  throws PropertyOperationException

Deprecated. use participantRetrieveProperty(String, String) instead

Returns a participant property.

Parameters:: category - properties category; key - property key
Returns:: value corresponding to this category and key.
Throws:: PropertyOperationException - if the session could not retrieve the properties.

participantRetrieveProperty

String participantRetrieveProperty(String category,
                                   String key)
                                   throws PropertyOperationException

Returns a participant property.

Parameters:: category - properties category; key - property key
Returns:: value corresponding to this category and key.
Throws:: PropertyOperationException - if the session could not retrieve the properties.

runGlobalActivity

@Deprecated
InstanceInfo runGlobalActivity(String activityId)
                               throws OperationException

Deprecated. use activityExecuteApplication(String, String) instead

Runs the specified Global Activity with no arguments.

This is the same as runGlobalActivity(activityId, null). The global activity cannot interact with a user; if user interaction is required, use activityPostApplication(String, String, Arguments).

Parameters:

activityId - Id of the global activity to run. Cannot be null.

Returns:

newly created process instance.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityExecuteApplication

InstanceInfo activityExecuteApplication(String activityName,
                                        String processId)
                                        throws OperationException

Runs the specified Global Activity with no arguments.

This is the same as runGlobalActivity(activityId, null). The global activity cannot interact with a user; if user interaction is required, use activityPostApplication(String, String, Arguments).

Parameters:

activityName - Name of the global activity to run. Cannot be null.

Returns:

newly created process instance.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityExecuteApplication

InstanceInfo activityExecuteApplication(Activity activity)
                                        throws OperationException

Runs the specified Global Activity with no arguments.

This is the same as runGlobalActivity(activityId, null). The global activity cannot interact with a user; if user interaction is required, use activityPostApplication(String, String, Arguments).

Parameters:

activity - The global activity to run. Cannot be null.

Returns:

newly created process instance.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

runGlobalActivity

@Deprecated
InstanceInfo runGlobalActivity(String activityId,
                                          Arguments arguments)
                               throws OperationException

Deprecated. use activityExecuteApplication(String, String, Arguments) instead

Runs the specified Global Activity with the specified arguments

The global activity cannot interact with a user; if user interaction is required, use activityExecuteApplication(String, String, Arguments).

Parameters:

activityId - Id of the global activity to run. Cannot be null.

arguments - arguments of the global activity. To get the names of the arguments, call Activity.getTask()[0], then Task.getArguments(), then TaskArgument.isOut() to check that the argument is an output argument. For global creation activities, only output arguments are used. In Studio, these are the arguments associated with the CIL (Component Integration Language) method associated with this Global Activity.

Returns:

newly created process instance for a Global Creation activity and null for a Global Activity.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityExecuteApplication

InstanceInfo activityExecuteApplication(String activityName,
                                        String processId,
                                        Arguments arguments)
                                        throws OperationException

Runs the specified Global Activity with the specified arguments

The global activity cannot interact with a user; if user interaction is required, use activityExecuteApplication(String, String, Arguments).

Parameters:

activityName - Name of the global activity to run. Cannot be null.

Returns:

newly created process instance for a Global Creation activity and null for a Global Activity.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

activityExecuteApplication

InstanceInfo activityExecuteApplication(Activity activity,
                                        Arguments arguments)
                                        throws OperationException

Runs the specified Global Activity with the specified arguments

The global activity cannot interact with a user; if user interaction is required, use activityExecuteApplication(String, String, Arguments).

Parameters:

activity - The global activity to run. Cannot be null.

Returns:

newly created process instance for a Global Creation activity and null for a Global Activity.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ParticipantNotInRoleException if the participant does not have roles of the activity.
NoPermissionException if the participant does not have the execution permission.
ProcessOperationException if the execution fails.

runProcess

@Deprecated
void runProcess(String targetProcessId,
                           String argumentsSetName,
                           Arguments arguments,
                           long timeout)
                throws OperationException

Deprecated. use processRun(String, String, Arguments, long) instead

Creates a new process instance in the specified Process and waits for the instance to reach the End activity up to the specified timeout.

If the instance reaches the end before the specified timeout elapses, arguments will contain the output arguments of the process; otherwise this method will throw an InstanceTimeoutException.

The specified process cannot contain any interactive activities.

Note that the current participant must have the same role as the begin activity.

Parameters:

targetProcessId - Id of the process for the new process instance. If the Id is in the format "/OrganizationalUnit/ProcessName#Variation-Mayor.minor" it will use that specific process, and if the id is in the format "/OrganizationalUnit/ProcessName" (consolidated process id) it will get the active process from this consolidated id.

argumentsSetName - name of the argument set to use. The default argument set is "BeginIn".

arguments - arguments containing the arguments specified by argumentSetName. Use Arguments.create() to create the arguments.

timeout - how much time to wait for the instance to reach the end activity. a value of zero (0L) means unlimited.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

InstanceTimeoutException if the specified timeout elapses before the instance reaches the end.
InstanceAbortedException if the output arguments are null.

processRun

void processRun(String targetProcessId,
                String argumentsSetName,
                Arguments arguments,
                long timeout)
                throws OperationException

Creates a new process instance in the specified Process and waits for the instance to reach the End activity up to the specified timeout.

If the instance reaches the end before the specified timeout elapses, arguments will contain the output arguments of the process; otherwise this method will throw an InstanceTimeoutException.

The specified process cannot contain any interactive activities.

Note that the current participant must have the same role as the begin activity.

Ex.

     // Select the arguments to pass.
     String argumentsSet = "ArgumentsSet";

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Select the time out
     long timeout = 1000L * 60L * 3L; // wait 3 minutes.

     // Execute Process.
     session.processRun("/OU/ProcessName#Variation-1.0", argumentsSet, arguments, timeout);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

argumentsSetName - name of the argument set to use. The default argument set is "BeginIn".

arguments - arguments containing the arguments specified by argumentSetName. Use Arguments.create() to create the arguments.

timeout - how much time to wait for the instance to reach the end activity. a value of zero (0L) means unlimited.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

InstanceTimeoutException if the specified timeout elapses before the instance reaches the end.
InstanceAbortedException if the output arguments are null.

searchParticipantsByName

@Deprecated
Participant[] searchParticipantsByName(String name)
                                       throws OperationException

Deprecated. use participantFindByName(String) instead

Returns an array of Participants that match the specified name using a substring search.

Parameters:

name - name to match by substring. Cannot be null.

Returns:

array of Participants that match the specified name

Throws:

OperationException - if the session was unable to retrieve the participants.
May be one of the following subclasses of OperationException:

ParticipantException if was unable to retrieve the participants.

See Also:

Participant

participantFindByName

ParticipantList participantFindByName(String name)
                                      throws OperationException

Returns an array of Participants that match the specified name using a substring search.

Parameters:

name - name to match by substring. Cannot be null.

Returns:

array of Participants that match the specified name

Throws:

OperationException - if the session was unable to retrieve the participants.
May be one of the following subclasses of OperationException:

ParticipantException if was unable to retrieve the participants.

See Also:

Participant

sendNotification

@Deprecated
void sendNotification(String targetInstanceOrProcessId,
                                 String activityName,
                                 String targetArgumentsSetName,
                                 Arguments notification,
                                 String sourceInstanceId)
                      throws OperationException

Deprecated. use processSendNotification(String, String, String, Arguments, String) instead

Sends a notification to a process in a parent/child relationship or for an external wait/interruption with the specified argument set.

Parameters:

targetInstanceOrProcessId - instance to receive the notification. Cannot be null.

activityName - activity to send the notification from. Cannot be null.

targetArgumentsSetName - name of the desired target argument set. Use null for the default set.

notification - set of arguments to send as notification. Use Process.getArgumentSets(String) with activityName to get the argument sets.

sourceInstanceId - instance sending the notification. Use null for external notifications.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ProcessOperationException if the execution fails.

See Also:

Process.getArgumentSets(String)

sendNotification

@Deprecated
void sendNotification(String targetInstanceOrProcessId,
                                 String activityName,
                                 String targetArgumentsSetName,
                                 Arguments notification)
                      throws OperationException

Deprecated. use processSendNotification(String, String, String, Arguments) instead

Sends a external notification to a process instance. For an external notification only.

Parameters:

targetInstanceOrProcessId - instance to receive the notification. Cannot be null.

activityName - activity to send the notification from. Cannot be null.

targetArgumentsSetName - name of the desired target argument set. Use null for the default set.

notification - set of arguments to send as notification. Use Process.getArgumentSets(String) with activityName to get the argument sets.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ProcessOperationException if the execution fails.

See Also:

Process.getArgumentSets(String)

processSendNotification

void processSendNotification(String targetInstanceOrProcessId,
                             String activityName,
                             String targetArgumentsSetName,
                             Arguments notification,
                             String sourceInstanceId)
                             throws OperationException

Sends a notification to a process in a parent/child relationship or for an external wait/interruption with the specified argument set.

Parameters:

targetInstanceOrProcessId - instance to receive the notification. Cannot be null.

activityName - activity to send the notification from. Cannot be null.

targetArgumentsSetName - name of the desired target argument set. Use null for the default set.

notification - set of arguments to send as notification. Use Process.getArgumentSets(String) with activityName to get the argument sets.

sourceInstanceId - instance sending the notification. Use null for external notifications.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ProcessOperationException if the execution fails.

See Also:

Process.getArgumentSets(String)

processSendNotification

void processSendNotification(String targetInstanceOrProcessId,
                             String activityName,
                             String targetArgumentsSetName,
                             Arguments notification)
                             throws OperationException

Sends a external notification to a process instance. For an external notification only.

Parameters:

targetInstanceOrProcessId - instance to receive the notification. Cannot be null.

activityName - activity to send the notification from. Cannot be null.

targetArgumentsSetName - name of the desired target argument set. Use null for the default set.

notification - set of arguments to send as notification. Use Process.getArgumentSets(String) with activityName to get the argument sets.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
ActivityNotFoundException if the activity does not exist
ProcessOperationException if the execution fails.

See Also:

Process.getArgumentSets(String)

getEscalateParticipants

@Deprecated
List getEscalateParticipants(InstanceStamp instance)
                             throws OperationException,
                                    BatchOperationException

Deprecated. use instanceGetParticipants(String, String, ParticipantFor) instead.
[instanceGetParticipants("/OU/ProcessName#Default-1.0/1/0", "MyActivity", ParticipantFor.ESCALATE)]

Gets a list of participants that this instance can be escalated to.

An instance can only be assigned if the interactive acitivity has been defined as assignable in Studio and only participants who have been given permission to escalate in Process Administrator can assign instances to participants with a higher category in the same role. Role category is also assigned in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instance - InstanceStamp to get the list of participants; cannot be null

Returns:

list of participants that this instance can be escalated to or an empty list if there are no participants that this instance can be escalated to

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

getGrabbableInstances

@Deprecated
InstanceInfo[] getGrabbableInstances(String activityId)
                                     throws OperationException,
                                            BatchOperationException

Deprecated. activityGetGrabbableInstances(String, String) instead.

Returns all the instances that can be grabbed from the activity specified by the activity ID.

The complete activity ID or the consolidated activity ID can be used.

Complete activity ID => /OrganizationalUnit/ProcessName#Variation-Mayor.minor/ActivityName

Consolidated activity ID => /OrganizationalUnit/ProcessName/ActivityName

Parameters:

activityId - ID of the grab activity; cannot be null

Returns:

instances that can be grabbed from the activity specified by activityId or a zero-length array if there are no grabbable instances

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available

BatchOperationException - if the session could not perform the operation on every activity
May be one of the following subclasses of BatchOperationException:

ProcessesNotAvailableException if not all instances are available to perform the operation..
You can find inside the batch exception:
- InstancesNotAvailableInEngineException if the engine where a process was deployes is not available.
- ProcessNotAvailableException if a process is not available.

getParticipantsForInstance

@Deprecated
List getParticipantsForInstance(InstanceStamp instance)
                                throws OperationException,
                                       BatchOperationException

Deprecated. use instanceGetParticipants(String, String, ParticipantFor) instead.
[instanceGetParticipants("/OU/Process#Default-1.0/1/0", "MyActivity", ParticipantFor.REASSIGN)]

Gets a list of Participants that are in the role specified by the activity in the InstanceStamp. This operation is NOT supported in a federated environment.

Parameters:

instance - InstanceStamp to get the list of participants; cannot be null

Returns:

list of participants that are in the role specified by the activity in the InstanceStamp or an empty list if there are no matching participants

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

BatchOperationException - if the session could not perform the operation on the instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all participants are available to perform the operation.
You can find inside the batch exception:
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

addBookmarks

@Deprecated
void addBookmarks(InstanceStamp[] instancesStamp)
                  throws OperationException

Deprecated. use instancesAddBookmark(InstanceActivityPairSet) instead

Adds bookmarks. This operation is NOT supported in a federated environment.

Parameters:: instancesStamp - array of InstanceStamps; a bookmark will be added for each InstanceStamp; cannot be null.
Throws:: OperationException - if the session could not bookmark the instances

instancesAddBookmark

void instancesAddBookmark(InstanceActivityPairSet instanceActivityPairs)
                          throws OperationException

Adds bookmarks.

Parameters:: instanceActivityPairs - Instances to add to the bookmark. Cannot be null.
Throws:: OperationException - if the session could not bookmark the instances

checkInAttachment

@Deprecated
void checkInAttachment(Attachment attachment,
                                  String remarks,
                                  File file)
                       throws OperationException

Deprecated. use attachmentCheckIn(Attachment, String, File) instead

Checks in an attachment.
If successful, this will always generate a new attachment version.

Parameters:

attachment - the attachment to check in; cannot be null

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to check in for the new attachment version; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InvalidAttachmentArgumentLengthException if the remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment could not be checked in

checkOutAttachment

@Deprecated
void checkOutAttachment(Attachment attachment,
                                   String directory)
                        throws OperationException

Deprecated. use attachmentCheckOut(Attachment, String) instead

Writes the attachment to the specified directory.
To check out the attachment, first call attachmentEdit(Attachment).

Parameters:

attachment - attachment to write; cannot be null

directory - directory where the file will be written; this directory must already exist; if this is a relative directory, it is relative to where the PAPI program is running

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the attachment could not be written to the specified directory, if a version lock has not been obtained, or if the current participant does not hold the version lock

checkOutAttachmentToStream

@Deprecated
void checkOutAttachmentToStream(Attachment attachment,
                                           OutputStream stream)
                                throws OperationException

Deprecated. use attachmentCheckOutToStream(Attachment, OutputStream) instead

Writes the attachment to the specified output stream.
To check out the attachment, first call attachmentEdit(Attachment).

Parameters:

attachment - attachment to write; cannot be null

stream - OutputStream to write the attachment to; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the attachment could not be written to the specified directory, if a version lock has not been obtained, or if the current participant does not hold the version lock

attachmentCheckOutToStream

void attachmentCheckOutToStream(Attachment attachment,
                                OutputStream stream)
                                throws OperationException

Writes the attachment to the specified output stream.
To check out the attachment, first call attachmentEdit(Attachment).

Simplified example within a servlet:

      //get a process service session
      ProcessServiceSession processSession = ...;

      //get the attachment id, probably from an InstanceInfo
      String attachmentId = ...;

      //get the attachment associated with this attachmentId
      Attachment attachment = processSession.getAttachment(attachmentId);

      //check out the attachment
      processSession.obtainEditionLock(attachment);

      //get the output stream
      OutputStream outputStream = response.getOutputStream;

      //set the appropriate headers
      response.setContentType(attachment.getContentType());

      //put the filename in quotes
      response.setHeader("Content-Disposition", "attachment; filename=\"" + attachment.getName() + "\"");

      //write the file to the output stream
      processSession.checkOutAttachmentToStream(attachment, outputStream);

Parameters:

attachment - attachment to write; cannot be null

stream - OutputStream to write the attachment to; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the attachment could not be written to the specified directory, if a version lock has not been obtained, or if the current participant does not hold the version lock

attachmentCheckOutToStream

void attachmentCheckOutToStream(String attachmentId,
                                OutputStream stream)
                                throws OperationException

Writes the attachment to the specified output stream.

Parameters:

attachmentId - id of the attachment to write; cannot be null

stream - OutputStream to write the attachment to; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the attachment could not be written to the specified directory, if a version lock has not been obtained, or if the current participant does not hold the version lock

commitExternalActivity

@Deprecated
InstanceInfo commitExternalActivity(String instanceStampId,
                                               int taskIn,
                                               Arguments args)
                                    throws OperationException

Deprecated. use activityCommit(String, String, Arguments) instead

Executes the commit method of an external activity using the specified InstanceStampId and task identification number. This operation is NOT supported in a federated environment.

Parameters:

instanceStampId - instance stamp that identifies the target instance; cannot be null

taskIn - identification number of task to execute

args - arguments to be passed to the commit method of the external activity; null means no arguments

Returns:

InstanceInfo with the state of the instance after the commit method has executed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance in the instance stamp does not exist
ActivityNotFoundException if the activity in the instance stamp does not exist.
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

commitExternalActivity

@Deprecated
InstanceInfo commitExternalActivity(String instanceId,
                                               String activityName,
                                               Arguments args)
                                    throws OperationException

Deprecated. use activityCommit(String, String, Arguments) instead

Executes the commit method of the main task of an external activity using the specified instanceId and activityId.

Parameters:

instanceId - instance ID that identifies the target instance; cannot be null

activityName - Activity name that identifies the activity to execute; cannot be null

args - arguments to be passed to the commit method of the external activity; null means no arguments

Returns:

InstanceInfo with the state of the instance after the commit method has executed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityCommit

InstanceInfo activityCommit(String activityName,
                            String instanceId,
                            Arguments args)
                            throws OperationException

Executes the commit method of an external activity using the specified activit name and the instance id.

Parameters:

activityName - Activity name of the activity to execute. Cannot be null.

instanceId - Instance identification that you use to execute the activity. Cannot be null.

args - arguments to be passed to the commit method of the external activity; null means no arguments

Returns:

InstanceInfo with the state of the instance after the commit method has executed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance in the instance stamp does not exist
ActivityNotFoundException if the activity in the instance stamp does not exist.
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityCommit

InstanceInfo activityCommit(Activity activity,
                            InstanceInfo instance,
                            Arguments args)
                            throws OperationException

Executes the commit method of an external activity using the specified activit and the instance.

Parameters:

activity - Activity to execute. Cannot be null.

instance - Instance that you use to execute the activity. Cannot be null.

args - arguments to be passed to the commit method of the external activity; null means no arguments

Returns:

InstanceInfo with the state of the instance after the commit method has executed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance in the instance stamp does not exist
ActivityNotFoundException if the activity in the instance stamp does not exist.
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

commitExternalActivity

@Deprecated
InstanceInfo commitExternalActivity(String instanceId,
                                               String activityName,
                                               int taskIn,
                                               Arguments args)
                                    throws OperationException

Deprecated. use activityCommit(String, String, Arguments) instead.

Executes the commit method of an external activity using the specified instanceId, activityId, and task identification number.

Parameters:

instanceId - instance ID that identifies the target instance; cannot be null

activityName - activity name that identifies the activity to execute; cannot be null

taskIn - identification number of task to execute

args - arguments to be passed to the commit method of the external activity null means no arguments

Returns:

InstanceInfo with the state of the instance after the commit method has executed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

abortActivity

@Deprecated
void abortActivity(String instanceId,
                              String activityName,
                              int taskIn)
                   throws OperationException

Deprecated. use activityAbort(String, int, String) instead

Locates instance identified by instanceId in activity activityName and aborts the running task identified by taskIn.

Parameters:: instanceId - Id of the instance. Cannot be null.; activityName - name of activity. Cannot be null.; taskIn - task identification number of the Task to be aborted.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

void activityAbort(String activityName,
                   String instanceId)
                   throws OperationException

Locates instance identified by instanceId in activity activityName and aborts the main task.

Parameters:: activityName - name of activity. Cannot be null.; instanceId - Id of the instance. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

@Deprecated
void activityAbort(Activity activity,
                              InstanceId instanceId)
                   throws OperationException

Deprecated. use activityAbort(Activity, InstanceInfo)

Locates instance identified by instanceId in activity and aborts the main task.

Parameters:: activity - Activity where the task was defined. Cannot be null.; instanceId - InstanceId to abort main task. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

void activityAbort(Activity activity,
                   InstanceInfo instance)
                   throws OperationException

Locates instance in activity and aborts the main task.

Parameters:: activity - Activity where the task was defined. Cannot be null.; instance - Instance to abort main task. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

void activityAbort(String activityName,
                   int taskIn,
                   String instanceId)
                   throws OperationException

Locates instance identified by instanceId in activity activityName and aborts the running task identified by taskIn.

Parameters:: activityName - name of activity. Cannot be null.; taskIn - task identification number of the Task to be aborted.; instanceId - Id of the instance. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

@Deprecated
void activityAbort(Activity activity,
                              int taskIn,
                              InstanceId instanceId)
                   throws OperationException

Deprecated. use activityAbort(Activity, int, InstanceInfo)

Locates instance identified by instanceId in activity and aborts the running task identified by taskIn.

Parameters:: activity - Activity where the task was defined. Cannot be null.; taskIn - Task identification number of the Task to be aborted.; instanceId - InstanceId to abort task. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

activityAbort

void activityAbort(Activity activity,
                   int taskIn,
                   InstanceInfo instance)
                   throws OperationException

Locates instance in activity and aborts the running task identified by taskIn.

Parameters:: activity - Activity where the task was defined. Cannot be null.; taskIn - Task identification number of the Task to be aborted.; instance - Instance to abort task. Cannot be null.
Throws:: OperationException - if the session could not perform the operation.

customRunActivity

@Deprecated
TaskExecution customRunActivity(String instanceId,
                                           String activityName,
                                           int taskIn,
                                           Arguments args)
                                throws OperationException

Deprecated. use activityPost(String, String, int, Arguments) instead

Executes the task for this instance using an instanceId, activityId, and task identification number.
Allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - instance ID that identifies the InstanceInfo to execute; cannot be null.

activityName - activity name that identifies the target activity to execute; cannot be null

taskIn - task identification number of the task to execute

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPost

TaskExecution activityPost(String activityName,
                           String instanceId,
                           int taskToExecute,
                           Arguments args)
                           throws OperationException

Executes the task for this instance using an instanceId, activityId, and task identification number.
Allows a PAPI client to customize client-side invocations.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processSet.add(session.processGetAllVersions("/OU/MyProcess"));

     InstanceInfoList instances = session.processesGetInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Select the task to execute.
     Activity activity = instance.getActivity();
     Task task = activity.getTask("TaskToExecute");

     // Execute the activity.
     TaskExecution execution = session.activityPost(instance.getActivityName(), instance.getId(), task.getIn(),
                                                    arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activityName - activity name that identifies the target activity to execute; cannot be null

instanceId - instance ID that identifies the InstanceInfo to execute; cannot be null.

taskToExecute - task identification number of the task to execute

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPost

TaskExecution activityPost(Activity activity,
                           InstanceInfo instance,
                           int taskToExecute,
                           Arguments args)
                           throws OperationException

Executes the activity task number over the instance. This methods allows a PAPI client to customize client-side invocations.

Parameters:: activity - Activity to execute task.; instance - Instance uses to execute the activity.; taskToExecute - Task number of the activity to be executed.; args - Arguments to pass the task.
Returns:: TaskExecution object used to continue this execution
Throws:: OperationException - if the operation fails.

customRunActivity

@Deprecated
TaskExecution customRunActivity(String instanceId,
                                           String activityName,
                                           Arguments args)
                                throws OperationException

Deprecated. use activityPost(String, String, Arguments) instead

Executes the main task for this instance using an instanceId and activityId.
Allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - instance ID that identifies the InstanceInfo to execute; cannot be null

activityName - activity name that identifies the target activity to execute; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPost

TaskExecution activityPost(String activityName,
                           String instanceId,
                           Arguments args)
                           throws OperationException

Executes the main task for this instance using an instanceId and activityId.
Allows a PAPI client to customize client-side invocations.

Ex. Interactive activity

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processSet.add(session.processGetAllVersions("/OU/MyProcess"));

     InstanceInfoList instances = session.processesGetInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Execute the activity.
     TaskExecution execution = session.activityPost(instance.getActivityName(), instance.getId(), arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Ex. Global interactive activity with instance access.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityWhereTheInstanceIs");

     ProcessIdSet processes = ProcessIdSet.create();
     processSet.add(session.processGetAllVersions("/OU/MyProcess"));

     InstanceInfoList instances = session.processesGetInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Execute the activity.
     TaskExecution execution = session.activityPost("GlobalActivityToExecute", instance.getId(), arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activityName - activity name that identifies the target activity to execute; cannot be null

instanceId - instance ID that identifies the InstanceInfo to execute; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPost

TaskExecution activityPost(Activity activity,
                           InstanceInfo instance,
                           Arguments args)
                           throws OperationException

Executes the main task for this instance using an instanceId and activityId.
Allows a PAPI client to customize client-side invocations.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processSet.add(session.processGetAllVersions("/OU/MyProcess"));

     InstanceInfoList instances = session.processesGetInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     Process process = session.getProcess(instance.getProcessIn());
     Activity activity = process.getActivity(instance.getActivityName());

     // Execute the activity.
     TaskExecution execution = session.activityPost(activity, instance, arguments);

     for (Invocation inv = execution.next(); inv != null; inv = execution.next()) {
         execution.setInvocationResult(inv.invoke());
     }

     // Call getArguments() so argument replacement is performed
     execution.getArguments();

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activity - Target activity to execute; cannot be null

instance - InstanceInfo to execute; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

customRunGlobal

@Deprecated
TaskExecution customRunGlobal(String instanceId,
                                         String activityName,
                                         Arguments args)
                              throws OperationException

Deprecated. use activityPost(String, String, Arguments) instead

Executes the specified Global Activity for this instance using an instanceId and activityName.
Allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - instance ID that identifies the InstanceInfo to execute; cannot be null

activityName - activity name that identifies the target activity to execute; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

customRunTask

TaskExecution customRunTask(String instanceStampId,
                            int taskIn,
                            Arguments args)
                            throws OperationException

Deprecated. use activityPost(String, String, int, Arguments) instead.

Executes the specified task for this instance using an instanceStampId and task identification number.
Allows a PAPI client to customize client-side invocations. This operation is NOT supported in a federated environment.

Parameters:

instanceStampId - instance stamp that identifies the target instance; cannot be null

taskIn - identification number of task to execute

args - arguments to pass to the task; null means no arguments

Returns:

TaskExecution object used to continue execution

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

instanceAttach

void instanceAttach(InstanceInfo instanceInfo,
                    String name,
                    String description,
                    String remarks,
                    File file)
                    throws OperationException,
                           IOException

Attaches a file attachment to this process instance.

The content type is set to null.

Parameters:

instanceInfo - InstanceInfo to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceAttach

void instanceAttach(InstanceInfo instanceInfo,
                    String name,
                    String description,
                    String remarks,
                    File file,
                    String contentType)
                    throws OperationException,
                           IOException

Attaches a file with the specified content type to this process instance.

Parameters:

instanceInfo - InstanceInfo to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

contentType - content type of the file, e.g. "text/html" or "application/ms-word"; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceAttach

void instanceAttach(InstanceInfo instanceInfo,
                    String name,
                    String description,
                    String remarks,
                    File file,
                    String contentType,
                    Locale locale)
                    throws OperationException,
                           IOException

Attaches a file with the specified content type to this process instance.

Parameters:

instanceInfo - InstanceInfo to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

contentType - content type of the file, e.g. "text/html" or "application/ms-word"; cannot be null

locale - locale in which the document has been written

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceAttach

void instanceAttach(String instanceId,
                    String name,
                    String description,
                    String remarks,
                    File file,
                    String contentType,
                    Locale locale)
                    throws OperationException,
                           IOException

Attaches a file with the specified content type to this process instance.

Parameters:

instanceId - id of the instance to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

contentType - content type of the file, e.g. "text/html" or "application/ms-word"; cannot be null

locale - locale in which the document has been written

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceAttach

void instanceAttach(InstanceInfo instanceInfo,
                    String name,
                    String description,
                    String remarks,
                    File file,
                    String contentType,
                    Locale locale,
                    AttachmentStorageType storageType)
                    throws OperationException,
                           IOException

Attaches a file with the specified content type to this process instance.

Parameters:

instanceInfo - InstanceInfo to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

contentType - content type of the file, e.g. "text/html" or "application/ms-word"; cannot be null

locale - locale in which the document has been written

storageType - AttachmentStorageType indicating the external repository type where the attachment content will be stored.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceAttach

void instanceAttach(String instanceId,
                    String name,
                    String description,
                    String remarks,
                    File file,
                    String contentType,
                    Locale locale,
                    AttachmentStorageType storageType)
                    throws OperationException,
                           IOException

Attaches a file with the specified content type to this process instance.

Parameters:

instanceId - id of the instance to attach the file to; cannot be null

name - name of the attachment; cannot be null; the maximum length of the name is Attachment.FILENAME_LENGTH

description - brief description of the attachment; cannot be null; the maximum length of the description is Attachment.DESCRIPT_LENGTH

remarks - version-specific remarks to add to the attachment; cannot be null; the maximum length of remarks is Attachment.REMARK_LENGTH

file - file to attach to this instance; cannot be null

contentType - content type of the file, e.g. "text/html" or "application/ms-word"; cannot be null

locale - locale in which the document has been written

storageType - AttachmentStorageType indicating the external repository type where the attachment content will be stored.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the name, description, or remarks argument of the attachment exceeds the limit of the argument length
AttachmentFileNotFoundException if the file does not exist
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceLinkExternalAttachment

void instanceLinkExternalAttachment(InstanceInfo instanceInfo,
                                    String externalId,
                                    AttachmentStorageType storageType)
                                    throws OperationException,
                                           IOException

Links an external attachment (stored in an external storage repository) to the instance.

Parameters:

instanceInfo - InstanceInfo to attach the file to; cannot be null

externalId - Id for the external attachment. Will be used to retrieve the attachment content from the external storage.

storageType - AttachmentStorageType that indicates the external repository type where the existing external attachment content is stored.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the externalId argument exceeds the limit of the argument length
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceLinkExternalAttachment

void instanceLinkExternalAttachment(String instanceId,
                                    String externalId,
                                    AttachmentStorageType storageType)
                                    throws OperationException,
                                           IOException

Links an external attachment (stored in an external storage repository) to the instance.

Parameters:

instanceId - id of the instance to attach the file to; cannot be null

externalId - Id for the external attachment. Will be used to retrieve the attachment content from the external storage.

storageType - AttachmentStorageType that indicates the external repository type where the existing external attachment content is stored.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
InvalidAttachmentArgumentLengthException if the externalId argument exceeds the limit of the argument length
AttachmentOperationException if the attachment fails
NoPermissionException if this participant does not have permission to attach the file to the instance.

IOException - if an I/O error occurs

instanceGetGlobalActivities

ActivityList instanceGetGlobalActivities(String instanceId)
                                         throws OperationException

Returns all Global activities which can be called for the specified instance.

Parameters:

instanceId - Instance indentification of the instance to check.

Returns:

Activities which can be called by the specified instance.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

instanceGetGlobalActivities

ActivityList instanceGetGlobalActivities(InstanceInfo instance)
                                         throws OperationException

Returns all Global activities which can be called for the specified instance.

Parameters:

instance - Instance to check.

Returns:

Activities which can be called by the specified instance.

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist

instanceCanBeAborted

boolean instanceCanBeAborted(String instanceId)
                             throws OperationException

Returns true if the instance can be aborted.

An instance can be aborted if the interactive activity has been defined as abortable in Studio and the participant has been given permission to abort in the Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be aborted

Returns:

true if the instance can be aborted

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeAborted

boolean instanceCanBeAborted(InstanceInfo instance)

Returns true if the instance can be aborted.

An instance can be aborted if the interactive activity has been defined as abortable in Studio and the participant has been given permission to abort in the Process Administrator.

Parameters:: instance - InstanceInfo to verify that the instance can be aborted
Returns:: true if the instance can be aborted

instanceCanBeSentBack

boolean instanceCanBeSentBack(String instanceId)
                              throws OperationException

Returns true if the instance can be routed back.

An instance can be routed back if it is outside of the main process flow in an exception flow, grab flow, or interruption flow.

Parameters:

instanceId - Instance id to verify that the instance can be routed back

Returns:

true if the instance can be routed back

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeSentBack

boolean instanceCanBeSentBack(InstanceInfo instance)

Returns true if the instance can be routed back.

An instance can be routed back if it is outside of the main process flow in an exception flow, grab flow, or interruption flow.

Parameters:: instance - InstanceInfo to verify that the instance can be routed back
Returns:: true if the instance can be routed back

instanceCanBeBack

@Deprecated
boolean instanceCanBeBack(InstanceInfo instance)

Deprecated. use instanceCanBeSentBack(InstanceInfo) instead.

Returns true if the instance can be routed back.

An instance can be routed back if it is outside of the main process flow in an exception flow, grab flow, or interruption flow.

Parameters:: instance - InstanceInfo to verify that the instance can be routed back
Returns:: true if the instance can be routed back

instanceCanBeProcessed

boolean instanceCanBeProcessed(String instanceId)
                               throws OperationException

Returns true if the instance can be processed.

Processed means that the main task associated with this instance can be executed.

Parameters:

instanceId - Instance id to verify that the instance can be processed

Returns:

true if the instance can be processed

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeProcessed

boolean instanceCanBeProcessed(InstanceInfo instance)

Returns true if the instance can be processed.

Processed means that the main task associated with this instance can be executed.

Parameters:: instance - InstanceInfo to verify that the instance can be processed
Returns:: true if the instance can be processed

instanceCanBeReassigned

boolean instanceCanBeReassigned(String instanceId)
                                throws OperationException

Returns true if the instance can be reassigned.

An instance can be reassigned if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to reassign in Process Administrator, or if the instance is selected and the participant has been given permission to escalate or delegate in Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be reassigned

Returns:

true if the instance can be reassigned

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeReassigned

boolean instanceCanBeReassigned(InstanceInfo instance)

Returns true if the instance can be reassigned.

Parameters:: instance - InstanceInfo to verify that the instance can be reassigned
Returns:: true if the instance can be reassigned

instanceCanBeReassign

@Deprecated
boolean instanceCanBeReassign(InstanceInfo instance)

Deprecated. use instanceCanBeReassigned(InstanceInfo) instead.

Returns true if the instance can be reassigned.

Parameters:: instance - InstanceInfo to verify that the instance can be reassigned
Returns:: true if the instance can be reassigned

instanceCanBeDelegated

boolean instanceCanBeDelegated(String instanceId)
                               throws OperationException

Returns true if the instance can be delegated.

An instance can be delegated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to delegate in Process Administrator.

Parameters:

instanceId - Id of the instance to check if the instance can be delegated

Returns:

true if the instance can be delegated

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeDelegated

boolean instanceCanBeDelegated(InstanceInfo instance)

Returns true if the instance can be delegated.

An instance can be delegated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to delegate in Process Administrator.

Parameters:: instance - InstanceInfo to check if the instance can be delegated
Returns:: true if the instance can be delegated

instanceCanBeDelegate

@Deprecated
boolean instanceCanBeDelegate(InstanceInfo instance)

Deprecated. use instanceCanBeDelegated(InstanceInfo) instead.

Returns true if the instance can be delegated.

An instance can be delegated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to delegate in Process Administrator.

Parameters:: instance - InstanceInfo to check if the instance can be delegated
Returns:: true if the instance can be delegated

instanceCanBeEscalated

boolean instanceCanBeEscalated(String instanceId)
                               throws OperationException

Returns true if this instance can be escalated.

An instance can be escalated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to escalate in Process Administrator.

Parameters:

instanceId - Id of the instance to check if the instance can be escalated

Returns:

true if the instance can be escalated

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeEscalated

boolean instanceCanBeEscalated(InstanceInfo instance)

Returns true if this instance can be escalated.

An instance can be escalated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to escalate in Process Administrator.

Parameters:: instance - InstanceInfo to check if the instance can be escalated
Returns:: true if the instance can be escalated

instanceCanBeEscalate

@Deprecated
boolean instanceCanBeEscalate(InstanceInfo instance)

Deprecated. use instanceCanBeEscalated(InstanceInfo) instead.

Returns true if this instance can be escalated.

An instance can be escalated if the interactive activity has been defined as reassignable in Studio and the participant has been given permission to escalate in Process Administrator.

Parameters:: instance - InstanceInfo to check if the instance can be escalated
Returns:: true if the instance can be escalated

instanceCanBeReassignedToPeer

boolean instanceCanBeReassignedToPeer(String instanceId)
                                      throws OperationException

Returns true if this instance can be reassigned to a peer.

An instance can be reassigned to a peer if the interactive activity has been defined as reassignable in Studio and the participant has been given permission for peer assignment in Process Administrator.

Parameters:

instanceId - Id of the instance to check if the instance can be reassigned to a peer

Returns:

true if the instance can be reassigned to a peer

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeReassignedToPeer

boolean instanceCanBeReassignedToPeer(InstanceInfo instance)

Returns true if this instance can be reassigned to a peer.

Parameters:: instance - InstanceInfo to check if the instance can be reassigned to a peer
Returns:: true if the instance can be reassigned to a peer

instanceCanBeResumed

boolean instanceCanBeResumed(String instanceId)
                             throws OperationException

Returns true if the instance can be resumed.

An instance can be resumed if the instance is suspended and the participant has been given permission to suspend in Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be resumed

Returns:

true if the instance can be resumed

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeResumed

boolean instanceCanBeResumed(InstanceInfo instance)

Returns true if the instance can be resumed.

An instance can be resumed if the instance is suspended and the participant has been given permission to suspend in Process Administrator.

Parameters:: instance - InstanceInfo to verify that the instance can be resumed
Returns:: true if the instance can be resumed

instanceCanBeSelected

boolean instanceCanBeSelected(String instanceId)
                              throws OperationException

Returns true if the instance can be selected by the current participant.

An instance can be selected if all items of the instance are currently unselected or selected by the current participant.

Parameters:

instanceId - Instance id to verify that the instance can be selected

Returns:

true if the instance can be selected by the current participant

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeSelected

boolean instanceCanBeSelected(InstanceInfo instance)

Returns true if the instance can be selected by the current participant.

An instance can be selected if all items of the instance are currently unselected or selected by the current participant.

Parameters:: instance - InstanceInfo to verify that the instance can be selected
Returns:: true if the instance can be selected by the current participant

instanceCanBeSent

boolean instanceCanBeSent(String instanceId)
                          throws OperationException

Returns true if the instance can be sent.

An instance can be sent if all mandatory items of the instance are currently completed and the articipant has been given permission to route in Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be sent

Returns:

true if the instance can be sent

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeSent

boolean instanceCanBeSent(InstanceInfo instance)

Returns true if the instance can be sent.

An instance can be sent if all mandatory items of the instance are currently completed and the articipant has been given permission to route in Process Administrator.

Parameters:: instance - InstanceInfo to verify that the instance can be sent
Returns:: true if the instance can be sent

instanceCanBeSuspended

boolean instanceCanBeSuspended(String instanceId)
                               throws OperationException

Returns true if the instance can be suspended.

An instance can be suspended if the interactive activity has been defined as suspendable in Studio, the instance is running, and the participant has been given permission to suspend in Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be suspended

Returns:

true if the instance can be suspended

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeSuspended

boolean instanceCanBeSuspended(InstanceInfo instance)

Returns true if the instance can be suspended.

Parameters:: instance - InstanceInfo to verify that the instance can be suspended
Returns:: true if the instance can be suspended

instanceCanBeUngrabbed

boolean instanceCanBeUngrabbed(String instanceId)
                               throws OperationException

Returns true if the instance can be ungrabbed.

An instance can be ungrabbed if the instance is grabbed and the participant has been given permission to grab in Process Administrator.

Parameters:

instanceId - Instance id to verify that the instance can be ungrabbed

Returns:

true if the instance can be ungrabbed

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeUngrabbed

boolean instanceCanBeUngrabbed(InstanceInfo instance)

Returns true if the instance can be ungrabbed.

An instance can be ungrabbed if the instance is grabbed and the participant has been given permission to grab in Process Administrator.

Parameters:: instance - InstanceInfo to verify that the instance can be ungrabbed
Returns:: true if the instance can be ungrabbed

instanceCanBeUnselected

boolean instanceCanBeUnselected(String instanceId)
                                throws OperationException

Returns true if the instance can be unselected by the current participant

An instance can be unselected if the instance is currently selected by the participant

Parameters:

instanceId - Instance id to verify that the instance can be unselected

Returns:

true if the instance can be unselected by the current participant

Throws:

OperationException - if the session was unable to retrieve the instance.
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available.
ProcessControlNotAvailableException if the remote process is not available.
InstanceNotFoundException if the instance in this instance Id could not be found.

instanceCanBeUnselected

boolean instanceCanBeUnselected(InstanceInfo instance)

Returns true if the instance can be unselected by the current participant

An instance can be unselected if the instance is currently selected by the participant

Parameters:: instance - InstanceInfo to verify that the instance can be unselected
Returns:: true if the instance can be unselected by the current participant

instanceReassign

@Deprecated
void instanceReassign(InstanceStamp instance,
                                 String participant)
                      throws OperationException,
                             BatchOperationException

Deprecated. use instanceReassign(String, String, String) instead

Reassigns the instance to the specified participant.

An instance can be reassigned if the interactive activity has been defined as reassignable in Studio and the current participant has been given permission to reassign in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instance - InstanceStamp of instance to be reassigned; cannot be null

participant - UID of participant to reassign the instance to; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on every object May be one of the following subclasses of BatchOperationException:

InstancesException if the operation fails.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instanceReassign

void instanceReassign(String instanceId,
                      String activityName,
                      String participant)
                      throws OperationException,
                             BatchOperationException

Reassigns the instance to the specified participant.

An instance can be reassigned if the interactive activity has been defined as reassignable in Studio and the current participant has been given permission to reassign in Process Administrator.

Parameters:

instanceId - Instance id of instance to be reassigned; cannot be null

activityName - The activity name of the activity where the instance suposse is.

participant - UID of participant to reassign the instance to; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on every object May be one of the following subclasses of BatchOperationException:

InstancesException if the operation fails.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instanceReassign

void instanceReassign(InstanceInfo instance,
                      String participant)
                      throws OperationException,
                             BatchOperationException

Reassigns the instance to the specified participant.

An instance can be reassigned if the interactive activity has been defined as reassignable in Studio and the current participant has been given permission to reassign in Process Administrator.

Parameters:

instance - Instance to be reassigned; cannot be null

participant - UID of participant to reassign the instance to; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on every object May be one of the following subclasses of BatchOperationException:

InstancesException if the operation fails.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instancesAbort

@Deprecated
void instancesAbort(InstanceStamp[] instances)
                    throws OperationException,
                           BatchOperationException

Deprecated. use instancesAbort(InstanceActivityPairSet) instead

Aborts the specified instances.

An instance can be aborted if the interactive activity has been defined as abortable in Studio and the participant has been given permission to abort in Process Administrator.
Note that only instances in interactive activities can be aborted. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamp specifying the instances to be aborted; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadyTerminatedException if an instance is terminated.

instancesAbort

void instancesAbort(InstanceActivityPairSet instanceActivityPairs)
                    throws OperationException,
                           BatchOperationException

Aborts the specified instances.

Parameters:

instanceActivityPairs - InstanceSet specifying the instances to be aborted; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadyTerminatedException if an instance is terminated.

instancesAddConsult

@Deprecated
void instancesAddConsult(InstanceStamp[] instances,
                                    String consult,
                                    String toParticipant)
                         throws OperationException,
                                BatchOperationException

Deprecated. use instancesAddConsult(InstanceActivityPairSet, String, String) instead

Adds consultations for the specified instances for the specified participant. This operation is NOT supported in a federated environment.

Parameters:

instances - consult will be added to each InstanceStamp in this array; cannot be null

consult - remark to include in consult; cannot be null

toParticipant - UID of participant to be consulted; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instancesAddConsult

void instancesAddConsult(InstanceActivityPairSet instanceActivityPairs,
                         String consult,
                         String toParticipant)
                         throws OperationException,
                                BatchOperationException

Adds consultations for the specified instances for the specified participant.

Parameters:

instanceActivityPairs - consult will be added to each instance in this InstanceSet; cannot be null

consult - remark to include in consult; cannot be null

toParticipant - UID of participant to be consulted; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instancesAddNote

@Deprecated
void instancesAddNote(InstanceStamp[] instances,
                                 String note)
                      throws OperationException,
                             BatchOperationException

Deprecated. use instancesAddNote(InstanceActivityPairSet, String) instead

Adds a note to the specified instances. This operation is NOT supported in a federated environment.

Parameters:

instances - note will be added to each InstanceStamp in this array; cannot be null

note - note content; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instancesAddNote

void instancesAddNote(InstanceActivityPairSet instanceActivityPairs,
                      String note)
                      throws OperationException,
                             BatchOperationException

Adds a note to the specified instances.

Parameters:

instanceActivityPairs - note will be added to each instance in this InstanceSet; cannot be null

note - note content; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.

instancesGrab

@Deprecated
void instancesGrab(InstanceStamp[] instances,
                              String grabActivityName)
                   throws OperationException,
                          BatchOperationException

Deprecated. use instancesGrab(InstanceActivityPairSet, String) instead

Grabs a group of instances by the specified activity.

An instance can be grabbed if it is running, the interactive activity has been defined as grabbable in Studio, and the participant has been given permission to grab in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to grab; cannot be null

grabActivityName - name of the grab activity; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation for each instance.
May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- NoValidTransitionAvailableException if an instance can no be grabbed to the grab activity.
- InstanceNotRunningException if an instance is not running.
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instancesGrab

void instancesGrab(InstanceActivityPairSet instanceActivityPairs,
                   String grabActivityName)
                   throws OperationException,
                          BatchOperationException

Grabs a group of instances by the specified activity.

An instance can be grabbed if it is running, the interactive activity has been defined as grabbable in Studio, and the participant has been given permission to grab in Process Administrator.

Parameters:

instanceActivityPairs - InstanceSet of instances to grab; cannot be null

grabActivityName - name of the grab activity; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation for each instance.
May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- NoValidTransitionAvailableException if an instance can no be grabbed to the grab activity.
- InstanceNotRunningException if an instance is not running.
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instancesResume

@Deprecated
void instancesResume(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

Deprecated. use instancesResume(fuego.papi.collections.InstanceActivityPairSet) instead

Resumes a group of instances.

An instance can be resumed if it is suspended and the participant has been given permission to suspend in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to resume; cannot be null

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotSuspendedException if an instance is not suspended.

instancesResume

void instancesResume(InstanceActivityPairSet instanceActivityPairs)
                     throws OperationException,
                            BatchOperationException

Resumes a group of instances.

An instance can be resumed if it is suspended and the participant has been given permission to suspend in Process Administrator.

Parameters:

instanceActivityPairs - InstanceSet of instances to resume; cannot be null

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotSuspendedException if an instance is not suspended.

instancesReassign

void instancesReassign(InstanceActivityPairSet instanceActivityPairSet,
                       String participant)
                       throws OperationException,
                              BatchOperationException

Reassigns the instance to the specified participant.

An instance can be reassigned if the interactive activity has been defined as reassignable in Studio and the current participant has been given permission to reassign in Process Administrator.

Parameters:

instanceActivityPairSet - InstanceSet of instances to be reassigned; cannot be null

participant - UID of participant to reassign the instances to; cannot be null

Throws:

OperationException - if the session could not perform the operation.
May be one of the following subclasses of OperationException:

PrivilegedOperationException if the participant does not have permissions to perform the operation.

BatchOperationException - if the session could not perform the operation on every object May be one of the following subclasses of BatchOperationException:

InstancesException if the operation fails.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.

instancesSelect

@Deprecated
void instancesSelect(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

Deprecated. use instancesSelect(fuego.papi.collections.InstanceActivityPairSet) instead

Selects a group of instances by the current participant.

An instance can be selected if all items of the instance are currently unselected or selected by the current participant.
Note that only instances in interactive activities can be selected. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to select; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.
- InstanceAlreadySelectedException if the instance is selected.

instancesSelect

void instancesSelect(InstanceActivityPairSet instanceActivityPairs)
                     throws OperationException,
                            BatchOperationException

Selects a group of instances by the current participant.

An instance can be selected if all items of the instance are currently unselected or selected by the current participant.
Note that only instances in interactive activities can be selected.

Parameters:

instanceActivityPairs - InstanceSet of Instances to select; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySelectedException if an instance is selected by other participant (not by current participant).
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance is.
- InstanceAlreadySelectedException if the instance is selected.

instancesSend

@Deprecated
void instancesSend(InstanceStamp[] instances)
                   throws OperationException,
                          BatchOperationException

Deprecated. use instancesSend(InstanceActivityPairSet) instead

Sends a group of instances.

An instance can be sent if all mandatory items of the instance are currently completed and the articipant has been given permission to route in Process Administrator.
Note that only instances in interactive activities can be sent. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to route; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NotUniqueTransitionException if an instance has more than one target activity.
- NoValidTransitionAvailableException if an instance does not have target activities.

instancesSend

void instancesSend(InstanceActivityPairSet instanceActivityPairs)
                   throws OperationException,
                          BatchOperationException

Sends a group of instances.

Parameters:

instanceActivityPairs - InstanceSet of Instances to route; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NotUniqueTransitionException if an instance has more than one target activity.
- NoValidTransitionAvailableException if an instance does not have target activities.

instancesSendBack

@Deprecated
void instancesSendBack(InstanceStamp[] instances,
                                  boolean skip)
                       throws OperationException,
                              BatchOperationException

Deprecated. use instancesSendBack(InstanceActivityPairSet, boolean) instead

Sends back a group of instances.

An instance can be sent back if it is outside of the main process flow in an exception flow or an interruption flow. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to route; cannot be null

skip - if true, skip the activity which threw the exception or the activity which was interrupted

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation for each instance.
May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.

instancesSendBack

void instancesSendBack(InstanceActivityPairSet instanceActivityPairs,
                       boolean skip)
                       throws OperationException,
                              BatchOperationException

Sends back a group of instances.

An instance can be sent back if it is outside of the main process flow in an exception flow or an interruption flow.

Parameters:

instanceActivityPairs - InstanceSet of Instances to route; cannot be null

skip - if true, skip the activity which threw the exception or the activity which was interrupted

Throws:

OperationException - if the session could not perform the operation.

BatchOperationException - if the session could not perform the operation for each instance.
May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.

instancesSendTo

@Deprecated
void instancesSendTo(InstanceStamp[] instances,
                                String activityName,
                                String participant)
                     throws OperationException,
                            BatchOperationException

Deprecated. use instancesSendTo(InstanceActivityPairSet, String, String) instead

Routes a group of instances to the specified activity and participant.

An instance can be sent if all mandatory items of the instance are currently completed and the participant has been given permission to route in Process Administrator.
Note that only instances in interactive activities can be sent. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to route; cannot be null

activityName - name of activity to route to; cannot be null

participant - UID of participant to route to; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NoValidTransitionAvailableException if an instance does not have transition to the target activity.
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance will be sent.

instancesSendTo

void instancesSendTo(InstanceActivityPairSet instanceActivityPairs,
                     String activityName,
                     String participant)
                     throws OperationException,
                            BatchOperationException

Routes a group of instances to the specified activity and participant.

Parameters:

instanceActivityPairs - InstanceSet of Instances to route; cannot be null

activityName - name of activity to route to; cannot be null

participant - UID of participant to route to; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NoValidTransitionAvailableException if an instance does not have transition to the target activity.
- ParticipantNotInTargetRoleException if the target participant does not have the role where the instance will be sent.

instancesSendTo

@Deprecated
void instancesSendTo(InstanceStamp[] instances,
                                String activityName)
                     throws OperationException,
                            BatchOperationException

Deprecated. use instancesSendTo(InstanceActivityPairSet, String) instead

Routes a group of instances to the specified activity.

Parameters:

instances - array of InstanceStamps to route; cannot be null

activityName - name of activity to route to; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NoValidTransitionAvailableException if an instance does not have transition to the target activity.

instancesSendTo

void instancesSendTo(InstanceActivityPairSet instanceActivityPairs,
                     String activityName)
                     throws OperationException,
                            BatchOperationException

Routes a group of instances to the specified activity.

Parameters:

instanceActivityPairs - InstanceSet of Instances to route; cannot be null

activityName - name of activity to route to; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- NoValidTransitionAvailableException if an instance does not have transition to the target activity.

instancesSuspend

@Deprecated
void instancesSuspend(InstanceStamp[] instances)
                      throws OperationException,
                             BatchOperationException

Deprecated. use instancesSuspend(InstanceActivityPairSet) instead

Suspends a group of instances. An instance can be suspended if the interactive activity has been defined as suspendable in Studio, the instance is running, and the participant has been given permission to suspend in Process Administrator
Note that only instances in interactive activities can be suspended. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to suspend; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySuspendedException if an instance is suspended.

instancesSuspend

void instancesSuspend(InstanceActivityPairSet instanceActivityPairs)
                      throws OperationException,
                             BatchOperationException

Parameters:

instanceActivityPairs - InstanceSet of Instances to suspend; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceAlreadySuspendedException if an instance is suspended.

instancesTargetParticipants

@Deprecated
ParticipantsForActivities instancesTargetParticipants(InstanceStamp[] instances)
                                                      throws OperationException,
                                                             BatchOperationException

Deprecated. use instancesGetTargetParticipants(InstanceActivityPairSet) instead

Returns the participants who can receive this array of instances. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to check for participants; cannot be null

Returns:

ParticipantsForActivities that contain the participants for the activities defined in instanceStamps

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.

instancesGetTargetParticipants

@Deprecated
ParticipantsForActivities instancesGetTargetParticipants(InstanceActivityPairSet instanceActivityPairs)
                                                         throws OperationException,
                                                                BatchOperationException

Deprecated. use instancesGetTargetActivities(fuego.papi.collections.InstanceActivityPairSet) and instancesGetTargetParticipantsForActivity(fuego.papi.collections.InstanceActivityPairSet, java.lang.String, java.lang.String, int) instead.

Returns the participants who can receive this array of instances.

Parameters:

instanceActivityPairs - InstanceSet of Instances to check for participants; cannot be null

Returns:

ParticipantsForActivities that contain the participants for the activities defined in instanceStamps

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.

instancesGetTargetParticipantsForActivity

Map instancesGetTargetParticipantsForActivity(InstanceActivityPairSet instanceActivityPairs,
                                              String activityName,
                                              String filter,
                                              int max)
                                              throws OperationException

Returns the participants who can receive the specified group of instances in the specified activity.

Parameters:

instanceActivityPairs - InstanceActivityPairs with the instances to be queried, which must belong to the same process

activityName - the activity name for the activity where the instance will be sent

filter - pattern used to search for the participants

max - maximum number of participants to be returned; if it is exceeded, MaxSizeParticipantsExceededException will be thrown

Returns:

map with the Participant ID as key and the Participant as value

Throws:

OperationException - if the session could not perform the operation
May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process of an instance is not available
InstanceNotFoundException if an instance was not found
InstancesNotFromSameProcessException if not every instance belongs to the same process

instancesGetTargetActivities

fuego.collections.lists.StringList instancesGetTargetActivities(InstanceActivityPairSet instanceActivityPairs)
                                                                throws BatchOperationException

Returns the activities that can receive the specified group of instances.

Parameters:

instanceActivityPairs - set of Instance-Activity pairs with the instances to be queried

Returns:

list of activity names where the specified groups of instances can be sent

Throws:

BatchOperationException - if the session could not perform the operation for each instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstancesNotFromSameProcessException if instances belong to different processes.

instancesGetTargetActivitiesList

ActivityList instancesGetTargetActivitiesList(InstanceActivityPairSet instanceActivityPairs)
                                              throws BatchOperationException

Returns the activities that can receive the specified group of instances.

Parameters:

instanceActivityPairs - set of Instance-Activity pairs with the instances to be queried

Returns:

list of activities where the specified groups of instances can be sent

Throws:

BatchOperationException - if the session could not perform the operation for each instance
May be one of the following subclasses of BatchOperationException:

InstancesException if not all instances are available to perform the operation.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstancesNotFromSameProcessException if instances belong to different processes.

instancesUngrab

@Deprecated
void instancesUngrab(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

Deprecated. use instancesUngrab(InstanceActivityPairSet) instead

Ungrabs a group of instances.

An instance can be ungrabbed if the instance is grabbed and the participant has been given permission to grab in Process Administrator. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to ungrab; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceNotGrabbedException if an instance is not grabbad.
- InstanceSuspendedException if an instance is suspended.

instancesUngrab

void instancesUngrab(InstanceActivityPairSet instanceActivityPairs)
                     throws OperationException,
                            BatchOperationException

Ungrabs a group of instances.

An instance can be ungrabbed if the instance is grabbed and the participant has been given permission to grab in Process Administrator.

Parameters:

instanceActivityPairs - InstanceSet of Instances to ungrab; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceNotRunningException if an instance is not running.
- InstanceNotGrabbedException if an instance is not grabbad.
- InstanceSuspendedException if an instance is suspended.

instancesUnselect

@Deprecated
void instancesUnselect(InstanceStamp[] instances)
                       throws OperationException,
                              BatchOperationException

Deprecated. use instancesUnselect(InstanceActivityPairSet) instead

Unselects a group of instances.

An instance can be unselected if the instance is currently selected by the current participant. This operation is NOT supported in a federated environment.

Parameters:

instances - array of InstanceStamps to unselect; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceSelectedByOtherException if an instance is selected by other participant (not by current participant).

instancesUnselect

void instancesUnselect(InstanceActivityPairSet instanceActivityPairs)
                       throws OperationException,
                              BatchOperationException

Unselects a group of instances.

An instance can be unselected if the instance is currently selected by the current participant.

Parameters:

instanceActivityPairs - InstanceSet of Instances to unselect; cannot be null

Throws:

OperationException - if the session could not perform the operation

BatchOperationException - if the session could not perform the operation for each instance May be one of the following subclasses of BatchOperationException:

InstancesException if the session could not perform the operation on every instance.
You can find inside the batch exception:
- InstanceOperationException if the operation fails on an instance.
- InstanceNotFoundException if an instance not exist.
- InstanceNotInActivityException if an instance is no longer in activity where the stamp specify.
- InstanceSelectDisableException if an instance can not be reassigned because the activity where the instance is can not be select.
- InstanceNotRunningException if an instance is not running.
- InstanceSelectedByOtherException if an instance is selected by other participant (not by current participant).

obtainEditionLock

@Deprecated
void obtainEditionLock(Attachment attachment)
                       throws OperationException

Deprecated. use attachmentEdit(Attachment) instead

Obtains a version lock for the attachment.

To write the checked-out attachment to a file, use checkOutAttachment(Attachment, String).
To write the checked-out attachment to an OutputStream, use checkOutAttachmentToStream(Attachment, java.io.OutputStream).

Parameters:

attachment - attachment to receive the lock; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the version lock fails

attachmentEdit

void attachmentEdit(Attachment attachment)
                    throws OperationException

Obtains a version lock for the attachment.

Parameters:

attachment - attachment to acquire the lock for; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the version lock fails

attachmentEdit

void attachmentEdit(String attachmentId)
                    throws OperationException

Obtains a version lock for the attachment.

Parameters:

attachmentId - id of the attachment to acquire the lock for; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the version lock fails

prepareExternalActivity

@Deprecated
Arguments prepareExternalActivity(String instanceStampId,
                                             int taskIn,
                                             Arguments args)
                                  throws OperationException

Deprecated. use activityPrepare(String, String, Arguments) instead

Executes the prepare method of an external activity for the task given an instanceStampId and task identification number. This operation is NOT supported in a federated environment.

Parameters:

instanceStampId - instance stamp ID that identifies the target instance; cannot be null

taskIn - task identification number of the task to execute

args - input arguments passed to the external activity; null means no arguments

Returns:

Arguments returned by the external activity

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

prepareExternalActivity

@Deprecated
Arguments prepareExternalActivity(String instanceId,
                                             String activityName,
                                             int taskIn,
                                             Arguments args)
                                  throws OperationException

Deprecated. use activityPrepare(String, String, Arguments) instead

Executes the prepare method for the specified task of the activity given an instanceId, activityId, and task identification number.

Parameters:

instanceId - ID that identifies the target instance; cannot be null

activityName - name of the target activity; cannot be null

taskIn - task identification number of the task to execute

args - input arguments passed to the external activity; null means no arguments

Returns:

Arguments returned by the external activity

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPrepare

Arguments activityPrepare(String activityName,
                          String instanceId,
                          Arguments args)
                          throws OperationException

Executes the prepare method for the main task of the activity given an instanceId and an activityId.

Parameters:

activityName - name of the target activity; cannot be null

instanceId - ID that identifies the target instance; cannot be null

args - input arguments passed to the external activity; null means no arguments

Returns:

Arguments returned by the external activity

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

activityPrepare

Arguments activityPrepare(Activity activity,
                          InstanceInfo instance,
                          Arguments args)
                          throws OperationException

Executes the prepare method for the main task of the activity given an instanceId and an activityId.

Parameters:

activity - the target activity; cannot be null

instance - the target instance; cannot be null

args - input arguments passed to the external activity; null means no arguments

Returns:

Arguments returned by the external activity

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

releaseEditionLock

@Deprecated
void releaseEditionLock(Attachment attachment,
                                   File file)
                        throws OperationException

Deprecated. use attachmentRelease(Attachment, File) instead

Releases the version lock for the attachment and deletes the specified file. Releasing a version lock is also known as undo checkout.

Parameters:

attachment - the version lock on the attachment will be released; cannot be null

file - local file to be removed; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the lock release fails

attachmentRelease

void attachmentRelease(Attachment attachment,
                       File file)
                       throws OperationException

Releases the version lock for the attachment and deletes the specified file. Releasing a version lock is also known as undo checkout.

Parameters:

attachment - the version lock on the attachment will be released; cannot be null

file - local file to be removed; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the lock release fails

releaseEditionLock

@Deprecated
void releaseEditionLock(Attachment attachment)
                        throws OperationException

Deprecated. use attachmentRelease(Attachment) instead

Releases the version lock for the attachment. Releasing a version lock is also known as undo checkout.

Parameters:

attachment - the version lock will be released for the attachment; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the lock release fails

attachmentRelease

void attachmentRelease(Attachment attachment)
                       throws OperationException

Releases the version lock for the attachment. Releasing a version lock is also known as undo checkout.

Parameters:

attachment - the version lock will be released for the attachment; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the lock release fails

attachmentRelease

void attachmentRelease(String attachmentId)
                       throws OperationException

Releases the version lock for the attachment. Releasing a version lock is also known as undo checkout.

Parameters:

attachmentId - the version lock will be released for the attachment with the specified Id; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
AttachmentOperationException if the lock release fails

removeBookmarks

@Deprecated
void removeBookmarks(InstanceStamp[] instancesStamp)
                     throws OperationException

Deprecated. use instancesRemoveBookmark(InstanceActivityPairSet) instead

Removes bookmarks. This operation is NOT supported in a federated environment.

Parameters:

instancesStamp - array of InstanceStamps to remove from the bookmarks; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available

instancesRemoveBookmark

void instancesRemoveBookmark(InstanceActivityPairSet instanceActivityPairs)
                             throws OperationException

Removes bookmarks.

Parameters:

instanceActivityPairs - InstanceSet of Instances to remove from the bookmarks; cannot be null

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available

removePresentation

@Deprecated
void removePresentation(String presentationId)
                        throws OperationException

Deprecated. use presentationRemove(String) instead

Removes the presentation specified by presentationId.

Parameters:: presentationId - ID of presentation to remove; if the ID does not match a presentation, this method will have no effect; if a view referenced the specified presentationId, the view will be set to use the default presentation ID; default presentation IDs cannot be removed
Throws:: OperationException - if the session could not perform the operation

presentationRemove

void presentationRemove(String presentationId)
                        throws OperationException

Removes the presentation specified by presentationId.

Parameters:: presentationId - ID of presentation to remove; if the ID does not match a presentation, this method will have no effect; if a view referenced the specified presentationId, the view will be set to use the default presentation ID; default presentation IDs cannot be removed
Throws:: OperationException - if the session could not perform the operation

removeView

@Deprecated
void removeView(String viewId)
                throws OperationException

Deprecated. use viewRemove(String) instead

Removes the view specified by viewId.

Parameters:

viewId - ID of the view to remove; default views cannot be removed; if the current participant is not the owner of the view, the view will not be removed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ViewHasChildrenException if the view has children which owner is the current participant.

viewRemove

void viewRemove(String viewId)
                throws OperationException

Removes the view specified by viewId.

Parameters:

viewId - ID of the view to remove; default views cannot be removed; if the current participant is not the owner of the view, the view will not be removed

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ViewHasChildrenException if the view has children which owner is the current participant.

runActivity

@Deprecated
InstanceInfo runActivity(String instanceStampId,
                                    Arguments args)
                         throws OperationException

Deprecated. use activityExecute(String, String, Arguments) instead

Executes the main task for the instance given an instanceStampId.

The task cannot interact with the end user. For interactive tasks, use customRunActivity. This operation is NOT supported in a federated environment.

Parameters:

instanceStampId - ID of the InstanceStamp that contains the instance and activity name; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails.
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

runActivity

@Deprecated
InstanceInfo runActivity(String instanceStampId,
                                    int taskIn,
                                    Arguments args)
                         throws OperationException

Deprecated. use activityExecute(String, String, int, Arguments) instead

Executes the activity task number over the instance. This operation is NOT supported in a federated environment.

Parameters:: instanceStampId - Instance stamp id to execute task.; taskIn - Task number of the activity to execute.; args - Arguments to pass the task. Null means no Arguments.
Returns:: instance updated.
Throws:: OperationException - if the operation fails.

runActivity

@Deprecated
InstanceInfo runActivity(String instanceId,
                                    String activityName,
                                    Arguments args)
                         throws OperationException

Deprecated. use activityExecute(String, String, Arguments) instead

Executes the activity task over the instance.

Parameters:: instanceId - Instance to execute task.; activityName - Instance activity name.; args - Arguments to pass the task. Null means no Arguments.
Returns:: instance updated.
Throws:: OperationException - if the operation fails.

activityExecute

InstanceInfo activityExecute(Activity activity,
                             InstanceInfo instance,
                             Arguments args)
                             throws OperationException

Executes the main task for the instance given an instanceStampId.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processes.add(session.processGetAllVersions("/OU/MyProcess");

     InstanceList instances = session.processesInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Get activity
     Process process = session.processGet(instance.getProcessIn());
     Activity activity = process.getActivity("ActivityToExecute");

     // Execute the activity.
     InstanceInfo instance = session.activityExecute(activity, instance, arguments);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activity - the target activity; cannot be null

instance - the target instance; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails.
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

activityExecute

InstanceInfo activityExecute(String activityName,
                             String instanceId,
                             Arguments args)
                             throws OperationException

Executes the main task for the instance given an instanceStampId.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processes.add(session.processGetAllVersions("/OU/MyProcess");
     InstanceList instances = session.processesInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Execute the activity.
     InstanceInfo instance = session.activityExecute(instance.activityName(), instance.getId(), arguments);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activityName - name of the target activity; cannot be null

instanceId - ID that identifies the target instance; cannot be null

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails.
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

activityExecute

InstanceInfo activityExecute(String activityName,
                             String instanceId,
                             int taskToExecute,
                             Arguments args)
                             throws OperationException

Executes the specified task for this instance given an activity, instance identification and a task identification number.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processes.add(session.processGetAllVersions("/OU/MyProcess");
     InstanceList instances = session.processesInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Get activity
     Process process = session.processGet(instance.getProcessIn());
     Activity activity = process.getActivity("ActivityToExecute");
     Task taskToExecute = activity.getTask("TaskToExecute");

     // Execute the activity.
     InstanceInfo instance = session.activityExecute(instance.activityName(), instance.getId(),
                                                     taskToExecute.getIn(), arguments);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activityName - name of the target activity; cannot be null

instanceId - ID that identifies the target instance; cannot be null

taskToExecute - task identification number of the task to execute

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

runActivity

@Deprecated
InstanceInfo runActivity(String instanceId,
                                    String activityName,
                                    int taskIn,
                                    Arguments args)
                         throws OperationException

Deprecated. use activityExecute(String, String, int, Arguments) instead

Executes the specified Task for this instance given an instanceId, activity name, and task identification number.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Parameters:

instanceId - ID of the instance to execute; cannot be null

activityName - name of the activity; cannot be null; the main task of this activity will be executed

taskIn - task identification number of the task to execute

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

activityExecute

InstanceInfo activityExecute(Activity activity,
                             InstanceInfo instance,
                             int taskToExecute,
                             Arguments args)
                             throws OperationException

Executes the specified task for this instance given an activity, instance identification and a task identification number.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processes.add(session.processGetAllVersions("/OU/MyProcess");
     InstanceList instances = session.processesInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Get activity
     Process process = session.processGet(instance.getProcessIn());
     Activity activity = process.getActivity("ActivityToExecute");
     Task taskToExecute = activity.getTask("TaskToExecute");

     // Execute the activity.
     InstanceInfo instance = session.activityExecute(activity, instance,
                                                     taskToExecute.getIn(), arguments);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activity - target activity; cannot be null

instance - target instance; cannot be null

taskToExecute - task identification number of the task to execute

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

activityExecute

InstanceInfo activityExecute(Activity activity,
                             InstanceInfo instance,
                             Task taskToExecute,
                             Arguments args)
                             throws OperationException

Executes the specified task for this instance given an activity, instance identification and a task identification number.

The task cannot interact with the end user. For interactive tasks, use customRunActivity.

Ex.

     // Define the arguments of the activity.
     Arguments arguments = Arguments.create();
     argument.putArgument("MyStringArgument", "StringValue");
     argument.putArgument("MyIntegerArgument", 1000);

     // Search the instance to execute.
     Filter filter = ProcessService.createFilter();
     filter.setMatchAll(true);
     filter.addAttribute(session.getVar("OrderNumber"), Comparison.IS, new Integer(12345));
     filter.addAttribute(session.getVar(VarDefinition.ACTIVITY_ID, Comparison.IS, "ActivityToExecute");

     ProcessIdSet processes = ProcessIdSet.create();
     processes.add(session.processGetAllVersions("/OU/MyProcess");
     InstanceList instances = session.processesInstancesByFilter(processes, filter);
     Instance instance = instances.get(0);

     // Get activity
     Process process = session.processGet(instance.getProcessIn());
     Activity activity = process.getActivity("ActivityToExecute");
     Task taskToExecute = activity.getTask("TaskToExecute");

     // Execute the activity.
     InstanceInfo instance = session.activityExecute(activity, instance, taskToExecute, arguments);

     // Get the output arguments
     String myOutputStringArgument = (String) arguments.getArgument("MyOutputStringArgument");
     String result = (String) arguments.getArgument(Arguments.RESULT);

Parameters:

activity - target activity; cannot be null

instance - target instance; cannot be null

taskToExecute - task to execute

args - arguments to pass to the task; null means no arguments

Returns:

InstanceInfo after task completion

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
InstanceNotInActivityException if the instance is not in the activity
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails
TaskNotFoundException if the task not exist.
InstanceSentByAbortActionException if the instance was aborted after the execution (Instance.action = Action.ABORT).
InstanceSentByBackOrSkipActionException if the instance was sent back or skip (Instance.action = Action.BACK or Instance.action = Action.SKIP).
InstanceSentByThrowException if the instance was sent to exception catcher (by user defined exception).

runGlobal

@Deprecated
InstanceInfo runGlobal(String instanceId,
                                  String activityName,
                                  Arguments args)
                       throws OperationException

Deprecated. use activityExecute(String, String, Arguments) instead

Runs a global activity with instance access.

The global activity cannot interact with the end user. For interactive tasks, use customRunGlobal.

Parameters:

instanceId - ID of instance to execute; cannot be null

activityName - name of activity to execute; cannot be null

args - arguments to pass to the activity; null means no arguments

Returns:

InstanceInfo after the execution of the global activity

Throws:

OperationException - if the session could not perform the operation May be one of the following subclasses of OperationException:

ProcessNotAvailableException if the process is not available
InstanceNotFoundException if the instance does not exist
ActivityNotFoundException if the activity does not exist
NoPermissionException if the participant session does not have the execution permission
ActivityFailedException if the execution fails

storePresentation

@Deprecated
void storePresentation(Presentation presentation)
                       throws OperationException

Deprecated. use presentationStore(Presentation) instead

Stores a presentation.

Parameters:: presentation - presentation to store; cannot be null
Throws:: OperationException - if the session could not perform the operation

presentationStore

void presentationStore(Presentation presentation)
                       throws OperationException

Stores a presentation.

Parameters:: presentation - presentation to store; cannot be null
Throws:: OperationException - if the session could not perform the operation

storeUserProperties

@Deprecated
void storeUserProperties(String category,
                                    Map<String,Object> properties)
                         throws OperationException

Deprecated. use #participantStoreProperties(String, Map) instead

Stores current participant properties.

Parameters:: category - properties category; properties - a Map with all properties to store (Map.key - property key; Map.value - property value).
Throws:: OperationException - if the session could not store the properties.

putSessionProperty

void putSessionProperty(String key,
                        Object value)

Puts PAPI Session scope property.

Parameters:: key - Key used to put the session scope property.; value - The value of the session property.

getSessionProperty

Object getSessionProperty(String key)

Gets PAPI Session scope property.

Parameters:: key - The key that was used to put the property.
Returns:: The PAPI Session scope property with the specified key.

participantStoreProperties

void participantStoreProperties(String category,
                                Map<String,Object> properties)
                                throws OperationException

Stores current participant properties.

Parameters:: category - properties category; properties - a Map with all properties to store (Map.key - property key; Map.value - property value).
Throws:: OperationException - if the session could not store the properties.
java.lang.IllegalArgumentException is properties argument is invalid (e.g.: null)

participantStoreProperty

void participantStoreProperty(String category,
                              String key,
                              Object value)
                              throws OperationException

Stores current participant property.

Parameters:: category - properties category; key - Key for the property being stored; value - Value for the property being stored
Throws:: OperationException - if the session could not store the properties.

storeView

@Deprecated
void storeView(View view)
               throws OperationException

Deprecated. use viewStore(View) instead

Stores the specified view.

Until a view is stored, View.isTransient() will return true and the view will not be retrievable using viewGet(String).

Parameters:: view - view to store; cannot be null
Throws:: OperationException - if the session could not perform the operation

viewStore

void viewStore(View view)
               throws OperationException

Stores the specified view.

Until a view is stored, View.isTransient() will return true and the view will not be retrievable using viewGet(String).

Parameters:: view - view to store; cannot be null
Throws:: OperationException - if the session could not perform the operation

taskCanBeProcessed

boolean taskCanBeProcessed(int taskNumber,
                           String activityName,
                           String instanceId)
                           throws OperationException

Returns true if the specified task for this instance can be executed by the current participant.

A task can be executed if the task is not completed or it has been defined as repeatable in Studio.

Parameters:

taskNumber - task identification number to check

activityName - name of the activity of the task.

instanceId - Instance id of the instance to check; cannot be null

Returns:

true if the specified task for this instance can be executed by the current participant

Throws:

OperationException - if the session could not perform the operation
              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available
              InstanceNotFoundException if the instance does not exist
              InstanceNotInActivityException if the instance is not in the
              activity





taskCanBeProcessed
boolean taskCanBeProcessed(InstanceInfo instance,
                           int taskNumber)

Returns true if the specified task for this instance can be executed by the current participant.
 
 A task can be executed if the task is not completed or it has been defined as repeatable in Studio.





Parameters:
instance - InstanceInfo to check; cannot be null
taskNumber - task identification number to check
Returns:
true if the specified task for this instance can be executed by the current participant






taskCanBeSelected
boolean taskCanBeSelected(int taskNumber,
                          String activityName,
                          String instanceId)
                          throws OperationException

Returns true if the specified task for this instance can be selected by the current participant.
 Note that only process instance items in interactive activities can be selected.





Parameters:
taskNumber - task identification number to check
activityName - name of the activity of the task.
instanceId - Instance id of the instance to check; cannot be null
Returns:
true if the specified task for this instance can be selected by the current participant
Throws:
OperationException - if the session could not perform the operation
              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available
              InstanceNotFoundException if the instance does not exist
              InstanceNotInActivityException if the instance is not in the
              activity
              






taskCanBeSelected
boolean taskCanBeSelected(InstanceInfo instance,
                          int taskNumber)

Returns true if the specified task for this instance can be selected by the current participant.
 Note that only process instance items in interactive activities can be selected.





Parameters:
instance - InstanceInfo to check; cannot be null
taskNumber - task identification number to check
Returns:
true if the specified task for this instance can be selected by the current participant






taskCanBeUnselected
boolean taskCanBeUnselected(int taskNumber,
                            String activityName,
                            String instanceId)
                            throws OperationException

Returns true if the specified task for this instance can be unselected by the current participant.
 Note that only process instance items in interactive activities can be unselected.





Parameters:
taskNumber - task identification number to check
activityName - name of the activity of the task.
instanceId - Instance id of the instance to check; cannot be null
Returns:
true if the specified task for this instance can be unselected by the current participant
Throws:
OperationException - if the session could not perform the operation
              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available
              InstanceNotFoundException if the instance does not exist
              InstanceNotInActivityException if the instance is not in the
              activity
              






taskCanBeUnselected
boolean taskCanBeUnselected(InstanceInfo instance,
                            int taskNumber)

Returns true if the specified task for this instance can be unselected by the current participant.
 Note that only process instance items in interactive activities can be unselected.





Parameters:
instance - InstanceInfo to check; cannot be null
taskNumber - task identification number to check
Returns:
true if the specified task for this instance can be unselected by the current participant






tasksSelect
@Deprecated
void tasksSelect(String instanceId,
                            String activityName,
                            int[] taskNumbers)
                 throws OperationException,
                        BatchOperationException

Deprecated. use tasksSelect(int[], String, String) instead

Selects a process instance item.

 Selected items can only be processed by the participant which has them selected.

 Repeatable process instance items can be selected even if they have already been completed

 Note: Status is not changed to SELECTED when selecting a COMPLETED process instance item.





Parameters:
instanceId - ID of the instance for which tasks will be selected; cannot be null
activityName - name of the activity that containf the tasks to select; cannot be null
taskNumbers - array of task identification numbers to select
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





tasksSelect
void tasksSelect(int[] taskNumbers,
                 String activityName,
                 String instanceId)
                 throws OperationException,
                        BatchOperationException

Selects a process instance item.

 Selected items can only be processed by the participant which has them selected.

 Repeatable process instance items can be selected even if they have already been completed

 Note: Status is not changed to SELECTED when selecting a COMPLETED process instance item.





Parameters:
taskNumbers - array of task identification numbers to select
activityName - name of the activity that containf the tasks to select; cannot be null
instanceId - ID of the instance for which tasks will be selected; cannot be null
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





tasksSelect
void tasksSelect(InstanceInfo instance,
                 int[] taskNumbers)
                 throws OperationException,
                        BatchOperationException

Selects a process instance item.

 Selected items can only be processed by the participant which has them selected.

 Repeatable process instance items can be selected even if they have already been completed

 Note: Status is not changed to SELECTED when selecting a COMPLETED process instance item.





Parameters:
instance - the instance for which tasks will be selected; cannot be null
taskNumbers - array of task identification numbers to select
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





tasksUnselect
@Deprecated
void tasksUnselect(String instanceId,
                              String activityName,
                              int[] taskNumbers)
                   throws OperationException,
                          BatchOperationException

Deprecated. use tasksUnselect(int[], String, String) instead

Uselects this process instance item.

 Process instance items that are not selected by any participant can be processed by any participant
 in the role of the current activity.

 Repeatable process instance items can be selected even if they have already been completed.

 Note: Status is not changed to PENDING when unselecting a COMPLETED process instance item.





Parameters:
instanceId - ID of instance for which tasks will be unselected; cannot be null
activityName - name of the activity that contains the tasks to unselect; cannot be null
taskNumbers - array of task identification numbers to unselect
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





tasksUnselect
void tasksUnselect(int[] taskNumbers,
                   String activityName,
                   String instanceId)
                   throws OperationException,
                          BatchOperationException

Uselects this process instance item.

 Process instance items that are not selected by any participant can be processed by any participant
 in the role of the current activity.

 Repeatable process instance items can be selected even if they have already been completed.

 Note: Status is not changed to PENDING when unselecting a COMPLETED process instance item.





Parameters:
taskNumbers - array of task identification numbers to unselect
instanceId - ID of instance for which tasks will be unselected; cannot be null
activityName - name of the activity that contains the tasks to unselect; cannot be null
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





tasksUnselect
void tasksUnselect(InstanceInfo instance,
                   int[] taskNumbers)
                   throws OperationException,
                          BatchOperationException

Uselects this process instance item.

 Process instance items that are not selected by any participant can be processed by any participant
 in the role of the current activity.

 Repeatable process instance items can be selected even if they have already been completed.

 Note: Status is not changed to PENDING when unselecting a COMPLETED process instance item.





Parameters:
instance - Instance for which tasks will be unselected; cannot be null
taskNumbers - array of task identification numbers to unselect
Throws:
OperationException - if the session could not perform the operation
BatchOperationException - if the session could not perform the operation on every task
              May be one of the following subclasses of BatchOperationException:
              
              TasksException if the session could not perform the
              operation on every task
              





getId
String getId()

Returns the session identification assigned to this session or null
 if this session does not have identification.






Returns:
session id





toString
String toString()

Returns the name of the class.


Overrides:
toString in class Object



Returns:
name of the class





updateUserPassword
@Deprecated
void updateUserPassword(String oldPassword,
                                   String newPassword)
                        throws OperationException

Deprecated. use participantUpdatePassword(String, String) instead

Updates the current participant password.
 
 This method has no effect if isChangeParticipantPasswordSupported() returns false.





Parameters:
oldPassword - old participant password; cannot be null
newPassword - new participant password; cannot be null
Throws:
OperationException - if the session could not perform the operation





participantUpdatePassword
void participantUpdatePassword(String oldPassword,
                               String newPassword)
                               throws OperationException

Updates the current participant password.
 
 This method has no effect if isChangeParticipantPasswordSupported() returns false.





Parameters:
oldPassword - old participant password; cannot be null
newPassword - new participant password; cannot be null
Throws:
OperationException - if the session could not perform the operation





prepareExternalActivity
@Deprecated
Arguments prepareExternalActivity(String instanceId,
                                             String activityName,
                                             Arguments args)
                                  throws OperationException

Deprecated. use activityPrepare(String, String, Arguments) instead

Executes the prepare method for the main task of the activity given an instanceId and an activityId.





Parameters:
instanceId - ID that identifies the target instance; cannot be null
activityName - name of the target activity; cannot be null
args - input arguments passed to the external activity; null means no arguments
Returns:
Arguments returned by the external activity
Throws:
OperationException - if the session could not perform the operation
              May be one of the following subclasses of OperationException:
              
              ProcessNotAvailableException if the process is not available
              InstanceNotFoundException if the instance does not exist
              ActivityNotFoundException if the activity does not exist
              InstanceNotInActivityException if the instance is not in the
              activity
              NoPermissionException if the participant session does not have
              the execution permission
              ActivityFailedException if the execution fails
              





addHistories
@Deprecated
void addHistories(InstanceStamp[] instancesStamp)
                  throws OperationException

Deprecated. 






Throws:
OperationException





instancesAddHistory
void instancesAddHistory(InstanceActivityPairSet instances)
                         throws OperationException






Throws:
OperationException





getSecureEngines
Map<String,?> getSecureEngines()











updateUserLocale
@Deprecated
void updateUserLocale(Locale locale)
                      throws OperationException

Deprecated. use participantUpdateLocale(java.util.Locale) instead

Updates the current participant locale and stores it.





Parameters:
locale - new participant locale;
Throws:
OperationException - if the session could not perform the operation





updateUserTimeZone
@Deprecated
void updateUserTimeZone(TimeZone timeZone)
                        throws OperationException

Deprecated. use participantUpdateTimeZone(java.util.TimeZone)  instead

Updates the current participant time zone and stores it.





Parameters:
timeZone - new participant time zone;
Throws:
OperationException - if the session could not perform the operation





getUserLocale
@Deprecated
Locale getUserLocale()
                     throws OperationException

Deprecated. use participantLocale() instead

Returns the current participant Locale.






Returns:
the current participant locale;
Throws:
OperationException - if the session could not perform the operation





getUserTimeZone
@Deprecated
TimeZone getUserTimeZone()
                         throws OperationException

Deprecated. use participantTimeZone()  instead

Returns the current participant Time Zone.






Returns:
the current participant time zone;
Throws:
OperationException - if the session could not perform the operation





upgradeToAdminSession
ProcessServiceAdminSession upgradeToAdminSession()
                                                 throws NoPermissionException

Creates an administration session based on this ProcessServiceSession.
 The session's participant must be an administrator for this method to succeed.






Returns:
a ProcessServiceAdminSession representing an administration session for the session's participant
Throws:
NoPermissionException - if the session's participant is not an administrator.





objectClassInstanceFetchByName
ObjectClassInstance objectClassInstanceFetchByName(String objectClass,
                                                   String name)
                                                   throws OperationException

Retrieves an instance of the specified object class and name.





Parameters:
objectClass - the object class
name - the object class instance name
Returns:
the instance of the object class with the specified name
Throws:
OperationException - if the administration session could not perform the operation





objectClassInstanceFetchByRolesAndParticipants
ObjectClassInstance[] objectClassInstanceFetchByRolesAndParticipants(String objectClass,
                                                                     String[] roles,
                                                                     String[] participants)
                                                                     throws OperationException

Retrieves an array of instances for the specified object class that is visible to any of the roles and participants.
 This method will retrieve all instances that have at least one of the specified roles or participants. It's not necessary to have assigned all the roles and participants.





Parameters:
objectClass - the object class
roles - the list of roles to filter instances
participants - the list of participants to filter instances
Returns:
the instances of the object class assigned to any of the specified roles or participants.
Throws:
OperationException - if the administration session could not perform the operation





objectClassInstanceFetchByRoles
ObjectClassInstance[] objectClassInstanceFetchByRoles(String objectClass,
                                                      String[] roles)
                                                      throws OperationException

Retrieves an array of instances for the specified object class that is visible to any of the roles.
 This method will retrieve all instances that have at least one of the specified roles. It's not necessary to have assigned all the roles.





Parameters:
objectClass - the object class
roles - the list of roles to filter instances
Returns:
the instances of the object class assigned to any of the specified roles.
Throws:
OperationException - if the administration session could not perform the operation





objectClassInstanceFetchByParticipants
ObjectClassInstance[] objectClassInstanceFetchByParticipants(String objectClass,
                                                             String[] participants)
                                                             throws OperationException

Retrieves an array of instances for the specified object class that is visible to any of the participants.
 This method will retrieve all instances that have at least one of the specified participants. It's not necessary to have assigned all the participants.





Parameters:
objectClass - the object class
participants - the list of participants to filter instances
Returns:
the instances of the object class assigned to any of the specified participants.
Throws:
OperationException - if any error occurs accessing the object





updateSecurityToken
void updateSecurityToken(String tokenType,
                         Object token)

Updates the current session security token type and token.





Parameters:
tokenType - the new token type
token - the new token object














  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  



BPM Process API





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 All Classes








  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






© Copyright 1996-2008 Oracle Corporation

fuego.papi Interface ProcessServiceSession

serialCheck

serialVersionUID

getProcessService

getGlobalActivities

processesGetGlobalActivities

getGlobalActivities

processesGetGlobalActivities

processesGetGlobalActivities

processesGetApplications

getGlobalActivities

getGlobalActivities

instanceHasAttachments

instanceHasAttachments

instanceHasNotes

instanceHasNotes

setCanReceiveMail

participantEnableMailReception

isChangeParticipantPasswordSupported

participantChangePasswordEnabled

getDelegateParticipants

activityGetGrabbableInstances

activityGetGrabbableInstances

instanceGetParticipants

instanceGetParticipants

instanceGetParticipants

instanceGetParticipants

instancesGetParticipants

instancesGetParticipants

attachmentCheckIn

attachmentCheckIn

attachmentCheckOut

getActiveProcessId

processGetActiveVersion

getActiveProcessIdsByView

getActivityDocumentation

activityGetDocumentation

activityGetDocumentation

getActivityForView

viewGetActivity

getAllProcessVersions

getAllProcessVersions

processGetAllVersions

processesGetAllVersions

getApplicationsByView

viewGetApplications

viewGetApplications

getAttachment

attachmentGet

getAttachmentLastVersion

attachmentGetLastVersion

getAttachmentVersions

attachmentGetAllVersions

getAttachmentsByInstance

instanceGetAttachments

instanceGetAttachments

getAttachmentsByView

viewGetAttachments

getBookmarks

instancesGetBookmarks

getCalendar

participantCalendar

getChildrenViews

viewGetChildren

getConsult

instanceGetLastConsult

instanceGetLastConsult

getConsults

instancesGetConsults

setDefaultOrderByForViews

viewsSetDefaultOrder

getDefaultPresentation

presentationGetDefault

getDefaultPresentation

presentationGetDefault

getEditableView

viewEdit

getGrabActivitiesForInstance

instanceGrabbableFrom

instanceGrabbableFrom

fuego.papi
Interface ProcessServiceSession