Package fuego.papi

Provides the classes necessary to interact with fuego engine.

See:
Description

Interface Summary

ActivityView	This class represents a view for instances in a specific activity.
ApplicationsView
Attachment
AttachmentInterface
AttachmentsView
BookmarkView
Consult
ConsultationsView
EditableActivityView
EditableApplicationsView
EditableAttachmentsView
EditableBookmarkView
EditableConsultationsView
EditableFolderView
EditableHistoryView
EditableInstancesView
EditablePresentation
EditableView
Execution
Filter
FilterAttribute
FolderView
GlobalExecution
HistoryView
InstancesView
Invocation
MDObject	Contains the methods that must be implemented by any metadata object.
Note
NoteInterface
Presentation
Process	Contains the metadata of a particular Process.
ProcessDiagram	This interface represents the diagram of a given process.
ProcessService.Factory
ProcessServiceNESession
ProcessServiceSession
Task
TaskArgument	A TaskArgument represents an argument of a activity task.
TaskExecution
View	This class is used to show information with a specific representation.

Class Summary

Activity
Arguments
Comparison
ConnectedClientInfo
EventType
EventTypeMsg	Message bundle.
EventTypeMsg_en
EventTypeMsg_es	Message bundle.
InstanceEvent	Contains a process-instance event basic information.
InstanceId	Contains the declaration of an instance.
InstanceInfo
InstanceItemState
InstanceItemStateMsg	Message bundle.
InstanceItemStateMsg_es	Message bundle.
InstanceStamp	This class keeps the minimal information about the Process Instance needed in the engine side in order to perform any operation over an instance. It is needed when an operation over an instance has to be done through PAPI.
Ordering
PapiLogResources	log fuego.resources.papi.LogResources
PapiResources	normal fuego.resources.papi.Resources
Participant	It represents a Participant, it contains the participant metadata. This information can be obtained from a PAPI session.
Participant.RoleAssignment
ParticipantScope
ParticipantsForActivities	Used to match group of Paticipants with Activities.
Presentation.Column	Column contains every attribute for a column, the main idea is to get and keep all the neccesary info, like size and id etc.
PresentationType
Priority
PriorityMsg	Message bundle.
PriorityMsg_en
PriorityMsg_es	Message bundle.
ProcessInstanceState	this class represents the logical state of the instance
ProcessInstanceStateMsg	Message bundle.
ProcessInstanceStateMsg_en
ProcessInstanceStateMsg_es	Message bundle.
ProcessService	Main class in PAPI framework. This service provide the connection with fuego engine and is the one that handle every event. The main use for PAPI users is the creation of sessions (ProcessServiceSession or ProcessServiceNESession) after receiving the participant credential. example: ProcessService processService = ProcessService.create(directoryUrl); ProcessServiceSession session = processService.createSession(userId, userPassword, cacheEnabled);
SearchScope	This class represent the scope to execute a search over the instances.
Status	Deprecated.
StatusScope
VarDefinition	This class contains all the information related with a process variable.
ViewType

Exception Summary

AttachmentOperationException	This exception can be thronw by any method who performs any operation over an Attachment.
BatchOperationException	Class BatchOperationException Exception thrown when not every the object requested are available.
CommunicationException	Exception thrown by any PAPI method who potentionally communicates with another program, such as the Execution Engine or the Directory.
EngineException
EngineRuntimeException	No RuntimeException thrown while executing an engine operation should "travel" to PAPI.
OperationException	Every PAPI method that throw an instance, throws an OperationException, or some heir of this one.
OperationRuntimeException	This exception is thrown for any runtime error while PAPI is running
ParticipantException	This exception is the root for others more specific exceptions thrown during a operation which involves a Participant.
ProcessNotAvailableException	Thrown when a Process is not available.
ProcessOperationException	Thrown when a operation over a Process could not be performed succedfully.
PropertyOperationException	A Property is associated with a participant in the Directory service.
ViewOperationException	Main Class for view exceptions.

Package fuego.papi Description

Provides the classes necessary to interact with fuego engine.

Package Specification

PAPI (Process Aplication Programming Interface) is the API to use when interaction with one or more Fuego Engines is desired. The PAPI classes let you handle processes, instances, attachments, views, participants and activities, and some engine commands.

When you use PAPI you begin by creating a ProcessService, which is necesary to connect and get an instance of ProcessServiceNESession or ProcessServiceSession.
Once you get a session, you can use ProcessServiceSession methods to perform all the operations needed to interact with processes, views, etc.

The rest of the classes in this API are mainly objects containing metadata and all the info requested.

There are several Exceptions too, which contain the word Operation in its name. Those are the super-classes of all the exceptions thrown by PAPI.