fuego.papi
Interface ProcessServiceSession

All Superinterfaces:

ProcessServiceNESession, Serializable

public interface ProcessServiceSession

extends ProcessServiceNESession

Method Summary

void	addBookmarks(InstanceStamp[] instancesStamp)
void	checkInAttachment(Attachment attachment, String remarks, File file) This methods checks in the attachment passed as argument. If successful, this will always generate a new attachment version.
void	checkOutAttachment(Attachment attachment, String directory) This methods checks out an attachment for a given instance.
void	checkOutAttachmentToStream(Attachment attachment, OutputStream stream) This methods checks out an attachment for a given instance to a outputStream
InstanceInfo	commitExternalActivity(String instanceStampId, int taskIn, Arguments args) Executes the commit method of an external activity.
InstanceInfo	commitExternalActivity(String instanceId, String activityName, Arguments args) Executes the commit method of an external activity.
InstanceInfo	commitExternalActivity(String instanceId, String activityName, int taskIn, Arguments args) Executes the commit method of an external activity.
TaskExecution	customRunActivity(String instanceId, String activityName, Arguments args) Executes the activity task over the instance.
TaskExecution	customRunActivity(String instanceId, String activityName, int taskIn, Arguments args) Executes the activity task number over the instance.
TaskExecution	customRunGlobal(String instanceId, String activityName, Arguments args) Executes the activity over the instance.
TaskExecution	customRunTask(String instanceStampId, int taskIn, Arguments args) Executes the activity task number over the instance.
TaskExecution	customRunTask(String instanceId, String activityName, int taskIn, Arguments args) Deprecated. use customRunActivity(String,String,int,Arguments) instead
List	getDelegateParticipants(InstanceStamp instance) Returns a List with participant for the given instance
List	getEscalateParticipants(InstanceStamp instance) Returns a List with participant for the given instance
InstanceInfo[]	getGrabbableInstances(String activityId) This method returns all the instances that can be grabbed from the given grab activity.
List	getParticipantsForInstance(InstanceStamp instance) Returns a List of Participants that user can reassign, the instance, to.
void	instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file) This methods attachs a new file attachment to a process instance.
void	instanceAttach(InstanceInfo instanceInfo, String name, String description, String remarks, File file, String contentType) This methods attachs a new file attachment to a process instance.
boolean	instanceCanBeAborted(InstanceInfo instance) Returns if the given instance can be aborted
boolean	instanceCanBeBack(InstanceInfo instance) Returns if the given instance can be routed back
boolean	instanceCanBeProcessed(InstanceInfo instance) Returns if the given instance can be processed
boolean	instanceCanBeReassign(InstanceInfo instance) Return if the given instance is Reasignable.
boolean	instanceCanBeResumed(InstanceInfo instance) Returns if the given instance can be resumed
boolean	instanceCanBeSelected(InstanceInfo instance) Returns true if the process instance can be selected by the current participant A process instance is selectable if all items are currently unselected or selected by the current participant
boolean	instanceCanBeSent(InstanceInfo instance) Returns if the given instance can be sent
boolean	instanceCanBeSuspended(InstanceInfo instance) Returns if the given instance can be suspended
boolean	instanceCanBeUngrabbed(InstanceInfo instance) Return if the instance is ungrabbed or not
boolean	instanceCanBeUnselected(InstanceInfo instance) Returns if the given instance can be unselected
void	instanceReassign(InstanceStamp instances, String participant) This method REASSIGN the instance to the specify participant.
void	instancesAbort(InstanceStamp[] instances) This method aborts a group of instances, but this is done in the engine side to improve performance
void	instancesAddConsult(InstanceStamp[] instances, String remark, String toParticipant) Adds a consult to this process instance
void	instancesAddNote(InstanceStamp[] instances, String note) Adds a note to this process instance
void	instancesGrab(InstanceStamp[] instances, String grabActivityName) This method grabs a group of instances in an Activity, but this is done in the engine side to improve performance
void	instancesResume(InstanceStamp[] instances) This method resumes a group of instances, but this is done in the engine side to improve performance
void	instancesSelect(InstanceStamp[] instances) This method selects a group of instances, but this is done in the engine side to improve performance
void	instancesSend(InstanceStamp[] instances) This method routes a group of instances, but this is done in the engine side to improve performance
void	instancesSendBack(InstanceStamp[] instances, boolean skip) This method routes back a group of instances, but this is done in the engine side to improve performance
void	instancesSendTo(InstanceStamp[] instances, String activityName) This method routes a group of instances to an Activity, but this is done in the engine side to improve performance.
void	instancesSendTo(InstanceStamp[] instances, String activityName, String participant) This method routes a group of instances to an Activity and for a given Participant, but this is done in the engine side to improve performance
void	instancesSuspend(InstanceStamp[] instances) This method suspends a group of instances, but this is done in the engine side to improve performance
ParticipantsForActivities	instancesTargetParticipants(InstanceStamp[] instances) This method return the participants who can recieve this group of instances
void	instancesUngrab(InstanceStamp[] instances) This method ungrabs a group of instances in an Activity, but this is done in the engine side to improve performance
void	instancesUnselect(InstanceStamp[] instances) This method unselects a group of instances, but this is done in the engine side to improve performance
boolean	isChangeParticipantPasswordSupported() Determines whether the directory supports changing the participant password.
boolean	isExclusive() Returns if this session is exlusive or not.
void	obtainEditionLock(Attachment attachment) This method tries to obtain an edition lock over an attachment for a given participant.
Arguments	prepareExternalActivity(String instanceStampId, int taskIn, Arguments args) Executes the prepare method of an external activity.
Arguments	prepareExternalActivity(String instanceId, String activityName, Arguments args) Executes the prepare method of an external activity.
Arguments	prepareExternalActivity(String instanceId, String activityName, int taskIn, Arguments args) Executes the prepare method of an external activity.
void	releaseEditionLock(Attachment attachment) This methods releases the edition lock over this attachment
void	releaseEditionLock(Attachment attachment, File file) This methods releases the edition lock over this attachment
void	removeBookmarks(InstanceStamp[] instancesStamp)
void	removePresentation(String presentationId) Removes the presentation from the internal table and from the Participant properties.
void	removeView(String viewId) Removes the view from the internal table and from the Participant properties.
InstanceInfo	runActivity(String instanceStampId, Arguments args) Executes the activity task over the instance.
InstanceInfo	runActivity(String instanceStampId, int taskIn, Arguments args) Executes the activity task number over the instance.
InstanceInfo	runActivity(String instanceId, String activityName, Arguments args) Executes the activity task over the instance.
InstanceInfo	runActivity(String instanceId, String activityName, int taskIn, Arguments args) Executes the activity task number over the instance.
InstanceInfo	runGlobal(String instanceId, String activityName, Arguments args) Executes the activity over the instance.
void	runTask(String instanceStampId, int taskIn, Arguments args) Deprecated. use runActivity(String,int,Arguments) instead.
void	runTask(String instanceId, String activityName, int taskIn, Arguments args) Deprecated. use runActivity(String, String, int, Arguments) instead
void	setCanReceiveMail(boolean canReceiveMail) This method sets if the user can receive mail.
void	storePresentation(Presentation presentation) Stores the presentation in an internal table and in the Participant properties (as XML).
void	storeUserProperties(String category, Map properties) Stores user directory properties
void	storeView(View view) Stores the View in an internal table and in the Participant properties.
boolean	taskCanBeProcessed(InstanceInfo instance, int taskNumber) Returns whether or not the process instance item is currently available to be selected, runned or completed by the user logged to the ProcessDirectory Returns true if the process instance item is currently available to be selected, runned or completed by the user logged to the ProcessDirectory
boolean	taskCanBeSelected(InstanceInfo instance, int taskNumber) Returns whether or not this process instance item is selectable.
boolean	taskCanBeUnselected(InstanceInfo instance, int taskNumber) Returns whether or not this process instance item is unselectable.
void	tasksSelect(String instanceId, String activityName, int[] taskNumbers) Selects this process instance item.
void	tasksUnselect(String instanceId, String activityName, int[] taskNumbers) Uselects this process instance item.
String	toString() Returns an about message
void	updateUserPassword(String oldPassword, String newPassword) This method changes the password of the user

Methods inherited from interface fuego.papi.ProcessServiceNESession

addHistories, close, createPresentation, createProcessInstance, createProcessInstance, createView, customRunGlobalActivity, getActiveProcessId, getActiveProcessIdsByView, getActivityDocumentation, getActivityForView, getAllProcessVersions, getApplicationsByView, getAttachment, getAttachmentLastVersion, getAttachmentsByInstance, getAttachmentsByView, getAttachmentVersions, getBookmarks, getCalendar, getChildrenViews, getConsult, getConsults, getDefaultPresentation, getDefaultPresentation, getEditableView, getGlobalActivities, getGlobalActivities, getGlobalActivities, getGlobalActivities, getGrabActivitiesForInstance, getHost, getInstance, getInstance, getInstanceByCorrelation, getInstanceData, getInstanceEvents, getInstanceNotes, getInstances, getInstancesByFilter, getInstancesByView, getLocale, getNote, getNotes, getOrganization, getParentView, getParentViewId, getParticipant, getParticipant, getPresentation, getPresentation, getPresentation, getPresentationIds, getProcess, getProcess, getProcessDiagram, getProcessDiagram, getProcessDiagram, getProcessDocumentation, getProcesses, getProcesses, getProcessId, getProcessId, getProcessIds, getProcessIds, getProcessImage, getProcessIn, getSecureEngines, getTimeZone, getVar, getVars, getView, getViewIds, getVisibleActivities, getWorkingAttachments, hasNewInstances, hasNewInstances, instanceHasAttachments, instanceHasNotes, isOpened, refresh, retrieveRoleProperties, retrieveUserProperties, retrieveUserStringProperty, runGlobalActivity, runGlobalActivity, runProcess, searchParticipantsByName, sendNotification, sendNotification, sendNotification, sendNotification, setDefaultOrderByForViews, setLocale, setTimeZone

Method Detail

setCanReceiveMail

public void setCanReceiveMail(boolean canReceiveMail)
                       throws OperationException

This method sets if the user can receive mail.

Parameters:

canReceiveMail - If true the user can receive mail or if false the user can not mail.

Throws:

OperationException

isChangeParticipantPasswordSupported

public boolean isChangeParticipantPasswordSupported()
                                             throws OperationRuntimeException

Determines whether the directory supports changing the participant password.

Returns:

true if the change password operation is supported by the directory, false otherwise.

Throws:

OperationRuntimeException

getDelegateParticipants

public List getDelegateParticipants(InstanceStamp instance)
                             throws OperationException,
                                    BatchOperationException

Returns a List with participant for the given instance

Parameters:

instance -

Returns:

the list of participants.

Throws:

OperationException

BatchOperationException

getEscalateParticipants

public List getEscalateParticipants(InstanceStamp instance)
                             throws OperationException,
                                    BatchOperationException

Returns a List with participant for the given instance

Parameters:

instance -

Returns:

the list of participants.

Throws:

OperationException

BatchOperationException

isExclusive

public boolean isExclusive()

Returns if this session is exlusive or not.

Specified by:

isExclusive in interface ProcessServiceNESession

getGrabbableInstances

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

This method returns all the instances that can be grabbed from the given grab activity.

Parameters:

activityId - The id of the grab activity.

Returns:

InstanceInfo[] All the instances that can be grabbed from the given activity.

Throws:

OperationException

BatchOperationException

getParticipantsForInstance

public List getParticipantsForInstance(InstanceStamp instance)
                                throws OperationException,
                                       BatchOperationException

Returns a List of Participants that user can reassign, the instance, to.

Parameters:

instance -

Returns:

the list of fuego.papi.Participant.

Throws:

OperationException

BatchOperationException

addBookmarks

public void addBookmarks(InstanceStamp[] instancesStamp)
                  throws OperationException

Throws:

OperationException

checkInAttachment

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

This methods checks in the attachment passed as argument.
If successful, this will always generate a new attachment version.

Parameters:

attachment - The attachment to check in

remarks - The remarks for this new attachment version.

file - The file for the attachment.

Throws:

AttachmentOperationException

OperationException

checkOutAttachment

public void checkOutAttachment(Attachment attachment,
                               String directory)
                        throws OperationException

This methods checks out an attachment for a given instance.

Parameters:

attachment - The attachment to check out.

directory - where the attachment is to be write to.

Throws:

OperationException

checkOutAttachmentToStream

public void checkOutAttachmentToStream(Attachment attachment,
                                       OutputStream stream)
                                throws OperationException

This methods checks out an attachment for a given instance to a outputStream

Parameters:

stream - is where the content will be written to

Throws:

OperationException

commitExternalActivity

public InstanceInfo commitExternalActivity(String instanceStampId,
                                           int taskIn,
                                           Arguments args)
                                    throws OperationException

Executes the commit method of an external activity.

Parameters:

instanceStampId - instance stamp that identifies the target instance

taskIn - task number that we want to execute

args - arguments to be passed to the commit method of the external activity.

Returns:

an InstanceInfo with the state of the instance after execution.

Throws:

OperationException

commitExternalActivity

public InstanceInfo commitExternalActivity(String instanceId,
                                           String activityName,
                                           Arguments args)
                                    throws OperationException

Executes the commit method of an external activity. This method executes the main task of the activity.

Parameters:

instanceId - instance id that identifies the target instance

activityName - activity id where the instance is expected to be

args - arguments to be passed to the commit method of the external activity.

Returns:

an InstanceInfo with the state of the instance after execution.

Throws:

OperationException

commitExternalActivity

public InstanceInfo commitExternalActivity(String instanceId,
                                           String activityName,
                                           int taskIn,
                                           Arguments args)
                                    throws OperationException

Executes the commit method of an external activity.

Parameters:

instanceId - instance id that identifies the target instance

activityName - activity id where the instance is expected to be

taskIn - task number that we want to execute

args - arguments to be passed to the commit method of the external activity.

Returns:

an InstanceInfo with the state of the instance after execution.

Throws:

OperationException

customRunActivity

public TaskExecution customRunActivity(String instanceId,
                                       String activityName,
                                       int taskIn,
                                       Arguments args)
                                throws OperationException

Executes the activity task number over the instance. This methods allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - Instance on which the task must be executed.

activityName - Instance activity name.

taskIn - Task number of the activity to be executed.

args - Arguments to pass the task.

Returns:

TaskExecution object used to continue this execution

Throws:

OperationException

See Also:

customRunActivity(String,String,Arguments)

customRunActivity

public TaskExecution customRunActivity(String instanceId,
                                       String activityName,
                                       Arguments args)
                                throws OperationException

Executes the activity task over the instance. This methods allows a PAPI client to customize client-side invocations. NOTE: if the activity has more than one task use customRunActivity(String,String,int,Arguments)

Parameters:

instanceId - Instance on which the task must be executed.

activityName - Instance activity name.

args - Arguments to pass the task.

Returns:

TaskExecution object used to continue this execution

Throws:

OperationException

See Also:

customRunActivity(String,String,int,Arguments)

customRunGlobal

public TaskExecution customRunGlobal(String instanceId,
                                     String activityName,
                                     Arguments args)
                              throws OperationException

Executes the activity over the instance. This methods allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - Instance on which the activity must be executed.

activityName - Activity name to execute.

args - Arguments to pass the activity. Null means no Arguments.

Returns:

TaskExecution object used to continue this execution

Throws:

OperationException

customRunTask

public TaskExecution customRunTask(String instanceId,
                                   String activityName,
                                   int taskIn,
                                   Arguments args)
                            throws OperationException

Deprecated. use customRunActivity(String,String,int,Arguments) instead

Executes the activity task number over the instance. This methods allows a PAPI client to customize client-side invocations.

Parameters:

instanceId - Instance on which the task must be executed.

activityName - Instance activity name.

taskIn - Task number of the activity to be executed.

args - Arguments to pass the task.

Returns:

TaskExecution object used to continue this execution

Throws:

OperationException

customRunTask

public TaskExecution customRunTask(String instanceStampId,
                                   int taskIn,
                                   Arguments args)
                            throws OperationException

Executes the activity task number over the instance. This methods allows a PAPI client to customize client-side invocations.

Parameters:

instanceStampId - Instance stamp id to execute task.

taskIn - Task number of the activity to execute.

args - Arguments to pass the task.

Returns:

TaskExecution object used to continue this execution

Throws:

OperationException

instanceAttach

public void instanceAttach(InstanceInfo instanceInfo,
                           String name,
                           String description,
                           String remarks,
                           File file)
                    throws NoPermissionException,
                           OperationException,
                           IOException

This methods attachs a new file attachment to a process instance.

Parameters:

instanceInfo - The instance where to attach the file.

name - The name of the attachment.

description - A brief description of the attachment.

remarks - Some remarks to add to the attachment.

file - The file to attach to the given instance.

Throws:

NoPermissionException - If this participant has no permission to attach the file to the instance.

OperationException

IOException

See Also:

instanceAttach(InstanceInfo, String, String, String, java.io.File, String)

instanceAttach

public void instanceAttach(InstanceInfo instanceInfo,
                           String name,
                           String description,
                           String remarks,
                           File file,
                           String contentType)
                    throws NoPermissionException,
                           OperationException,
                           IOException

This methods attachs a new file attachment to a process instance.

Parameters:

instanceInfo - The instance where to attach the file.

name - The name of the attachment.

description - A brief description of the attachment.

remarks - Some remarks to add to the attachment.

file - The file to attach to the given instance.

contentType - The file content type

Throws:

NoPermissionException - If this participant has no permission to attach the file to the instance.

OperationException

IOException

instanceCanBeAborted

public boolean instanceCanBeAborted(InstanceInfo instance)

Returns if the given instance can be aborted

instanceCanBeBack

public boolean instanceCanBeBack(InstanceInfo instance)

Returns if the given instance can be routed back

instanceCanBeProcessed

public boolean instanceCanBeProcessed(InstanceInfo instance)

Returns if the given instance can be processed

instanceCanBeReassign

public boolean instanceCanBeReassign(InstanceInfo instance)

Return if the given instance is Reasignable.

Parameters:

instance -

Returns:

instanceCanBeResumed

public boolean instanceCanBeResumed(InstanceInfo instance)

Returns if the given instance can be resumed

instanceCanBeSelected

public boolean instanceCanBeSelected(InstanceInfo instance)

Returns true if the process instance can be selected by the current participant A process instance is selectable if all items are currently unselected or selected by the current participant

Parameters:

instance -

Returns:

boolean true if the process instance is selectable

instanceCanBeSent

public boolean instanceCanBeSent(InstanceInfo instance)

Returns if the given instance can be sent

instanceCanBeSuspended

public boolean instanceCanBeSuspended(InstanceInfo instance)

Returns if the given instance can be suspended

instanceCanBeUngrabbed

public boolean instanceCanBeUngrabbed(InstanceInfo instance)

Return if the instance is ungrabbed or not

Parameters:

instance - InstanceInfo to test.

instanceCanBeUnselected

public boolean instanceCanBeUnselected(InstanceInfo instance)

Returns if the given instance can be unselected

instanceReassign

public void instanceReassign(InstanceStamp instances,
                             String participant)
                      throws OperationException,
                             BatchOperationException

This method REASSIGN the instance to the specify participant. This can only be done if the activity has tha assign option enebled and the participant who makes the reassigment has the right permissions.

Parameters:

instances - An iterator with the instances to be selected

participant - The participant to asign the instance

Throws:

OperationException

BatchOperationException

instancesAbort

public void instancesAbort(InstanceStamp[] instances)
                    throws OperationException,
                           BatchOperationException

This method aborts a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be aborted

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been aborted

OperationException

instancesAddConsult

public void instancesAddConsult(InstanceStamp[] instances,
                                String remark,
                                String toParticipant)
                         throws OperationException,
                                BatchOperationException

Adds a consult to this process instance

Parameters:

instances -

remark -

toParticipant -

Throws:

NoPermissionException

BatchOperationException

OperationException

instancesAddNote

public void instancesAddNote(InstanceStamp[] instances,
                             String note)
                      throws OperationException,
                             BatchOperationException

Adds a note to this process instance

Parameters:

instances -

note -

Throws:

NoPermissionException

BatchOperationException

OperationException

instancesGrab

public void instancesGrab(InstanceStamp[] instances,
                          String grabActivityName)
                   throws OperationException,
                          BatchOperationException

This method grabs a group of instances in an Activity, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be grabbed

grabActivityName - The activity where to grab the instances from.

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been grabbed

OperationException

instancesResume

public void instancesResume(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

This method resumes a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be resumed

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been resumed

OperationException

instancesSelect

public void instancesSelect(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

This method selects a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be selected

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been selected

OperationException

instancesSend

public void instancesSend(InstanceStamp[] instances)
                   throws OperationException,
                          BatchOperationException

This method routes a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be routed

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been routed

OperationException

instancesSendBack

public void instancesSendBack(InstanceStamp[] instances,
                              boolean skip)
                       throws OperationException,
                              BatchOperationException

This method routes back a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be routed back

skip - A boolean flag to skip or not the activity which threw the exception

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been routed back

OperationException

instancesSendTo

public void instancesSendTo(InstanceStamp[] instances,
                            String activityName,
                            String participant)
                     throws OperationException,
                            BatchOperationException

This method routes a group of instances to an Activity and for a given Participant, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be routed

activityName - The activity where to route the instances

participant - The particpant whose route the instances

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been routed

OperationException

instancesSendTo

public void instancesSendTo(InstanceStamp[] instances,
                            String activityName)
                     throws OperationException,
                            BatchOperationException

This method routes a group of instances to an Activity, but this is done in the engine side to improve performance. This method will not set a participant, all role users can select it.

Parameters:

instances - An iterator with the instances to be routed

activityName - The activity where to route the instances

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been routed

OperationException

instancesSuspend

public void instancesSuspend(InstanceStamp[] instances)
                      throws OperationException,
                             BatchOperationException

This method suspends a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be suspended

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been suspended

OperationException

instancesTargetParticipants

public ParticipantsForActivities instancesTargetParticipants(InstanceStamp[] instances)
                                                      throws OperationException,
                                                             BatchOperationException

This method return the participants who can recieve this group of instances

Parameters:

instances - An iterator with the instances to be queried

Returns:

A ParticipantsForActivities

Throws:

BatchOperationException

OperationException

instancesUngrab

public void instancesUngrab(InstanceStamp[] instances)
                     throws OperationException,
                            BatchOperationException

This method ungrabs a group of instances in an Activity, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be ungrabbed

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been grabBed

OperationException

instancesUnselect

public void instancesUnselect(InstanceStamp[] instances)
                       throws OperationException,
                              BatchOperationException

This method unselects a group of instances, but this is done in the engine side to improve performance

Parameters:

instances - An iterator with the instances to be unselected

Throws:

BatchOperationException - exception containing a map with the exceptions thrown by the instances that could not been unselected

OperationException

obtainEditionLock

public void obtainEditionLock(Attachment attachment)
                       throws OperationException

This method tries to obtain an edition lock over an attachment for a given participant.

Parameters:

attachment - The atachment where to obtain the lock

Throws:

AttachmentEditionNotPossibleException

AttachmentOperationException

OperationException

prepareExternalActivity

public Arguments prepareExternalActivity(String instanceStampId,
                                         int taskIn,
                                         Arguments args)
                                  throws OperationException

Executes the prepare method of an external activity.

Parameters:

instanceStampId - instance stamp that identifies the target instance

taskIn - task number that we want to execute

args - input arguments passed to the external activity.

Returns:

the arguments returned by the external activity

Throws:

OperationException

prepareExternalActivity

public Arguments prepareExternalActivity(String instanceId,
                                         String activityName,
                                         Arguments args)
                                  throws OperationException

Executes the prepare method of an external activity. This method executes the main task of the activity.

Parameters:

instanceId - instance id that identifies the target instance

activityName - activity id where the instance is expected to be

args - input arguments passed to the external activity.

Returns:

the arguments returned by the external activity

Throws:

OperationException

prepareExternalActivity

public Arguments prepareExternalActivity(String instanceId,
                                         String activityName,
                                         int taskIn,
                                         Arguments args)
                                  throws OperationException

Executes the prepare method of an external activity.

Parameters:

instanceId - instance id that identifies the target instance

activityName - activity id where the instance is expected to be

taskIn - task number that we want to execute

args - input arguments passed to the external activity.

Returns:

the arguments returned by the external activity

Throws:

OperationException

releaseEditionLock

public void releaseEditionLock(Attachment attachment,
                               File file)
                        throws OperationException

This methods releases the edition lock over this attachment

Parameters:

attachment - The attachment where to release the lock

file - The local file to be removed

Throws:

OperationException

releaseEditionLock

public void releaseEditionLock(Attachment attachment)
                        throws OperationException

This methods releases the edition lock over this attachment

Parameters:

attachment - The attachment where to release the lock

Throws:

OperationException

removeBookmarks

public void removeBookmarks(InstanceStamp[] instancesStamp)
                     throws OperationException

Throws:

OperationException

removePresentation

public void removePresentation(String presentationId)
                        throws OperationException

Removes the presentation from the internal table and from the Participant properties.

Parameters:

presentationId -

Throws:

OperationException

removeView

public void removeView(String viewId)
                throws OperationException

Removes the view from the internal table and from the Participant properties.

Parameters:

viewId -

Throws:

OperationException

runActivity

public InstanceInfo runActivity(String instanceStampId,
                                Arguments args)
                         throws OperationException

Executes the activity task over the instance.

Parameters:

instanceStampId - Instance stamp id to execute task.

args - Arguments to pass the task. Null means no Arguments.

Throws:

OperationException

See Also:

runActivity(String,int,Arguments), runActivity(String,String,Arguments), runActivity(String,String, int, Arguments)

runActivity

public InstanceInfo runActivity(String instanceStampId,
                                int taskIn,
                                Arguments args)
                         throws OperationException

Executes the activity task number over the instance.

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.

Throws:

OperationException

See Also:

runActivity(String,Arguments), runActivity(String,String,Arguments), runActivity(String,String, int, Arguments)

runActivity

public InstanceInfo runActivity(String instanceId,
                                String activityName,
                                Arguments args)
                         throws OperationException

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.

Throws:

OperationException

See Also:

runActivity(String,String,int,Arguments), #runActivity(String, Arguments)), #runActivity(String, int, Arguments))

runActivity

public InstanceInfo runActivity(String instanceId,
                                String activityName,
                                int taskIn,
                                Arguments args)
                         throws OperationException

Executes the activity task number over the instance.

Parameters:

instanceId - Instance to execute task.

activityName - Instance activity name.

taskIn - Task number of the activity to execute.

args - Arguments to pass the task. Null means no Arguments.

Throws:

OperationException

See Also:

runActivity(String,String,Arguments), #runActivity(String, Arguments)), #runActivity(String, int, Arguments))

runGlobal

public InstanceInfo runGlobal(String instanceId,
                              String activityName,
                              Arguments args)
                       throws OperationException

Executes the activity over the instance.

Parameters:

instanceId - Instance on which the activity must be executed.

activityName - Activity name to execute.

args - Arguments to pass the activity. Null means no Arguments.

Throws:

OperationException

runTask

public void runTask(String instanceId,
                    String activityName,
                    int taskIn,
                    Arguments args)
             throws OperationException

Deprecated. use runActivity(String, String, int, Arguments) instead

Executes the activity task number over the instance.

Parameters:

instanceId - Instance to execute task.

activityName - Instance activity name.

taskIn - Task number of the activity to execute.

args - Arguments to pass the task. Null means no Arguments.

Throws:

OperationException

runTask

public void runTask(String instanceStampId,
                    int taskIn,
                    Arguments args)
             throws OperationException

Deprecated. use runActivity(String,int,Arguments) instead.

Executes the activity task number over the instance.

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.

Throws:

OperationException

storePresentation

public void storePresentation(Presentation presentation)
                       throws OperationException

Stores the presentation in an internal table and in the Participant properties (as XML).

Parameters:

presentation - Presentation to store

Throws:

PropertyOperationException

ViewOperationException - the child InvalidViewTypeException is thrown

OperationException

storeUserProperties

public void storeUserProperties(String category,
                                Map properties)
                         throws OperationException

Stores user directory properties

Specified by:

storeUserProperties in interface ProcessServiceNESession

Parameters:

category -

properties -

Throws:

PropertyOperationException

OperationException

storeView

public void storeView(View view)
               throws OperationException

Stores the View in an internal table and in the Participant properties.

Parameters:

view - view to store

Throws:

PropertyOperationException

ViewOperationException - the child InvalidViewTypeException is thrown

OperationException

taskCanBeProcessed

public boolean taskCanBeProcessed(InstanceInfo instance,
                                  int taskNumber)

Returns whether or not the process instance item is currently available to be selected, runned or completed by the user logged to the ProcessDirectory Returns true if the process instance item is currently available to be selected, runned or completed by the user logged to the ProcessDirectory

Parameters:

instance -

taskNumber -

Returns:

taskCanBeSelected

public boolean taskCanBeSelected(InstanceInfo instance,
                                 int taskNumber)

Returns whether or not this process instance item is selectable. Note that only process instance items in interactive activities can be selected.

Parameters:

instance -

taskNumber -

Returns:

true if the process instance item is selectable

taskCanBeUnselected

public boolean taskCanBeUnselected(InstanceInfo instance,
                                   int taskNumber)

Returns whether or not this process instance item is unselectable. Note that only process instance items in interactive activities can be unselected.

Parameters:

instance -

taskNumber -

Returns:

true if the process instance item is unselectable

tasksSelect

public void tasksSelect(String instanceId,
                        String activityName,
                        int[] taskNumbers)
                 throws OperationException,
                        BatchOperationException

Selects this 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 -

activityName -

taskNumbers -

Throws:

OperationException

BatchOperationException

tasksUnselect

public void tasksUnselect(String instanceId,
                          String activityName,
                          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:

instanceId -

activityName -

taskNumbers -

Throws:

OperationException

BatchOperationException

toString

public String toString()

Returns an about message

Returns:

an about message

updateUserPassword

public void updateUserPassword(String oldPassword,
                               String newPassword)
                        throws OperationException

This method changes the password of the user

Parameters:

oldPassword - Old user password

newPassword - New user password

Throws:

OperationException