Generated by
JDiff

Interface fuego.papi.ProcessServiceSession

Removed interface fuego.papi.ProcessServiceNESession.
Added interface java.io.Serializable.

Removed Methods
TaskExecution customRunTask(String, String, int, Arguments) Executes the activity task number over the instance.
void instancesSendTo(InstanceStamp[], String) This method routes a group of instances to an Activity.
boolean isExclusive() Returns if this session is exlusive or not.
void runTask(String, int, Arguments) Executes the activity task number over the instance.
void runTask(String, String, int, Arguments) Executes the activity task number over the instance.
 

Added Methods
void abortActivity(String, String, int) Locates instance identified by instanceId in activity activityName and aborts the running task identified by taskIn.
void activityAbort(Activity, InstanceId) Locates instance identified by instanceId in activity and aborts the main task.
void activityAbort(Activity, int, InstanceId) Locates instance identified by instanceId in activity and aborts the running task identified by taskIn.
void activityAbort(String, int, String) Locates instance identified by instanceId in activity activityName and aborts the running task identified by taskIn.
void activityAbort(String, String) Locates instance identified by instanceId in activity activityName and aborts the main task.
InstanceInfo activityCommit(Activity, InstanceInfo, Arguments) Executes the commit method of an external activity using the specified activit and the instance.
InstanceInfo activityCommit(String, String, Arguments) Executes the commit method of an external activity using the specified activit name and the instance id.
InstanceInfo activityExecute(Activity, InstanceInfo, Arguments) Executes the main task for the instance given an instanceStampId.
InstanceInfo activityExecute(Activity, InstanceInfo, Task, Arguments) Executes the specified task for this instance given an activity, instance identification and a task identification number.
InstanceInfo activityExecute(Activity, InstanceInfo, int, Arguments) Executes the specified task for this instance given an activity, instance identification and a task identification number.
InstanceInfo activityExecute(String, String, Arguments) Executes the main task for the instance given an instanceStampId.
InstanceInfo activityExecute(String, String, int, Arguments) Executes the specified task for this instance given an activity, instance identification and a task identification number.
InstanceInfo activityExecuteApplication(Activity) Runs the specified Global Activity with no arguments.
InstanceInfo activityExecuteApplication(Activity, 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, String) Runs the specified Global Activity with no arguments.
InstanceInfo activityExecuteApplication(String, String, 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, Locale) Gets the full path to the localized documentation for the specified activityId and Locale.
String activityGetDocumentation(String, String, 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) Returns all the instances that can be grabbed from the activity specified by the activity.
InstanceInfoList activityGetGrabbableInstances(String, String) Returns all the instances that can be grabbed from the activity specified by the activity name and the process id.
TaskExecution activityPost(Activity, InstanceInfo, Arguments) Executes the main task for this instance using an instanceId and activityId.
Allows a PAPI client to customize client-side invocations.
TaskExecution activityPost(Activity, InstanceInfo, int, Arguments) Executes the activity task number over the instance.
TaskExecution activityPost(String, String, Arguments) Executes the main task for this instance using an instanceId and activityId.
Allows a PAPI client to customize client-side invocations.
TaskExecution activityPost(String, String, int, Arguments) 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, Arguments) Runs a global activity and returns a GlobalExecution to complete the activity.
activityPostApplication can have user interaction, whereas runGlobalActivity cannot.
GlobalExecution activityPostApplication(String, String, Arguments) Runs a global activity and returns a GlobalExecution to complete the activity.
activityPostApplication can have user interaction, whereas runGlobalActivity cannot.
Arguments activityPrepare(Activity, InstanceInfo, Arguments) Executes the prepare method for the main task of the activity given an instanceId and an activityId.
Arguments activityPrepare(String, String, Arguments) Executes the prepare method for the main task of the activity given an instanceId and an activityId.
void addHistories(InstanceStamp[])  
void attachmentCheckIn(Attachment, String, File) Checks in an attachment.
If successful, this will always generate a new attachment version.
void attachmentCheckIn(String, String, File) Checks in an attachment.
If successful, this will always generate a new attachment version.
void attachmentCheckOut(Attachment, String) Writes the attachment to the specified folder.
To check out the attachment, first call attachmentEdit(Attachment).
void attachmentCheckOutToStream(Attachment, OutputStream) Writes the attachment to the specified output stream.
To check out the attachment, first call attachmentEdit(Attachment).
void attachmentCheckOutToStream(String, OutputStream) Writes the attachment to the specified output stream.
void attachmentEdit(Attachment) Obtains a version lock for the attachment.
void attachmentEdit(String) Obtains a version lock for the attachment.
Attachment attachmentGet(String) Gets the Attachment for this attachmentId.
AttachmentList attachmentGetAllVersions(String) Gets all the Attachments associated with this attachment.
Attachment attachmentGetLastVersion(String) Gets the last version of the Attachment specified by attachmentId.
void attachmentRelease(Attachment) Releases the version lock for the attachment.
void attachmentRelease(Attachment, File) Releases the version lock for the attachment and deletes the specified file.
void attachmentRelease(String) Releases the version lock for the attachment.
void close() Closes the session.

For reuse this session you need recreate it.

Presentation createPresentation(PresentationType, String, Column[]) Creates a Presentation.
InstanceInfo createProcessInstance(String, Arguments) Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process.
InstanceInfo createProcessInstance(String, String, 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.
EditableView createView(ViewType, String, String[]) Creates an EditableView.
GlobalExecution customRunGlobalActivity(String, Arguments) Runs a global activity and returns a GlobalExecution to complete the activity.
customRunGlobalActivity can have user interaction, whereas runGlobalActivity cannot.
String getActiveProcessId(String) 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".
String[] getActiveProcessIdsByView(View) Gets the ids of the processes that are active in the specified View.
String getActivityDocumentation(String, Locale) Gets the full path to the localized documentation for the specified activityId and Locale.
Activity getActivityForView(ActivityView) Gets the Activity associated with this ActivityView.
String[] getAllProcessVersions(String) Returns all process Id versions for the specified process.
String[] getAllProcessVersions(String[]) Returns all process identifications for the specific processes.
Activity[] getApplicationsByView(ApplicationsView) Returns all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified ApplicationsView.
Attachment getAttachment(String) Gets the Attachment for this attachmentId.
Attachment getAttachmentLastVersion(String) Gets the last version of the Attachment specified by attachmentId.
Attachment[] getAttachmentVersions(String) Gets all the Attachments associated with this attachment.
Attachment[] getAttachmentsByInstance(String) Gets all the Attachments associated with this instance.
Attachment[] getAttachmentsByView(AttachmentsView) Gets the Attachments from this AttachmentsView.
String[] getBookmarks() Gets bookmarks for the current participant.
Calendar getCalendar() Gets the calendar set with the session Locale and TimeZone.
Map getChildrenViews(String) Gets the children views of the view specified by view Id.
Consult getConsult(String) Gets the last Consult associated with the specified instance, or null if there is no consultation.
String[] getConsults() Gets all the Consults for this session.
Presentation getDefaultPresentation(PresentationType) Gets the predefined default Presentation for the specified PresentationType.
Presentation getDefaultPresentation(ViewType) Gets the default Presentation for the specified viewType.
EditableView getEditableView(View) Gets an EditableView from a View.
Activity[] getGlobalActivities(Process[]) Gets all Global Activities (Activity.GLOBAL, Activity.GLOBAL_AUTOMATIC and Activity.GLOBAL_CREATION) for the specified processes.
Activity[] getGlobalActivities(Process[], int, boolean) Gets all the Global Activities for the specified processes, type, and instance access.
Activity[] getGlobalActivities(String[]) Gets all the Global Activities for the specified processIds.
Activity[] getGlobalActivities(String[], int, boolean) Gets all the Global Activities for the specified processes, type, and instance access.
Activity[] getGrabActivitiesForInstance(InstanceInfo) Gets all the grab activities that can grab this instance.
String getHost() Returns the host where the owner of this session is connected from.
String getId() Returns the session identification assigned to this session or null if this session does not have identification.
InstanceInfo getInstance(InstanceStamp) Gets the InstanceInfo specified by this InstanceStamp.
InstanceInfo getInstance(String) Gets the InstanceInfo specified by instanceId.
InstanceInfo getInstanceByCorrelation(String, String, Object[]) Gets the instance specified by the process id, correlation name, and correlation values.
DynamicObject getInstanceData(String) Gets the instance component associated with this instance.
The instance component is the instance of the class generated during the deployment.
InstanceEvent[] getInstanceEvents(String) Returns the InstanceEvents for the specified instanceId.
Note[] getInstanceNotes(String) Gets all the Notes associated with the specified instance.
InstanceInfo[] getInstances(String) Gets the InstanceInfos from the specified Process.
InstanceInfo[] getInstancesByFilter(String[], Filter) Gets InstanceInfos from the specified ProcessIds and match with the specified Filter.
InstanceInfo[] getInstancesByView(InstancesView) Gets the InstanceInfos from the specified instances view.
Locale getLocale() Gets the Locale for this session.
Note getNote(String) Gets the Note specified by this noteId.
String getOrganization() Gets the organization name.
View getParentView(View) Gets the parent View of the specified View.
String getParentViewId(String) Gets the parent id of the specified view.
Participant getParticipant(String) Gets the Participant specified by participantUid.
Participant getParticipant() Gets the Participant for this session.
Presentation getPresentation(PresentationType, String) Gets the Presentation for the specified PresentationType and presentationId.
Presentation getPresentation(ViewType, String) Gets the Presentation for the specified ViewType and presentationId.
Presentation getPresentation(String) Gets the Presentation specified by this presentationId.
String[] getPresentationIds(PresentationType) Gets all the presentationIds for the specified PresentationType.
Process getProcess(String) Returns a Process object for the specified process identification or for the active process if you use the consolidated process id.
Process getProcess(int) Gets the Process for this process identification number.
ProcessDiagram getProcessDiagram(Process) Gets the ProcessDiagram for the specified Process.
ProcessDiagram getProcessDiagram(int) Gets the ProcessDiagram for the specified process by process identification number.
ProcessDiagram getProcessDiagram(String) Gets the ProcessDiagram for the specified processId.
String getProcessDocumentation(String, Locale) Gets the local path of the process documentation, created in Studio, for the specified locale.
String getProcessId(int) Gets the processId from the specified process identification number.
String getProcessId(InstanceInfo) Gets the processId from the specified instanceInfo.
String[] getProcessIds() Gets the Ids of all deployed processes (Active and Deprecated versions) for this session.
String[] getProcessIds(boolean) Gets the Ids of all deployed processes for this session, and optionally only active processes.
String getProcessImage(String) Gets the process image in XML format for the specified processId.
int getProcessIn(String) Gets the process identification number for this processId.
ProcessService getProcessService() Returns the ProcessService used to create this session.
Process[] getProcesses(boolean) Gets all deployed Processes for the session.
Process[] getProcesses(boolean, boolean) Gets all deployed Processes for the session.
(Map<String, ?>getSecureEngines()  
Object getSessionProperty(String) Gets PAPI Session scope property.
TimeZone getTimeZone() Gets the TimeZone for this session.
Locale getUserLocale() Returns the current participant Locale.
TimeZone getUserTimeZone() Returns the current participant Time Zone.
VarDefinition getVar(String) Gets a VarDefinition from the loaded processes in this session.
VarDefinition[] getVars() Returns all the variable definitions from all the processes in this session.
View getView(String) Returns the View specified by viewId.
String[] getViewIds() Gets all the viewIds available to the current participant.
String[] getVisibleActivities(String) Gets all the activities visible to the current participant in the specified process.
Attachment[] getWorkingAttachments(String) Returns all Attachments locked by the current participant in the specified process.
boolean hasNewInstances() Returns true if any view has new instances since the last access to it.
boolean hasNewInstances(String) Returns true if this view has new instances since the last access.
void instanceAttach(InstanceInfo, String, String, String, File, String, Locale) Attaches a file with the specified content type to this process instance.
void instanceAttach(InstanceInfo, String, String, String, File, String, Locale, AttachmentStorageType) Attaches a file with the specified content type to this process instance.
void instanceAttach(String, String, String, String, File, String, Locale) Attaches a file with the specified content type to this process instance.
void instanceAttach(String, String, String, String, File, String, Locale, AttachmentStorageType) Attaches a file with the specified content type to this process instance.
boolean instanceCanBeAborted(String) Returns true if the instance can be aborted.
boolean instanceCanBeDelegated(String) Returns true if the instance can be delegated.
boolean instanceCanBeDelegated(InstanceInfo) Returns true if the instance can be delegated.
boolean instanceCanBeEscalated(String) Returns true if this instance can be escalated.
boolean instanceCanBeEscalated(InstanceInfo) Returns true if this instance can be escalated.
boolean instanceCanBeProcessed(String) Returns true if the instance can be processed.
boolean instanceCanBeReassigned(String) Returns true if the instance can be reassigned.
boolean instanceCanBeReassigned(InstanceInfo) Returns true if the instance can be reassigned.
boolean instanceCanBeReassignedToPeer(String) Returns true if this instance can be reassigned to a peer.
boolean instanceCanBeResumed(String) Returns true if the instance can be resumed.
boolean instanceCanBeSelected(String) Returns true if the instance can be selected by the current participant.
boolean instanceCanBeSent(String) Returns true if the instance can be sent.
boolean instanceCanBeSentBack(String) Returns true if the instance can be routed back.
boolean instanceCanBeSentBack(InstanceInfo) Returns true if the instance can be routed back.
boolean instanceCanBeSuspended(String) Returns true if the instance can be suspended.
boolean instanceCanBeUngrabbed(String) Returns true if the instance can be ungrabbed.
boolean instanceCanBeUnselected(String) 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) Gets all the Attachments associated with this instance.
AttachmentList instanceGetAttachments(String) Returns an array with all the attachments related with the passed instance.
DynamicObject instanceGetData(InstanceInfo) Gets the instance component associated with this instance.
The instance component is the instance of the class generated during the deployment.
DynamicObject instanceGetData(String) 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) Returns the InstanceEvents for the specified instance.
InstanceEventList instanceGetEvents(String) Returns the InstanceEvents for the specified instanceId.
ActivityList instanceGetGlobalActivities(InstanceInfo) Returns all Global activities which can be called for the specified instance.
ActivityList instanceGetGlobalActivities(String) Returns all Global activities which can be called for the specified instance.
Consult instanceGetLastConsult(InstanceInfo) Gets the Consult associated with the specified instanceId, or null if there is no consultation.
Consult instanceGetLastConsult(String) Gets the last Consult associated with the specified instanceId, or null if there is no consultation.
NoteList instanceGetNotes(InstanceInfo) Gets all the Notes associated with the specified instance.
NoteList instanceGetNotes(String) Gets all the Notes associated with the specified instance.
ParticipantList instanceGetParticipants(InstanceInfo, ParticipantFor) Gets a list of participants that the specified instance can be assigned to.
ParticipantList instanceGetParticipants(String, ParticipantFor) Gets a list of participants that the specified instance can be assigned to.
ParticipantList instanceGetParticipants(String, String, ParticipantFor) Gets a list of participants that the specified instance can be assigned to.
String instanceGetProcessId(InstanceInfo) Gets the processId from the specified instanceInfo.
String instanceGetProcessId(String) Gets the processId for the specified InstanceId.
Object instanceGetVariable(InstanceInfo, String) Returns the value of the variable in the given instance.
Object instanceGetVariable(String, String) Returns the value of the variable in the given instance.
ActivityList instanceGrabbableFrom(InstanceInfo) Gets all the grab activities that can grab this instance.
ActivityList instanceGrabbableFrom(String) Gets all the grab activities that can grab this instance.
boolean instanceHasAttachments(InstanceInfo) Returns true if the specified instance has attachments.
boolean instanceHasAttachments(String) Returns true if the specified instance has attachments.
boolean instanceHasNotes(InstanceInfo) Returns true if the specified instance has notes.
boolean instanceHasNotes(String) Returns true if the specified instance has notes.
void instanceLinkExternalAttachment(InstanceInfo, String, AttachmentStorageType) Links an external attachment (stored in an external storage repository) to the instance.
void instanceLinkExternalAttachment(String, String, AttachmentStorageType) Links an external attachment (stored in an external storage repository) to the instance.
void instanceReassign(InstanceInfo, String) Reassigns the instance to the specified participant.
void instanceReassign(String, String, String) Reassigns the instance to the specified participant.
InstanceInfo instanceRefresh(InstanceInfo) Forces the reload of the specified InstanceInfo.
InstanceInfo instanceRefresh(String) Forces the reload of the specified InstanceInfo.
String instanceRetrieveProperty(InstanceInfo, String) Retrieves an instance scope property from the specified instance.
String instanceRetrieveProperty(String, String) Retrieves an instance scope property from the specified instance.
void instanceStoreProperty(InstanceInfo, String, String) Stores an instance scope property in the specified instance.
void instanceStoreProperty(String, String, String) Stores an instance scope property in the specified instance.
void instancesAbort(InstanceActivityPairSet) Aborts the specified instances.
void instancesAddBookmark(InstanceActivityPairSet) Adds bookmarks.
void instancesAddConsult(InstanceActivityPairSet, String, String) Adds consultations for the specified instances for the specified participant.
void instancesAddHistory(InstanceActivityPairSet)  
void instancesAddNote(InstanceActivityPairSet, String) Adds a note to the specified instances.
StringList instancesGetBookmarks() Gets bookmarks for the current participant.
StringList instancesGetConsults() Gets all the Consults for this session.
ParticipantList instancesGetParticipants(InstanceActivityPairSet, ParticipantFor) Gets a list of participants that the specified set of instances can be assigned to.
ActivityList instancesGetTargetActivitiesList(InstanceActivityPairSet) Returns the activities that can receive the specified group of instances.
ParticipantsForActivities instancesGetTargetParticipants(InstanceActivityPairSet) Returns the participants who can receive this array of instances.
void instancesGrab(InstanceActivityPairSet, String) Grabs a group of instances by the specified activity.
void instancesReassign(InstanceActivityPairSet, String) Reassigns the instance to the specified participant.
void instancesRemoveBookmark(InstanceActivityPairSet) Removes bookmarks.
void instancesResume(InstanceActivityPairSet) Resumes a group of instances.
void instancesSelect(InstanceActivityPairSet) Selects a group of instances by the current participant.
void instancesSend(InstanceActivityPairSet) Sends a group of instances.
void instancesSendBack(InstanceActivityPairSet, boolean) Sends back a group of instances.
void instancesSendTo(InstanceActivityPairSet, String, String) Routes a group of instances to the specified activity and participant.
void instancesSendTo(InstanceStamp[], String) Routes a group of instances to the specified activity.
void instancesSendTo(InstanceActivityPairSet, String) Routes a group of instances to the specified activity.
void instancesSuspend(InstanceActivityPairSet) Suspends a group of instances.
void instancesUngrab(InstanceActivityPairSet) Ungrabs a group of instances.
void instancesUnselect(InstanceActivityPairSet) Unselects a group of instances.
boolean isOpened() Returns true if this session is open.
Note noteGet(String) Gets the Note specified by this noteId.
String organization() Gets the organization name.
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) Sets whether or not the current participant can receive mail.
Participant participantFind(String) Gets the Participant specified by participantUid.
ParticipantList participantFindByName(String) 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) Returns a Map with all participant properties for the specified category.
String participantRetrieveProperty(String, String) Returns a participant property.
void participantStoreProperties(String, Map<String, Object>) Stores current participant properties.
void participantStoreProperty(String, String, Object) Stores current participant property.
TimeZone participantTimeZone() Gets the TimeZone for the current participant.
void participantUpdateLocale(Locale) Updates the current participant locale and stores it.
void participantUpdatePassword(String, String) Updates the current participant password.
void participantUpdateTimeZone(TimeZone) Updates the current participant time zone and stores it.
Presentation presentationCreate(PresentationType, String, Column[]) Creates a Presentation.
Presentation presentationGet(PresentationType, String) Gets the Presentation for the specified PresentationType and presentationId.
Presentation presentationGet(ViewType, String) Gets the Presentation for the specified ViewType and presentationId.
Presentation presentationGet(String) Gets the Presentation specified by this presentationId.
Presentation presentationGetDefault(PresentationType) Gets the predefined default Presentation for the specified PresentationType.
Presentation presentationGetDefault(ViewType) Gets the default Presentation for the specified viewType.
Presentation presentationRefresh(String) Forces the reload of the specified Presentation.
void presentationRemove(String) Removes the presentation specified by presentationId.
void presentationStore(Presentation) Stores a presentation.
StringList presentationsGetIds(PresentationType) Gets all the presentationIds for the specified PresentationType.
InstanceInfo processCreateInstance(String, Arguments) Creates a new process instance by running the Begin activity with the specified Arguments in the specified Process.
InstanceInfo processCreateInstance(String, String, 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.
Process processGet(String) Returns a Process object for the specified process identification or for the active process if you use the consolidated process id.
Process processGet(int) Gets the Process for this process identification number.
String processGetActiveVersion(String) 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".
StringList processGetAllVersions(String) Returns all process Id versions for the specified process.
ProcessDiagram processGetDiagram(Process) Gets the ProcessDiagram for the specified process.
ProcessDiagram processGetDiagram(String) Gets the ProcessDiagram for the specified processId.
String processGetDocumentation(String, Locale) Gets the local path of the process documentation, created in Studio, for the specified locale.
String processGetId(int) Gets the processId from the specified process identification number.
int processGetIn(String) Gets the process identification number for this processId.
InstanceInfo processGetInstance(String) Gets the InstanceInfo specified by instanceId.
InstanceInfo processGetInstance(String, String) Gets the InstanceInfo specified by this Instance identification and the activity where the instance is supposed to be.
InstanceInfo processGetInstanceByCorrelation(String, String, Object[]) Gets the instance specified by the process id, correlation name, and correlation values.
InstanceInfoList processGetInstances(String) Gets the InstanceInfos from the specified Process or Consolidated Process.
ActivityList processGetVisibleActivities(String) Gets all the activities visible to the current participant in the specified process.
AttachmentList processGetWorkingAttachments(String) Returns all Attachments locked by the current participant in the specified process.
void processRun(String, String, Arguments, long) 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, String, String, Arguments) Sends a external notification to a process instance.
void processSendNotification(String, String, String, Arguments, String) Sends a notification to a process in a parent/child relationship or for an external wait/interruption with the specified argument set.
ProcessList processesGet(boolean) Gets all deployed Processes for the session.
ProcessList processesGet(boolean, boolean) Gets all deployed Processes for the session.
StringList processesGetAllVersions(ProcessIdSet) Returns all process identifications for the specific processes.
ActivityList processesGetApplications(ProcessIdSet) Gets all the Interactive Global Activities for the specified processes, not include Global Automatic and Global with instance access.
ActivityList processesGetGlobalActivities(ProcessIdSet) Gets all Global Activities (Activity.GLOBAL, Activity.GLOBAL_AUTOMATIC and Activity.GLOBAL_CREATION) for the specified processes.
ActivityList processesGetGlobalActivities(ProcessIdSet, boolean) Gets all Global Activities (Activity.GLOBAL, Activity.GLOBAL_AUTOMATIC and Activity.GLOBAL_CREATION) for the specified processes and instance access.
ActivityList processesGetGlobalActivities(ProcessIdSet, int, boolean) Gets all the Global Activities for the specified processes, type, and instance access.
StringList processesGetIds() Gets the Ids of all deployed processes (Active and Deprecated versions) for this session.
StringList processesGetIds(boolean) Gets the Ids of all deployed processes for this session, and optionally only active processes.
InstanceInfoList processesGetInstancesByFilter(ProcessIdSet, Filter) Gets InstanceInfos from the specified ProcessIds and match with the specified Filter.
void putSessionProperty(String, Object) Puts PAPI Session scope property.
void refresh(InstanceInfo) Forces the reload of the specified InstanceInfo.
Map retrieveRoleProperties(String, String) Returns a Map with all properties for the specified category for the specified role.
Map retrieveUserProperties(String) Returns a Map with all participant properties for the specified category.
String retrieveUserStringProperty(String, String) Returns a participant property.
Map roleRetrieveProperties(String, String) Returns a Map with all properties for the specified category for the specified role.
InstanceInfo runGlobalActivity(String) Runs the specified Global Activity with no arguments.
InstanceInfo runGlobalActivity(String, 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).

void runProcess(String, String, Arguments, long) Creates a new process instance in the specified Process and waits for the instance to reach the End activity up to the specified timeout.
Participant[] searchParticipantsByName(String) Returns an array of Participants that match the specified name using a substring search.
void sendNotification(String, String, String, Arguments) Sends a external notification to a process instance.
void sendNotification(String, String, String, Arguments, String) Sends a notification to a process in a parent/child relationship or for an external wait/interruption with the specified argument set.
void setDefaultOrderByForViews(String, boolean) Sets the default sort order for instance views.
void setLocale(Locale) Sets the locale for this session for receiving messages from PAPI.
void setTimeZone(TimeZone) Sets the TimeZone.
boolean taskCanBeProcessed(int, String, String) Returns true if the specified task for this instance can be executed by the current participant.
boolean taskCanBeSelected(int, String, String) Returns true if the specified task for this instance can be selected by the current participant.
boolean taskCanBeUnselected(int, String, String) Returns true if the specified task for this instance can be unselected by the current participant.
void tasksSelect(InstanceInfo, int[]) 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[], String, String) 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 tasksUnselect(InstanceInfo, int[]) 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[], String, String) 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 updateUserLocale(Locale) Updates the current participant locale and stores it.
void updateUserTimeZone(TimeZone) Updates the current participant time zone and stores it.
ProcessServiceAdminSession upgradeToAdminSession() Creates an administration session based on this ProcessServiceSession.
VarDefinition variableGet(String) 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, String, String[]) Creates an EditableView.
EditableView viewEdit(View) Gets an EditableView from a View.
View viewGet(String) Returns the View specified by viewId.
ActivityList viewGetActivity(ActivityView) Gets all versions of the Activity associated with this ActivityView.
ActivityList viewGetApplications(ApplicationsView) Returns all Global Activities (Activity.GLOBAL and Activity.GLOBAL_CREATION) for the specified ApplicationsView.
ActivityList viewGetApplications(String) Returns all the Global Activities for a given ApplicationsView
AttachmentList viewGetAttachments(AttachmentsView) Gets the Attachments from this AttachmentsView.
(Map<String, View>viewGetChildren(String) Gets the children views of the view specified by view Id.
InstanceInfoList viewGetInstances(InstancesView) Gets the InstanceInfos from the specified instances view.
InstanceInfoList viewGetInstances(String) Gets the InstanceInfos from the specified instances view.
View viewGetParent(View) Gets the parent View of the specified View.
View viewGetParent(String) Gets the parent View of the specified View.
String viewGetParentId(String) Gets the parent id of the specified view.
boolean viewHasNewInstances(String) Returns true if this view has new instances since the last access.
View viewRefresh(String) Forces the reload of the specified View.
void viewRemove(String) Removes the view specified by viewId.
void viewStore(View) Stores the specified view.
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, boolean) Sets the default sort order for instance views.
 

Changed Methods
void addBookmarks(InstanceStamp[]) Now deprecated.
use {@link #instancesAddBookmark(InstanceActivityPairSet)} instead
void checkInAttachment(Attachment, String, File) Now deprecated.
use {@link #attachmentCheckIn(Attachment, String, File)} instead
void checkOutAttachment(Attachment, String) Now deprecated.
use {@link #attachmentCheckOut(Attachment, String)} instead
void checkOutAttachmentToStream(Attachment, OutputStream) Now deprecated.
use {@link #attachmentCheckOutToStream(Attachment, OutputStream)} instead
TaskExecution customRunGlobal(String, String, Arguments) Now deprecated.
use {@link #activityPost(String, String, Arguments)} instead
List getDelegateParticipants(InstanceStamp) Now deprecated.
use {@link #instanceGetParticipants(String, String, ParticipantFor)} instead.
[instanceGetParticipants(quote_cHaR/OU/ProcessName#Default-1.0/1/0quote_cHaR, quote_cHaRMyActivityquote_cHaR, ParticipantFor.DELEGATE)]
List getEscalateParticipants(InstanceStamp) Now deprecated.
use {@link #instanceGetParticipants(String, String, ParticipantFor)} instead.
[instanceGetParticipants(quote_cHaR/OU/ProcessName#Default-1.0/1/0quote_cHaR, quote_cHaRMyActivityquote_cHaR, ParticipantFor.ESCALATE)]
InstanceInfo[] getGrabbableInstances(String) Now deprecated.
{@link #activityGetGrabbableInstances(String, String)} instead.
List getParticipantsForInstance(InstanceStamp) Now deprecated.
use {@link #instanceGetParticipants(String, String, ParticipantFor)} instead.
[instanceGetParticipants(quote_cHaR/OU/Process#Default-1.0/1/0quote_cHaR, quote_cHaRMyActivityquote_cHaR, ParticipantFor.REASSIGN)]
boolean instanceCanBeBack(InstanceInfo) Now deprecated.
use {@link #instanceCanBeSentBack(InstanceInfo)} instead.
boolean instanceCanBeDelegate(InstanceInfo) Now deprecated.
use {@link #instanceCanBeDelegated(InstanceInfo)} instead.
boolean instanceCanBeEscalate(InstanceInfo) Now deprecated.
use {@link #instanceCanBeEscalated(InstanceInfo)} instead.
boolean instanceCanBeReassign(InstanceInfo) Now deprecated.
use {@link #instanceCanBeReassigned(InstanceInfo)} instead.
StringList instancesGetTargetActivities(InstanceActivityPairSet) Change in return type from List to StringList.
Change in signature from InstanceStamp[] to InstanceActivityPairSet.
Returns the activities that can receive the specified group of instances.
Map instancesGetTargetParticipantsForActivity(InstanceActivityPairSet, String, String, int) Change in signature from (InstanceStamp[], String, String, int) to (InstanceActivityPairSet, String, String, int).
Change in exceptions thrown from (fuego.papi.OperationException, fuego.papi.exception.MaxSizeParticipantsExceededException, fuego.papi.exception.NoParticipantMatchesRole) to fuego.papi.OperationException.
Returns the participants who can receive the specified group of instances in the specified activity.
ParticipantsForActivities instancesTargetParticipants(InstanceStamp[]) Now deprecated.
use {@link #instancesGetTargetParticipants(InstanceActivityPairSet)} instead
boolean isChangeParticipantPasswordSupported() Now deprecated.
use {@link #participantChangePasswordEnabled()} instead
void obtainEditionLock(Attachment) Now deprecated.
use {@link #attachmentEdit(Attachment)} instead
void removeBookmarks(InstanceStamp[]) Now deprecated.
use {@link #instancesRemoveBookmark(InstanceActivityPairSet)} instead
void removePresentation(String) Now deprecated.
use {@link #presentationRemove(String)} instead
void removeView(String) Now deprecated.
use {@link #viewRemove(String)} instead
InstanceInfo runGlobal(String, String, Arguments) Now deprecated.
use {@link #activityExecute(String, String, Arguments)} instead
void setCanReceiveMail(boolean) Now deprecated.
use {@link #participantEnableMailReception(boolean)} instead
void storePresentation(Presentation) Now deprecated.
use {@link #presentationStore(Presentation)} instead
void storeUserProperties(String, Map<String, Object>) Change in signature from (String, Map) to (String, Map<String, Object>).
Now deprecated.
use {@link #participantStoreProperties(String, Map)} instead
void storeView(View) Now deprecated.
use {@link #viewStore(View)} instead
void updateUserPassword(String, String) Now deprecated.
use {@link #participantUpdatePassword(String, String)} instead
InstanceInfo commitExternalActivity(String, int, Arguments) Now deprecated.
use {@link #activityCommit(String, String, Arguments)} instead
InstanceInfo commitExternalActivity(String, String, Arguments) Now deprecated.
use {@link #activityCommit(String, String, Arguments)} instead
InstanceInfo commitExternalActivity(String, String, int, Arguments) Now deprecated.
use {@link #activityCommit(String, String, Arguments)} instead.
TaskExecution customRunActivity(String, String, Arguments) Now deprecated.
use {@link #activityPost(String, String, Arguments)} instead
TaskExecution customRunActivity(String, String, int, Arguments) Now deprecated.
use {@link #activityPost(String, String, int, Arguments)} instead
TaskExecution customRunTask(String, int, Arguments) Now deprecated.
use {@link #activityPost(String, String, int, Arguments)} instead.
void instanceAttach(InstanceInfo, String, String, String, File) Change in exceptions: fuego.papi.exception.NoPermissionException was removed..
Attaches a file attachment to this process instance.
void instanceAttach(InstanceInfo, String, String, String, File, String) Change in exceptions: fuego.papi.exception.NoPermissionException was removed..
Attaches a file with the specified content type to this process instance.
void instanceReassign(InstanceStamp, String) Now deprecated.
use {@link #instanceReassign(String, String, String)} instead
void instancesAbort(InstanceStamp[]) Now deprecated.
use {@link #instancesAbort(InstanceActivityPairSet)} instead
void instancesAddConsult(InstanceStamp[], String, String) Now deprecated.
use {@link #instancesAddConsult(InstanceActivityPairSet, String, String)} instead
void instancesAddNote(InstanceStamp[], String) Now deprecated.
use {@link #instancesAddNote(InstanceActivityPairSet, String)} instead
void instancesGrab(InstanceStamp[], String) Now deprecated.
use {@link #instancesGrab(InstanceActivityPairSet, String)} instead
void instancesResume(InstanceStamp[]) Now deprecated.
use {@link #instancesResume(fuego.papi.collections.InstanceActivityPairSet)} instead
void instancesSelect(InstanceStamp[]) Now deprecated.
use {@link #instancesSelect(fuego.papi.collections.InstanceActivityPairSet)} instead
void instancesSend(InstanceStamp[]) Now deprecated.
use {@link #instancesSend(InstanceActivityPairSet)} instead
void instancesSendBack(InstanceStamp[], boolean) Now deprecated.
use {@link #instancesSendBack(InstanceActivityPairSet, boolean)} instead
void instancesSendTo(InstanceStamp[], String, String) Now deprecated.
use {@link #instancesSendTo(InstanceActivityPairSet, String, String)} instead
void instancesSuspend(InstanceStamp[]) Now deprecated.
use {@link #instancesSuspend(InstanceActivityPairSet)} instead
void instancesUngrab(InstanceStamp[]) Now deprecated.
use {@link #instancesUngrab(InstanceActivityPairSet)} instead
void instancesUnselect(InstanceStamp[]) Now deprecated.
use {@link #instancesUnselect(InstanceActivityPairSet)} instead
Arguments prepareExternalActivity(String, int, Arguments) Now deprecated.
use {@link #activityPrepare(String, String, Arguments)} instead
Arguments prepareExternalActivity(String, String, Arguments) Now deprecated.
use {@link #activityPrepare(String, String, Arguments)} instead
Arguments prepareExternalActivity(String, String, int, Arguments) Now deprecated.
use {@link #activityPrepare(String, String, Arguments)} instead
void releaseEditionLock(Attachment) Now deprecated.
use {@link #attachmentRelease(Attachment)} instead
void releaseEditionLock(Attachment, File) Now deprecated.
use {@link #attachmentRelease(Attachment, File)} instead
InstanceInfo runActivity(String, Arguments) Now deprecated.
use {@link #activityExecute(String, String, Arguments)} instead
InstanceInfo runActivity(String, int, Arguments) Now deprecated.
use {@link #activityExecute(String, String, int, Arguments)} instead
InstanceInfo runActivity(String, String, Arguments) Now deprecated.
use {@link #activityExecute(String, String, Arguments)} instead
InstanceInfo runActivity(String, String, int, Arguments) Now deprecated.
use {@link #activityExecute(String, String, int, Arguments)} instead
void tasksSelect(String, String, int[]) Now deprecated.
use {@link #tasksSelect(int[], String, String)} instead
void tasksUnselect(String, String, int[]) Now deprecated.
use {@link #tasksUnselect(int[], String, String)} instead
 

Added Fields
long serialCheck  
long serialVersionUID