Package com.appiancorp.suiteapi.process

Interface Summary

Interface	Description
AppianTypeHolder	Indicates that the implementing class uses Appian-typed objects (User, Group, etc), and needs to add the ids of these objects to a cache so that display names can be retrieved for them later.
CalendarService	This service provides methods which retrieve and update calendars in the system.
ExceptionHandlerService	Provides methods relating to process exception handling.
NotesContentService	Convenience methods for creating note content.
ProcessAdministrationService	ProcessAdministrationService is used to create and modify properties of the overall process application.
ProcessDesignService	The ProcessDesignService is used for creating and modifying ProcessModel which are organized by storing them in ProcessModelFolder objects.
ProcessExecutionService	Interface to the business logic for the process runtime.
TypedVariableTypes	Deprecated Use AppianType instead.
Validatable	Classes implementing this interface can be subjected to runtime validation.

Class Summary

Class	Description
AbstractEscalation	An escalation of an activity, such as notify my supervisor if I haven't accepted in 2 days.
AbstractProcessModel	The template from which processes are created.
AbstractProcessNode	A node in a process model.
AbstractSchedule	A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
AcpReturnConverter	Deprecated
AcpsReturnConverter	Deprecated
ActivityClass	The activity that is run when a ProcessNode is traversed.
ActivityClassParameter	An ActivityClassParameter is a variable that is specified at design time and used at runtime.
ActivityClassParameterSchema	Template from which ActivityClassParameters are created.
ActivityClassSchema	The template from which activity classes are created.
ActivityProperties	Container for the properties of an activity.
ActivityReturnVariable	Variable that can be returned from an activity.
AppianTypeCache	Holds the ids and display names of Appian-typed objects such as users and groups.
ArvReturnConverter	Deprecated
AssigneeReturnConverter	Deprecated
Assignment	Holds the configuration for the assignment of an attended node.
Assignment.Assignee	A user, group, role, or function that is assigned to a task.
Attachment	Bean used to represent the Process/Task attachment.
Attachment.NamedUrl
AttachmentMediator	Bean used to represent the Process/Task attachment.
AttachmentPermissions	This class has fields which convey various permissions that the user has for process or Task attachments.
Connection	Represents a directional link between two process nodes (startNode and endNode).
Deadline
Escalation	An escalation is an action that occurs if the task has not been completed before the configured TimerEventTrigger triggers.
EscalationInstance	This class is used to specify escalation properties for a particular node instance.
FormConfigMapParameterConverter	Deprecated
GenericTypedVariable	Deprecated Use the class NamedTypedValue instead.
HistoryRecord	An individual history record, representing an element of an audit trail in a process.
HistoryRecord.ProcessModelInfo	Information about a process model, including id, version, name and uuid.
Instances	Class defines how many instances of the node will be created.
Interval	Interval define a period of time in terms of Minutes, Hours, Days, Weeks, Months and Years.
MultipleInstance	The class includes the multiple instance execution configuration of the node.
NodeActionProcessModelResult	NodeActionProcessModelResult represents the result of a node action, e.g., starting a node as a task, in the context of a process model.
NodeActionProcessResult	NodeActionProcessResult represents the result of a node action, e.g., starting a node as a task, in the context of a process.
NodeActionResult	NodeActionResult contains all the results of NodeActions, e.g., starting a node as a task, grouped initially by process model.
Note	This class represents the Note that can be attached to ProcessModel, Process, ProcessNode or Task.
NoteMetadata	This class represents the Note that can be attached to ProcessModel, Process, ProcessNode or Task.
NotePermissions	Permissions for the user on the Note
Palette	Holds a collection of nodes that can be dropped onto a canvas in the designer to create a process.
Palette.Descriptor	A name/id object that can be used by the UI
PaletteCategory	A category that holds palettes and/or other palette categories in a hierarchy.
PaletteCategory.AllCategories	This bean is used to represent the top level of all categories in the hierarchy component
PaletteCategory.Descriptor	A descriptive object that can be used by the UI
PaletteErrorItem	Empty class needed to create a new node type in the palette hierarchy.
PaletteItem	A node that appears in a palette in the process designer, and can be dropped onto the canvas to add an activity to a process model.
Priority	The precedence of any item in its queue.
PriorityRegistration
ProcessApplicationRoleMap	Defines the roles of users and groups for a process object.
ProcessDetails	Contains detailed information about a process.
ProcessDiagram	A runtime representation of a ProcessModel.
ProcessException	Contains metadata about an exception (error) that occurred while a process was executing.
ProcessExceptionType	Metadata about a class of process exceptions (errors that occur while a process is executing).
ProcessFacade	Utility methods dealing with processes
ProcessModel	The template from which processes are created.
ProcessModel.Descriptor	Inner class that holds the name, id, and description of a process model.
ProcessModelDetails	Holds detailed metadata about a ProcessModel.
ProcessModelFacade	Manages the loading and storing and other utility functions of process models.
ProcessModelFolder	Bean that represents a folder into which ProcessModels can be stored.
ProcessModelLogging
ProcessModelNotificationSettings
ProcessModelProperties	Holds the properties of a process model.
ProcessModelSummary	Holds summary information about a process model, such as who created it, when, how many process instances are running, and how many have completed.
ProcessModelWithErrors	Bean containing a ProcessModel and the errors that were found when trying to publish it.
ProcessNode	A node in a process model.
ProcessProperties	Holds the properties of a process.
ProcessRoleMap	Defines the roles of users and groups for a process object.
ProcessStartConfig	Specifies options and configurations that control behavior when starting a process.
ProcessSummary	Holds high-level, summary metadata about a process.
ProcessVariable	A variable that is global to a process.
ProcessVariableInstance	Represents the runtime instance of process variable for a process.
PvInstancesReturnConverter	Deprecated
PvReturnConverter	Deprecated
Recurrence	Used to specify properties of a node that is set to re-execute after every configurable interval of time.
Recurrence.End	Class defines condition under which Recurrence stops for a node in process.
RecurrenceInstance	This class is used to specify properties for a particular node instance that is set to re-execute after every configurable interval of time.
RecurringInterval	Defines a time interval for an event that repeats after a fixed delay.
RecurringInterval.Daily	Class defines Daily recurring interval
RecurringInterval.Monthly	Class defines time interval for Monthly events.
RecurringInterval.Weekly	Class that defines time interval for events that occur on a Weekly basis.
RecurringInterval.Yearly	Class defines time interval for Yearly events.
RuntimeProcessNode	Information about a node in an executed process.
Schedule	A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
ScheduleInstance	A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
ScheduleSummary	Holds a high-level summary of the schedule which could be on a node or a pending node object if there is recurrence and spawning for that node
SizingColumn
SizingReport
Spawning	Nodes that are set to Spawn create multiple instances of themselves, when the process reaches that node.
TaskDesignProperties	Holds a task's high level metadata during design time (i.e. in the process modeler, not during execution.)
TaskDetails	More details about a task (attended activity) than are provided in the TaskSummary, including the notes and attachments on the task.
TaskProperties	Holds the properties of a task.
TaskSummary	Holds a high-level summary for a task.
TaskUrlService
TvReturnConverter	Deprecated
TypeDescriptor	Deprecated Use the TypeService and related APIs instead.
TypedVariable	Deprecated Use the class NamedTypedValue instead.
TypedVariableUtils	Utility class for TypedVariables
TypedVariableUtils.People	Class representing groups and/or users
XMLBuilderUtils	Class provides utility methods to create an XML document

Enum Summary

Enum	Description
BulkNodeOption	BulkNodeOption This provides options to fine-tune the behavior of the bulk node process execution methods.

Annotation Types Summary

Annotation Type	Description
ApplicationDataType	Convenience annotation to indicate a value represents an Appian Object.
ProcessDataType	Convenience annotation to indicate a value represents an Appian Object.
ProcessModelDataType	Convenience annotation to indicate a value represents an Appian Object.
TaskDataType	Convenience annotation to indicate a value represents an Appian Object.