Package fuego.papi

Provides the classes necessary to interact with a fuego engine from a Java program.

See:
Description

Interface Summary

ActivityView	This class represents a view for instances in a specific activity.
ApplicationsView	This interface represents a view for global activities.
ArgumentSet	This class represents an ArgumentSet defined in the process.
ArgumentSet.Argument	This class represent an argument of an ArgumentSet
Attachment	This interface represent a file attached to the instance
AttachmentInterface
AttachmentsView	This interface represents a view for using attachemts.
BookmarkView	This interface represents a view for marked instances.
Consult	This class represent a Consult over an Instance between Participants.
ConsultationsView	This interface represents a view for consulted instances.
EditableActivityView	This is an ActivityView where you could edit and modify.
EditableApplicationsView	This is an ApplicationsView where you could edit and modify.
EditableAttachmentsView	This is an AttachmentsView where you could edit and modify.
EditableBookmarkView	This is a BookmarkView where you could edit and modify.
EditableConsultationsView	This is a ConsultationsView where you could edit and modify.
EditableFolderView	This is a FolderView where you could edit and modify.
EditableHistoryView	This is a HistoryView where you could edit and modify.
EditableInstancesView	This is an InstancesView where you could edit and modify.
EditablePresentation	This is a Presentation where you could edit and modify.
EditableView	This is a View where you could edit and modify.
Execution
Filter	This interface is used to define a sub set of instances into a process.
FilterAttribute	This interface represent an expression in a Filter.
FolderView	This interface represents a folder.
GlobalExecution
HistoryView	This interface represents a view for procesed instances.
InstancesView
Invocation
MDObject	Contains the methods that must be implemented by any metadata object.
Note
NoteInterface
Presentation
PresentationColumnFormat	PresentationColumnFormat defines the programming interface for formatting locale-sensitive presentation column values into Strings.
Process	Contains the metadata of a particular Process.
ProcessDiagram	This interface represents the diagram of a given process.
ProcessService.Factory
ProcessServiceSession	ProcessServiceSession contains methods for creating, storing and managing views and presentations, for getting activities, attachments, instances, notes, and processes, for adding attachments and notes, and for processing activities and instances.
Task	This class contains the metadata information about an Activity 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	This class represent an Activity into the process.
Arguments
ColumnFormat	ColumnFormat is the format of the presentation column.
ConnectedClientInfo	This class represent a Participant connected to PAPI
EventType	Enumeration of type of events over an instance.
InstanceEvent	Contains a process-instance event basic information.
InstanceId	Contains the declaration of an instance.
InstanceInfo
InstanceItemState	Enumeration of Instance Item State (Task). Contains all valid status values for a process instance item.
InstanceStamp	Deprecated. Use InstanceActivityPair instead.
Ordering
Participant	It represents a Participant, it contains the participant metadata. This information can be obtained from a PAPI session.
Participant.RoleAssignment
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.
Presentation.DefaultPresentationColumnFormat
Priority	Enumeration of instance priorities.
ProcessInstanceState	Enumerates the different process instance's status.
ProcessService	Main class in Process API (PAPI) framework. This service provides the connection with the ALBPM Engine.
SearchScope	This class represent the scope to execute a search over the instances.
VarDefinition	This class contains all the information related with a process variable.

Enum Summary

ColumnFormatType	Enumerates the column format types.
Comparison
ExecutionType
ParticipantFor
ParticipantScope
PresentationType
StatusScope	Enumeration that represents the possible combination of instances status to set in a search filter Possible values are: - ONLY_INPROCESS: Only instances that are In Process - ONLY_COMPLETED: Only instances that are Completed - ONLY_ABORTED: Only instances that are Aborted - INPROCESS_AND_COMPLETED: Instances that are Completed or In Process - INPROCESS_AND_ABORTED: Instances that are In Process or Aborted - ABORTED_AND_COMPLETED: Instances that are Aborted or Completed - ALL: Instances in any status
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	No Exception thrown while executing an engine operation should "travel" to PAPI.
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 a fuego engine from a Java program.

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.