Fuego Process API
A B C D E F G H I L M N O P R S T U V W Y

A

ABORTED - Static variable in class fuego.papi.ProcessInstanceState
 
ABORTED_AND_COMPLETED - Static variable in class fuego.papi.StatusScope
 
ACTION - Static variable in class fuego.papi.Arguments
argument ACTION contains the value of the predefined instance variable action.
ACTIVITY - Static variable in class fuego.papi.PresentationType
 
ACTIVITY_COMPLETED - Static variable in class fuego.papi.EventType
 
ACTIVITY_COMPLETED - Static variable in class fuego.papi.InstanceItemState
 
ACTIVITY_COMPLETED - Static variable in class fuego.papi.ProcessInstanceState
 
ACTIVITY_DEADLINE_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Activity Deadline"
ACTIVITY_DEADLINE_ID45 - Static variable in class fuego.papi.VarDefinition
 
ACTIVITY_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Activity"
ACTIVITY_ID45 - Static variable in class fuego.papi.VarDefinition
 
ACTIVITY_IN - Static variable in class fuego.papi.EventType
 
ACTIVITY_INSTANCES - Static variable in class fuego.papi.PapiResources
ACTIVITY_INSTANCES
ACTIVITY_INSTANCES - Static variable in class fuego.papi.ViewType
 
ACTIVITY_NOT_ABORTABLE - Static variable in class fuego.papi.exception.NoPermissionException
 
ACTIVITY_NOT_SUSPEND - Static variable in class fuego.papi.exception.NoPermissionException
 
ACTIVITY_OUT - Static variable in class fuego.papi.EventType
 
AFTER - Static variable in class fuego.papi.Comparison
 
AFTER - Static variable in class fuego.papi.PapiResources
AFTER
ALL - Static variable in class fuego.papi.ParticipantScope
 
ALL - Static variable in class fuego.papi.StatusScope
 
ALL_IN_ROLE - Static variable in class fuego.papi.ParticipantScope
 
AND - Static variable in class fuego.papi.PapiResources
AND
ANOTHER_USER_RUN - Static variable in class fuego.papi.exception.NoPermissionException
 
APPLICATIONS - Static variable in class fuego.papi.PapiResources
APPLICATIONS
APPLICATIONS - Static variable in class fuego.papi.PresentationType
 
APPLICATIONS - Static variable in class fuego.papi.ViewType
 
APPLICATIONS_DEFAUTL_ID - Static variable in interface fuego.papi.View
 
ATTACHMENTS - Static variable in class fuego.papi.PapiResources
ATTACHMENTS
ATTACHMENTS - Static variable in class fuego.papi.PresentationType
 
ATTACHMENTS - Static variable in class fuego.papi.ViewType
 
ATTACHMENTS_DEFAULT_ID - Static variable in interface fuego.papi.View
 
ATTACHMENT_DESCRIPTION - Static variable in class fuego.papi.exception.InvalidAttachmentArgumentLengthException
 
ATTACHMENT_FILENAME - Static variable in class fuego.papi.exception.InvalidAttachmentArgumentLengthException
 
ATTACHMENT_REMARK - Static variable in class fuego.papi.exception.InvalidAttachmentArgumentLengthException
 
AUDIT_TRAIL_COMPLETED - Static variable in class fuego.papi.PapiResources
AUDIT_TRAIL_Completed
AUDIT_TRAIL_PROCESSING - Static variable in class fuego.papi.PapiResources
AUDIT_TRAIL_Processing
AUTHOR_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Author" for an Instance
AUTOSELECT - Static variable in class fuego.papi.exception.NoPermissionException
 
AUTO_RESUME_INST - Static variable in class fuego.papi.exception.NoPermissionException
 
AbsentParticipantException - exception fuego.papi.exception.AbsentParticipantException.
An AbsentParticipantException is thrown as a result of an attempt to access an absent participant.
AbsentParticipantException(String) - Constructor for class fuego.papi.exception.AbsentParticipantException
Creates a AbsentParticipantException with the given participant.
AbsentParticipantWithoutReplacementException - exception fuego.papi.exception.AbsentParticipantWithoutReplacementException.
An AbsentParticipantWithoutReplacementException is thrown as a result of an attempt to route an instance/s to a given participant who is absent and has no replacement assigned.
AbsentParticipantWithoutReplacementException(String) - Constructor for class fuego.papi.exception.AbsentParticipantWithoutReplacementException
Creates a AbsentParticipantException with the given participant.
Activity - class fuego.papi.Activity.
 
Activity() - Constructor for class fuego.papi.Activity
 
ActivityFailedException - exception fuego.papi.exception.ActivityFailedException.
A ActivityFailedException is thrown when the activity to create an instance failed.
ActivityNotFoundException - exception fuego.papi.exception.ActivityNotFoundException.
A ActivityNotFoundException is thrown as a result of an attempt to access an inexistent activity.
ActivityNotFoundException() - Constructor for class fuego.papi.exception.ActivityNotFoundException
Creates a new ActivityNotFoundException with the default message.
ActivityNotFoundException(String) - Constructor for class fuego.papi.exception.ActivityNotFoundException
Creates a new ActivityNotFoundException with the given activity identification.
ActivityNotFoundException(String, Throwable) - Constructor for class fuego.papi.exception.ActivityNotFoundException
Creates a new ActivityNotFoundException with the given activity identification and the initial exception.
ActivityNotFoundException(String, String) - Constructor for class fuego.papi.exception.ActivityNotFoundException
 
ActivityNotFoundException(String, String, Throwable) - Constructor for class fuego.papi.exception.ActivityNotFoundException
 
ActivityTimeoutException - exception fuego.papi.exception.ActivityTimeoutException.
An ActivityTimeoutException is thrown when the time to execute an activity expired before its execution finished.
ActivityTimeoutException(String, String, Throwable) - Constructor for class fuego.papi.exception.ActivityTimeoutException
Code of the message is 'PAPI-2310'
ActivityUserDisconnectedException - exception fuego.papi.exception.ActivityUserDisconnectedException.
 
ActivityUserDisconnectedException(String, String, Throwable) - Constructor for class fuego.papi.exception.ActivityUserDisconnectedException
 
ActivityUserTimeoutException - exception fuego.papi.exception.ActivityUserTimeoutException.
 
ActivityUserTimeoutException(String, String, Throwable) - Constructor for class fuego.papi.exception.ActivityUserTimeoutException
 
ActivityView - interface fuego.papi.ActivityView.
This class represents a view for instances in a specific activity.
ApplicationsNotAvailableException - exception fuego.papi.exception.ApplicationsNotAvailableException.
Class ApplicationsNotAvailableException This exception is thrown when not all the applications (activities) requested are available, this could happen when not all the processes are available.
ApplicationsNotAvailableException(Activity[], Map) - Constructor for class fuego.papi.exception.ApplicationsNotAvailableException
Constructs a ApplicationsNotAvailableException.
ApplicationsNotAvailableInProcessException - exception fuego.papi.exception.ApplicationsNotAvailableInProcessException.
A ApplicationsNotAvailableInProcessException is thrown as result of an attempt to access a application of a process.
ApplicationsNotAvailableInProcessException() - Constructor for class fuego.papi.exception.ApplicationsNotAvailableInProcessException
 
ApplicationsNotAvailableInProcessException(String, Throwable) - Constructor for class fuego.papi.exception.ApplicationsNotAvailableInProcessException
Creates a new ApplicationsNotAvailableInProcessException with the given processId and initial exception.
ApplicationsView - interface fuego.papi.ApplicationsView.
 
Arguments - class fuego.papi.Arguments.
 
Attachment - interface fuego.papi.Attachment.
 
AttachmentEditionNotPossibleException - exception fuego.papi.exception.AttachmentEditionNotPossibleException.
A AttachmentEditionNotPossibleException is thrown as a result of an attempt to edit an attachment that has been locked or it is not the last version.
AttachmentEditionNotPossibleException(String) - Constructor for class fuego.papi.exception.AttachmentEditionNotPossibleException
Creates a new AttachmentEditionNotPossibleException with the given attachment.
AttachmentFileNotFoundException - exception fuego.papi.exception.AttachmentFileNotFoundException.
 
AttachmentFileNotFoundException(String, String) - Constructor for class fuego.papi.exception.AttachmentFileNotFoundException
 
AttachmentInterface - interface fuego.papi.AttachmentInterface.
 
AttachmentLockedException - exception fuego.papi.exception.AttachmentLockedException.
This exception is thrown when you want to get an attachment but the attachment is locked by another user.
AttachmentLockedException(String, String) - Constructor for class fuego.papi.exception.AttachmentLockedException
This contructor is used when you know the attachement identification and the participant that is locking the attachment.
AttachmentNotFoundException - exception fuego.papi.exception.AttachmentNotFoundException.
A AttachmentNotFoundException is thrown as a result of an attempt to access an inexistent attachment.
AttachmentNotFoundException(String) - Constructor for class fuego.papi.exception.AttachmentNotFoundException
Creates a new AttachmentNotFoundException with the given attachment name.
AttachmentOperationException - exception fuego.papi.AttachmentOperationException.
This exception can be thronw by any method who performs any operation over an Attachment.
AttachmentOperationException(String, Throwable) - Constructor for class fuego.papi.AttachmentOperationException
Construct the exception with the attachment identification where the operation failed.
AttachmentOperationException(String, String, Throwable) - Constructor for class fuego.papi.AttachmentOperationException
 
AttachmentOperationException() - Constructor for class fuego.papi.AttachmentOperationException
just for serialization purposes
AttachmentsNotAvailableException - exception fuego.papi.exception.AttachmentsNotAvailableException.
Class AttachmentsNotAvailableException This exception is thrown when not all the attachments requested are available, this could happen when not all the processes are available (may be some engine could be down, and can't provide the data).
AttachmentsNotAvailableException(Attachment[], Map) - Constructor for class fuego.papi.exception.AttachmentsNotAvailableException
Constructs an AttachmentsNotAvailableException.
AttachmentsNotAvailableInProcessException - exception fuego.papi.exception.AttachmentsNotAvailableInProcessException.
A AttachmentsNotAvailableInProcessException is thrown as result an attempt to access to the attachments of the a process and the process of it is not available.
AttachmentsNotAvailableInProcessException(String, Throwable) - Constructor for class fuego.papi.exception.AttachmentsNotAvailableInProcessException
Creates a new AttachmentsNotAvailableInProcessException with the given processId and initial exception.
AttachmentsView - interface fuego.papi.AttachmentsView.
 
AuthenticationException - exception fuego.papi.exception.AuthenticationException.
 
AuthenticationException() - Constructor for class fuego.papi.exception.AuthenticationException
 
AuthenticationException(Throwable) - Constructor for class fuego.papi.exception.AuthenticationException
 
AuthenticationException(String) - Constructor for class fuego.papi.exception.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for class fuego.papi.exception.AuthenticationException
 
activate() - Method in interface fuego.papi.Process
Activate this process
activationTime - Variable in class fuego.papi.InstanceEvent
 
activities_d - Variable in class fuego.papi.ParticipantsForActivities
 
activity - Variable in class fuego.papi.InstanceEvent
 
add(VarDefinition, boolean) - Method in class fuego.papi.Ordering
 
add(String, boolean) - Method in class fuego.papi.Ordering
 
add(Ordering.Entry) - Method in class fuego.papi.Ordering
 
addAttribute(VarDefinition, Comparison, Object) - Method in interface fuego.papi.Filter
 
addAttribute(VarDefinition, Comparison, boolean) - Method in interface fuego.papi.Filter
 
addAttribute(VarDefinition, Comparison, Object, boolean) - Method in interface fuego.papi.Filter
 
addAttribute(FilterAttribute) - Method in interface fuego.papi.Filter
 
addBookmarks(InstanceStamp[]) - Method in interface fuego.papi.ProcessServiceSession
 
addHistories(InstanceStamp[]) - Method in interface fuego.papi.ProcessServiceNESession
 
addRefineInstance(InstanceId) - Method in interface fuego.papi.Filter
 
assignProcess(String) - Method in interface fuego.papi.EditableView
Assign a new process identification
assignProcesses(String[]) - Method in interface fuego.papi.EditableView
Assign more than one process identification.
assignRole(String) - Method in interface fuego.papi.EditableView
Assign a new role
assignRoles(String[]) - Method in interface fuego.papi.EditableView
Assign more than one role

B

BEFORE - Static variable in class fuego.papi.Comparison
 
BEFORE - Static variable in class fuego.papi.PapiResources
BEFORE
BEGIN_VIEW - Static variable in class fuego.papi.PapiResources
BEGIN_VIEW
BEGIN_W - Static variable in class fuego.papi.PapiResources
BEGIN_W
BEGIN_WITH - Static variable in class fuego.papi.Comparison
 
BOOKMARK - Static variable in class fuego.papi.PapiResources
BOOKMARK
BOOKMARKS - Static variable in class fuego.papi.PapiResources
BOOKMARKS
BOOKMARKS - Static variable in class fuego.papi.ViewType
 
BOOKMARK_DEFAULT_ID - Static variable in interface fuego.papi.View
 
BatchOperationException - exception fuego.papi.BatchOperationException.
Class BatchOperationException Exception thrown when not every the object requested are available.
BookmarkView - interface fuego.papi.BookmarkView.
 
BusinessParameterNotFoundException - exception fuego.papi.exception.BusinessParameterNotFoundException.
An BusinessParameterNotFoundException is thrown as a result of an attempt get a Business Parameter with an invalid value as a Business Parameter Name.
BusinessParameterNotFoundException(String) - Constructor for class fuego.papi.exception.BusinessParameterNotFoundException
 
bussinesVariablesIds - Variable in class fuego.papi.InstanceEvent
 
bussinesVariablesValues - Variable in class fuego.papi.InstanceEvent
 

C

CAN_NOT_A - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_CREATE_SUBFLOW - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_R - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_S - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_STORE - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_X - Static variable in class fuego.papi.exception.NoPermissionException
 
CAN_NOT_X_BEGIN - Static variable in class fuego.papi.exception.NoPermissionException
 
CIL - Static variable in interface fuego.papi.Task
 
COMPLETED - Static variable in class fuego.papi.InstanceItemState
 
COMPLETED - Static variable in class fuego.papi.PapiResources
COMPLETED
COMPLETED - Static variable in class fuego.papi.ProcessInstanceState
 
COMPONENT - Static variable in interface fuego.papi.Task
 
CONSULTATIONS - Static variable in class fuego.papi.PapiResources
CONSULTATIONS
CONSULTATIONS - Static variable in class fuego.papi.ViewType
 
CONSULTATIONS_DEFAUTL_ID - Static variable in interface fuego.papi.View
 
CONTAINS - Static variable in class fuego.papi.Comparison
 
CONTAINS - Static variable in class fuego.papi.PapiResources
CONTAINS
COPY_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Copy"
COPY_ID45 - Static variable in class fuego.papi.VarDefinition
 
CREATION_TIME_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Creation time" for an Instance
CREATOR_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Creator" for an Attachment
CREATOR_ID45 - Static variable in class fuego.papi.VarDefinition
 
CURRENT_USER - Static variable in interface fuego.papi.FilterAttribute
 
CannotCreateInstanceException - exception fuego.papi.exception.CannotCreateInstanceException.
Exception thrown if was not possible to create a new instance because the the process instance count is equal to process instance limit or the instance failed in the creation.
With IPC/B2B this exception can be thrown because the child instance was not created.
CannotCreateInstanceException() - Constructor for class fuego.papi.exception.CannotCreateInstanceException
 
CannotCreateInstanceException(String) - Constructor for class fuego.papi.exception.CannotCreateInstanceException
Creates a new CannotCreateInstanceException with the default message (PAPI-2100).
CannotCreateInstanceException(String, int) - Constructor for class fuego.papi.exception.CannotCreateInstanceException
Creates a new CannotCreateInstanceException with the given process label and process identification.
CannotCreateInstanceException(String, String, String, Throwable) - Constructor for class fuego.papi.exception.CannotCreateInstanceException
Creates a new CannotCreatInstanceException because of IPC/B2B problem.
CannotGetWorkingAttachmentsException - exception fuego.papi.exception.CannotGetWorkingAttachmentsException.
A CannotGetWorkingAttachmentsException is thrown when something wrong happen when getting working attachments.
CannotGetWorkingAttachmentsException(String, String, Throwable) - Constructor for class fuego.papi.exception.CannotGetWorkingAttachmentsException
To throw when the checkIn of an attachment fail.
CannotLockInstanceException - exception fuego.papi.exception.CannotLockInstanceException.
A CannotLockInstanceException is thrown as a result of an attempt to lock an instance.
CannotLockInstanceException(String) - Constructor for class fuego.papi.exception.CannotLockInstanceException
Creates a new CannotLockInstanceException with the given instanceId.
CannotLockInstanceException(String, String, boolean) - Constructor for class fuego.papi.exception.CannotLockInstanceException
Creates a new CannotLockInstanceException with the given instance and instanceOuner.
CannotObtainAttachmentContentException - exception fuego.papi.exception.CannotObtainAttachmentContentException.
This exception was thrown when the engine can not obtain the content of the attachment.
CannotObtainAttachmentContentException(String) - Constructor for class fuego.papi.exception.CannotObtainAttachmentContentException
Constructor with the attachment indentification.
CannotRemoveViewException - exception fuego.papi.exception.CannotRemoveViewException.
 
CannotRemoveViewException(String, Throwable) - Constructor for class fuego.papi.exception.CannotRemoveViewException
 
CannotRetrieveInstanceAttachmentsException - exception fuego.papi.exception.CannotRetrieveInstanceAttachmentsException.
A CannotRetrieveInstanceAttachmentsException is thrown when something wrong with getInstanceAttachments.
CannotRetrieveInstanceAttachmentsException(String, Throwable) - Constructor for class fuego.papi.exception.CannotRetrieveInstanceAttachmentsException
To throw when the something wrong with getInstanceAttachments.
CannotStoreNotificationException - exception fuego.papi.exception.CannotStoreNotificationException.
A CannotStoreNotificationException is thrown when an attempt to notify a process fails
CannotStoreNotificationException() - Constructor for class fuego.papi.exception.CannotStoreNotificationException
Constructor with message "PAPI-2030"
CannotStoreNotificationException(Throwable) - Constructor for class fuego.papi.exception.CannotStoreNotificationException
Constructor with message "PAPI-2030"
CannotStoreNotificationException(String, Throwable) - Constructor for class fuego.papi.exception.CannotStoreNotificationException
Constructor with message "PAPI-2031"
CannotStoreNotificationException(String, String, String, String) - Constructor for class fuego.papi.exception.CannotStoreNotificationException
Constructor with message "PAPI-2032"
CannotStoreNotificationException(String, String, String, String, Throwable) - Constructor for class fuego.papi.exception.CannotStoreNotificationException
Constructor with message "PAPI-2032"
CheckInAttachmentException - exception fuego.papi.exception.CheckInAttachmentException.
A CheckInAttachmentException is thrown as result an attempt to make a check-in of an attachment.
CheckInAttachmentException(String, Throwable) - Constructor for class fuego.papi.exception.CheckInAttachmentException
To throw when the checkIn of an attachment fail.
CheckOutAttachmentException - exception fuego.papi.exception.CheckOutAttachmentException.
A CheckOutAttachmentException is thrown as result an attempt to make a check-out of an attachment.
CheckOutAttachmentException(String, Throwable) - Constructor for class fuego.papi.exception.CheckOutAttachmentException
To throw when the checkOut of an attachment fail.
CommunicationException - exception fuego.papi.CommunicationException.
Exception thrown by any PAPI method who potentionally communicates with another program, such as the Execution Engine or the Directory.
CommunicationException() - Constructor for class fuego.papi.CommunicationException
Default constructor
CommunicationException(Throwable) - Constructor for class fuego.papi.CommunicationException
Constructor with the problem that genereated the exception.
Comparison - class fuego.papi.Comparison.
 
ConnectedClientInfo - class fuego.papi.ConnectedClientInfo.
 
ConnectedClientInfo() - Constructor for class fuego.papi.ConnectedClientInfo
 
Consult - interface fuego.papi.Consult.
 
ConsultationsView - interface fuego.papi.ConsultationsView.
 
canBeGrabbedBy(Activity) - Method in class fuego.papi.Activity
Returns true if this activity can be grabbed by the given grab activity, otherwise false.
canBeSeenByParticipant(Participant) - Method in class fuego.papi.Activity
Returns true if the given participant can see this activity.
canBeSeenByRole(String) - Method in class fuego.papi.Activity
 
canGrab(String) - Method in class fuego.papi.Activity
Returns true if this activity can grab from the given one, otherwise false.
category - Variable in class fuego.papi.InstanceEvent
 
category - Variable in class fuego.papi.Participant.RoleAssignment
 
checkInAttachment(Attachment, String, File) - Method in interface fuego.papi.ProcessServiceSession
This methods checks in the attachment passed as argument.
If successful, this will always generate a new attachment version.
checkOutAttachment(Attachment, String) - Method in interface fuego.papi.ProcessServiceSession
This methods checks out an attachment for a given instance.
checkOutAttachmentToStream(Attachment, OutputStream) - Method in interface fuego.papi.ProcessServiceSession
This methods checks out an attachment for a given instance to a outputStream
clear() - Method in class fuego.papi.Ordering
 
clearLabels() - Method in interface fuego.papi.EditableView
remove all labels assigned.
close() - Method in class fuego.papi.ProcessService
Close the service, and disconnect all the sessions that are still connected.
close() - Method in interface fuego.papi.ProcessServiceNESession
This method close all connection with the directory and remove all reference with the engines and the processes.
commitExternalActivity(String, int, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the commit method of an external activity.
commitExternalActivity(String, String, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the commit method of an external activity.
commitExternalActivity(String, String, int, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the commit method of an external activity.
compare(InstanceId, InstanceId) - Static method in class fuego.papi.InstanceId
 
compareParticipantCategoryWith(Participant, String) - Method in class fuego.papi.Participant
Returns if the category relation between the actual participant and the given participant.
compareTo(Object) - Method in class fuego.papi.InstanceEvent
Implementation of the method inherited from the interface Comparable.
compareTo(Object) - Method in class fuego.papi.InstanceId
Implementation of the method inherited from the interface Comparable
connectedSince - Variable in class fuego.papi.ConnectedClientInfo
 
contains(String) - Method in class fuego.papi.Ordering
 
contains(Ordering.Entry) - Method in class fuego.papi.Ordering
 
containsArgument(String) - Method in class fuego.papi.Arguments
Return if this object contains a specific argument name
containsDocumentation(Locale) - Method in class fuego.papi.Activity
Returns if this activity contains documentation for an specific locale.
containsDocumentation(Locale) - Method in interface fuego.papi.MDObject
Returns true if the documentation for the given locale was already loaded
containsDocumentation(Locale) - Method in interface fuego.papi.Process
Returns if this process contains documentation for an specific locale.
containsDocumentation(Locale) - Method in interface fuego.papi.Task
Returns true if the documentation for the given locale was already loaded
copy() - Method in class fuego.papi.Ordering
 
copy(String) - Method in interface fuego.papi.Presentation
 
create() - Static method in class fuego.papi.Arguments
Create a new Arguments object
create(ArgumentMap) - Static method in class fuego.papi.Arguments
Create a new Arguments object
create(RuntimeException, Locale) - Static method in class fuego.papi.EngineRuntimeException
Return a new EngineRuntimeException with the given RuntimeException and locale.
create(String, String) - Static method in class fuego.papi.InstanceStamp
Creates an InstanceStamp object.
create(String) - Static method in class fuego.papi.InstanceStamp
Creates an InstanceStam from an StampId
create(String, String, String, int) - Method in interface fuego.papi.ProcessService.Factory
 
create(DirectoryPassport, String, String, int) - Method in interface fuego.papi.ProcessService.Factory
 
create(String) - Static method in class fuego.papi.ProcessService
Temporary method
create(String, String) - Static method in class fuego.papi.ProcessService
Creates a new ProcessService.
create(String, String, int) - Static method in class fuego.papi.ProcessService
Creates a new ProcessService.
create(DirectoryPassport, String, int) - Static method in class fuego.papi.ProcessService
 
create(String, String, String, int) - Static method in class fuego.papi.ProcessService
Creates a new ProcessService.
create(String, String, Throwable) - Static method in class fuego.papi.exception.ActivityFailedException
This method generates a ActivityFailException from the cause of the problem
create(String, int, String, String, Throwable) - Static method in class fuego.papi.exception.TaskFailedException
 
createActivityView(Activity) - Method in interface fuego.papi.InstancesView
Create a new ActivityView from this view
createActivityView(String) - Method in interface fuego.papi.InstancesView
Create a new ActivityView from this view
createApplicationDefaults() - Static method in class fuego.papi.VarDefinition
This methos returns the default variable definitions for an Application.
createAttachmentDefaults() - Static method in class fuego.papi.VarDefinition
This methos returns the default variable definitions for an Attachment.
createFilter() - Method in interface fuego.papi.ProcessService.Factory
 
createFilter() - Static method in class fuego.papi.ProcessService
Return a new Filter
createFilter(int) - Static method in class fuego.papi.ProcessService
Deprecated.  
createInstanceDefaults() - Static method in class fuego.papi.VarDefinition
This methos returns the default variable definitions for an Instance.
createNESession(String, String, String) - Method in class fuego.papi.ProcessService
Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use ProcessService.createSession(String, String, String) instead
createNESession(String, String, String, boolean) - Method in class fuego.papi.ProcessService
Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use ProcessService.createSession(String, String, String) instead
createNESession(ConnectionPassport, String) - Method in class fuego.papi.ProcessService
Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use ProcessService.createSession(ConnectionPassport, String) instead
createNESession(ConnectionPassport, String, boolean) - Method in class fuego.papi.ProcessService
Deprecated. all sessions are non exclusive now. Besides, all operations can be executed with a non exclusive session. Use ProcessService.createSession(ConnectionPassport, String) instead
createPassport(String) - Method in class fuego.papi.ProcessService
Returns a directory passport to connect to the process service.
createPassportWithPreset(String) - Method in class fuego.papi.ProcessService
Returns a directory passport with preset to connect to the process service.
createPresentation(PresentationType, String, Presentation.Column[]) - Method in interface fuego.papi.ProcessServiceNESession
 
createProcessInstance(String, Arguments) - Method in interface fuego.papi.ProcessServiceNESession
Creates a new process instance in a particular process or in the active process if you use the consolidated process identification.
createProcessInstance(String, String, Arguments) - Method in interface fuego.papi.ProcessServiceNESession
Creates a new process instance in a particular process or in the active process if you use the consolidated process identification.
createSession(String, String, String) - Method in class fuego.papi.ProcessService
Creates a ProcessService session.
createSession(String, String, String, boolean) - Method in class fuego.papi.ProcessService
Deprecated. takeOver argument is not longer supported. Use ProcessService.createSession(String, String, String) instead
createSession(ConnectionPassport, String) - Method in class fuego.papi.ProcessService
Creates a ProcessService session.
createSession(ConnectionPassport, String, boolean) - Method in class fuego.papi.ProcessService
Deprecated. takeOver argument is not longer supported. Use ProcessService.createSession(ConnectionPassport, String) instead
createView(ViewType, String, String[]) - Method in interface fuego.papi.ProcessServiceNESession
To create a view.
createWithId(String) - Static method in class fuego.papi.ProcessService
Temporary method
createWithId(String, String) - Static method in class fuego.papi.ProcessService
Creates a new ProcessService.
createWithId(String, String, int) - Static method in class fuego.papi.ProcessService
Creates a new ProcessService.
customRunActivity(String, String, int, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the activity task number over the instance.
customRunActivity(String, String, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the activity task over the instance.
customRunGlobal(String, String, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the activity over the instance.
customRunGlobalActivity(String, Arguments) - Method in interface fuego.papi.ProcessServiceNESession
Runs a global activity, if it is a global creation activity, it returns a GlobalExecution representing this execution.
customRunTask(String, String, int, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Deprecated. use ProcessServiceSession.customRunActivity(String,String,int,Arguments) instead
customRunTask(String, int, Arguments) - Method in interface fuego.papi.ProcessServiceSession
Executes the activity task number over the instance.

D

DATE - Static variable in class fuego.papi.PapiResources
DATE
DEADLINE_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Deadline"
DEADLINE_ID45 - Static variable in class fuego.papi.VarDefinition
 
DEFAULT - Static variable in class fuego.papi.exception.NoPermissionException
 
DEFAULT_ACTIVITY_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_APPLICATIONS_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_ATTACHMENTS_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_CACHE_SIZE - Static variable in class fuego.papi.ProcessService
 
DEFAULT_FOLDER_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_INSTANCES_ID - Static variable in interface fuego.papi.Presentation
 
DEFAULT_OWNER - Static variable in interface fuego.papi.Presentation
 
DEFAULT_OWNER - Static variable in interface fuego.papi.View
 
DESCRIPTION_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Description"
DESCRIPTION_ID45 - Static variable in class fuego.papi.VarDefinition
 
DESCRIPT_LENGTH - Static variable in interface fuego.papi.Attachment
 
DISPLAY - Static variable in interface fuego.papi.Task
 
DISPLAY_INSTANCE - Static variable in interface fuego.papi.Task
 
DeprecatedViewException - exception fuego.papi.exception.DeprecatedViewException.
 
DeprecatedViewException(String) - Constructor for class fuego.papi.exception.DeprecatedViewException
 
DirectoryServiceNotAvailableException - exception fuego.papi.exception.DirectoryServiceNotAvailableException.
Exception thrown by all those methods who communicates with the Directory Service.
DirectoryServiceNotAvailableException() - Constructor for class fuego.papi.exception.DirectoryServiceNotAvailableException
 
DirectoryServiceNotAvailableException(String) - Constructor for class fuego.papi.exception.DirectoryServiceNotAvailableException
 
DirectoryServiceNotAvailableException(String, Throwable) - Constructor for class fuego.papi.exception.DirectoryServiceNotAvailableException
 
deprecate() - Method in interface fuego.papi.Process
Deprecate this process
doInvoke(Object[]) - Method in interface fuego.papi.Invocation
Invokes the actual method
doPostInvoke(Object[], Object) - Method in interface fuego.papi.Invocation
Does all post invocation processing (calling getters and processing output arguments)
doPreInvoke() - Method in interface fuego.papi.Invocation
Performs pre-invocation argument processing.

E

EAPI_01000(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_01000
EAPI_02000 - Static variable in class fuego.papi.exception.PapiExceptionResources
EAPI_02000
EAPI_02001 - Static variable in class fuego.papi.exception.PapiExceptionResources
EAPI_02001
EAPI_02100(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_02100
EAPI_03007(String, String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03007
EAPI_03008(String, String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03008
EAPI_03009(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03009
EAPI_03010(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03010
EAPI_03011(String, String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03011
EAPI_03012(String, String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03012
EAPI_03013(String, String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03013
EAPI_03014(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_03014
EAPI_04000(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_04000
EAPI_04001(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_04001
EAPI_04002(String) - Static method in class fuego.papi.exception.PapiExceptionResources
EAPI_04002
EAPI_05001 - Static variable in class fuego.papi.exception.PapiExceptionResources
EAPI_05001
EAPI_05002 - Static variable in class fuego.papi.exception.PapiExceptionResources
EAPI_05002
ELAPSED_TIME - Static variable in class fuego.papi.PapiResources
ENLAPSED_TIME
END_W - Static variable in class fuego.papi.PapiResources
END_W
END_WITH - Static variable in class fuego.papi.Comparison
 
EXCEPTION - Static variable in class fuego.papi.ProcessInstanceState
 
EXTERNAL - Static variable in interface fuego.papi.Task
 
EditAttachmentException - exception fuego.papi.exception.EditAttachmentException.
A EditAttachmentException is thrown when something wrong happen when editing an attachment.
EditAttachmentException(String, String, Throwable) - Constructor for class fuego.papi.exception.EditAttachmentException
To throw when the checkIn of an attachment fail.
EditableActivityView - interface fuego.papi.EditableActivityView.
 
EditableApplicationsView - interface fuego.papi.EditableApplicationsView.
 
EditableAttachmentsView - interface fuego.papi.EditableAttachmentsView.
 
EditableBookmarkView - interface fuego.papi.EditableBookmarkView.
 
EditableConsultationsView - interface fuego.papi.EditableConsultationsView.
 
EditableFolderView - interface fuego.papi.EditableFolderView.
 
EditableHistoryView - interface fuego.papi.EditableHistoryView.
 
EditableInstancesView - interface fuego.papi.EditableInstancesView.
 
EditablePresentation - interface fuego.papi.EditablePresentation.
 
EditableView - interface fuego.papi.EditableView.
 
EngineException - exception fuego.papi.EngineException.
 
EngineRuntimeException - exception fuego.papi.EngineRuntimeException.
No RuntimeException thrown while executing an engine operation should "travel" to PAPI.
EngineRuntimeException() - Constructor for class fuego.papi.EngineRuntimeException
Contructs a new EngineRuntimeException with the default message.
EngineRuntimeException(ExceptionMsg) - Constructor for class fuego.papi.EngineRuntimeException
 
EventType - class fuego.papi.EventType.
 
EventTypeMsg - class fuego.papi.EventTypeMsg.
Message bundle.
EventTypeMsg() - Constructor for class fuego.papi.EventTypeMsg
 
EventTypeMsg_en - class fuego.papi.EventTypeMsg_en.
 
EventTypeMsg_en() - Constructor for class fuego.papi.EventTypeMsg_en
 
EventTypeMsg_es - class fuego.papi.EventTypeMsg_es.
Message bundle.
EventTypeMsg_es() - Constructor for class fuego.papi.EventTypeMsg_es
 
Execution - interface fuego.papi.Execution.
 
ExternalTaskException - exception fuego.papi.exception.ExternalTaskException.
An ExternalTaskException is thrown when an external task is called using runTask() or runActivity().
ExternalTaskException(String, String, int) - Constructor for class fuego.papi.exception.ExternalTaskException
Creates a new ExternalTaskException
equals(Object) - Method in class fuego.papi.InstanceId
Implementation of the method inherited from the interface Comparable
equals(InstanceId, InstanceId) - Static method in class fuego.papi.InstanceId
 
equals(Object) - Method in class fuego.papi.Ordering.Entry
 
eventData - Variable in class fuego.papi.InstanceEvent
 
existsFile(String) - Method in interface fuego.papi.Attachment
This methods returns true if the attachment has already been checked out in the specified directory

F

FAILED - Static variable in class fuego.papi.InstanceItemState
 
FILENAME_ID - Static variable in class fuego.papi.VarDefinition
The id of the default variable "Filename" for an Attachment
FILENAME_ID45 - Static variable in class fuego.papi.VarDefinition
 
FILENAME_LENGTH - Static variable in interface fuego.papi.Attachment
 
FOLDER - Static variable in class fuego.papi.PapiResources
FOLDER
FOLDER - Static variable in class fuego.papi.PresentationType
 
FOLDER - Static variable in class fuego.papi.ViewType
 
FOUR_WEEKS_AGO - Static variable in class fuego.papi.PapiResources
FOUR_WEEKS_AGO
FRIDAY - Static variable in class fuego.papi.PapiResources
FRIDAY
Filter - interface fuego.papi.Filter.
 
FilterAttribute - interface fuego.papi.FilterAttribute.
 
FilterBatchOperationException - exception fuego.papi.exception.FilterBatchOperationException.
 
FilterBatchOperationException(InstanceInfo[], Map) - Constructor for class fuego.papi.exception.FilterBatchOperationException
 
FolderView - interface fuego.papi.FolderView.
 
failAll() - Method in class fuego.papi.BatchOperationException
 
failAll() - Method in class fuego.papi.exception.TasksException
 
failAllInstances() - Method in class fuego.papi.exception.InstancesException
 
failAllProcesses() - Method in class fuego.papi.exception.ApplicationsNotAvailableException
 
failAllProcesses() - Method in class fuego.papi.exception.AttachmentsNotAvailableException
 
failAllProcesses() - Method in class fuego.papi.exception.FilterBatchOperationException
 
failAllProcesses() - Method in class fuego.papi.exception.ProcessesNotAvailableException
 
failAllViews() - Method in class fuego.papi.exception.ViewsNotAvailableException
 
family() - Method in class fuego.papi.Comparison
 
family() - Method in class fuego.papi.ParticipantScope
 
family() - Method in class fuego.papi.PresentationType
 
family() - Method in class fuego.papi.StatusScope
 
family() - Method in class fuego.papi.ViewType
 
fixOldViewType(String) - Static method in class fuego.papi.ViewType
 
fuego.papi - package fuego.papi
Provides the classes necessary to interact with fuego engine.
fuego.papi.exception - package fuego.papi.exception
Contains all the subclasses of any papi OperationException.

G

GLOBAL_EXECUTED - Static variable in class fuego.papi.EventType
 
GRABBED - Static variable in class fuego.papi.ProcessInstanceState
 
GREATER_OR_EQUALS - Static variable in class fuego.papi.Comparison
 
GREATER_THAN - Static variable in class fuego.papi.Comparison
 
GlobalExecution - interface fuego.papi.GlobalExecution.
 
getActiveProcessId(String) - Method in interface fuego.papi.ProcessServiceNESession
Return the active process identification for the specific process.
getActiveProcessIdsByView(View) - Method in interface fuego.papi.ProcessServiceNESession
Returns the ids of the processed that are active (non deprecated) in the given View.
getActivities() - Method in class fuego.papi.ParticipantsForActivities
Gets the activities array
getActivities() - Method in interface fuego.papi.Process
This method returns an activity array all activities of this process
getActivitiesForParticipant(Participant) - Method in interface fuego.papi.Process
The visible activities in this process for the given participant
getActivitiesForRoles(String[]) - Method in interface fuego.papi.Process
Return all activities int this process that can be see for these roles
getActivity() - Method in class fuego.papi.InstanceInfo
Return the activity for this instance
getActivity(String) - Method in interface fuego.papi.Process
Finds an activity of this process by name or id.
getActivity() - Method in interface fuego.papi.Task
Returns the activity for this task
getActivity() - Method in class fuego.papi.exception.InstanceConcurrentExecutionException
 
getActivityDeadline() - Method in class fuego.papi.InstanceInfo
Returns the deadline to complete the current activity
getActivityDocumentation(String, Locale) - Method in interface fuego.papi.ProcessServiceNESession
Returns the local path of the HTML documentation for the given activity.
getActivityForView(ActivityView) - Method in interface fuego.papi.ProcessServiceNESession
Return the activity of the specific view
getActivityId() - Method in class fuego.papi.InstanceInfo
Returns the activity identification of this instance
getActivityId() - Method in interface fuego.papi.Task
Returns the activity id
getActivityId() - Method in class fuego.papi.exception.ActivityFailedException
Return the activity identification where this exception was generated.
getActivityId() - Method in class fuego.papi.exception.ActivityNotFoundException
 
getActivityId() - Method in class fuego.papi.exception.InstanceSentByBackOrSkipActionException
Return the activity identification of the task executed.
getActivityId() - Method in class fuego.papi.exception.InvalidActivityException
Return the invalid activity
getActivityId() - Method in class fuego.papi.exception.InvalidTaskNumberException
 
getActivityId() - Method in class fuego.papi.exception.TaskNotFoundException
 
getActivityId() - Method in class fuego.papi.exception.TaskOperationException
 
getActivityName() - Method in class fuego.papi.Activity
Returns the activity name
getActivityName(String) - Static method in class fuego.papi.Activity
Returns the activity name for the given activity id.
getActivityName() - Method in interface fuego.papi.ActivityView
Returns the name of the activity defined for this view.
getActivityName() - Method in class fuego.papi.InstanceInfo
Returns the activity name of this instance
getActivityName() - Method in class fuego.papi.InstanceStamp
Returns the activity name where the carried instance is suposed to be.
getActivityScope() - Method in class fuego.papi.SearchScope
Return the activity scope of this search.
getActivityType() - Method in interface fuego.papi.ActivityView
Returns the type of the activity defined for this view.
getAfanumericSQLExpression() - Method in class fuego.papi.Comparison
 
getAlfanumericComparisons() - Static method in class fuego.papi.Comparison
 
getAllProcessVersions(String) - Method in interface fuego.papi.ProcessServiceNESession
Return all process identifications for the specific process.
getApplicationRoles() - Method in interface fuego.papi.Process
Return all roles with global activities (not include global automatic) in this process
getApplicationsByView(ApplicationsView) - Method in interface fuego.papi.ProcessServiceNESession
Returns all the Global Activities for a given ApplicationsView
getArgument(String) - Method in class fuego.papi.Arguments
Get the argument value
getArgument() - Method in class fuego.papi.exception.InvalidAttachmentArgumentLengthException
Argument that exceeds the limit of the length.
getArgumentSetName() - Method in class fuego.papi.exception.InvalidArgumentSetNameException
 
getArguments() - Method in class fuego.papi.Arguments
 
getArguments() - Method in interface fuego.papi.Execution
Returns the original Arguments object passed to the task
getArguments() - Method in interface fuego.papi.Task
Returns all the arguments of this task.
getArgumentsName() - Method in class fuego.papi.Arguments
 
getAssignedProcesses() - Method in interface fuego.papi.View
Returns the process identification assigned.