All Classes and Interfaces

Class
Description
Abstract class to be subclassed when implementing a Java execution environment activity.
An escalation of an activity, such as notify my supervisor if I haven't accepted in 2 days.
 
The template from which processes are created.
A node in a process model.
A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
Represents a service context for use with the service framework.
Deprecated. 
Deprecated. 
This exception is thrown when attempting to access an Action that is not found within an Application.
Deprecated.
This annotation may be removed from the public API in a future release.
The activity that is run when a ProcessNode is traversed.
An ActivityClassParameter is a variable that is specified at design time and used at runtime.
Template from which ActivityClassParameters are created.
The template from which activity classes are created.
This is an Exception wrapper, which is used by Activity classes to inform about error conditions while running the activity.
Metadata attributes of an activity that are needed during its execution.
Classes that implement this interface provide additional functionality for passing parameters to and receiving parameters from a user interface.
Container for the properties of an activity.
Variable that can be returned from an activity.
Deprecated.
This class pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
Deprecated.
This class pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
Deprecated.
The AdministrationService pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
Deprecated.
Use the class ContentService instead.
Deprecated.
The Portal functionality will be removed in a future release.
This class can be used as base class for any object acting as RoleMap where User and Group can be added to view or edit a particular object.
Holds the List of AggregationColumns to project by the Query.
Immutable bean representing the column dot notation, alias, visibility (if it's should be shown to the client or not).
Enumeration containing the valid aggregation functions which can be applied to a column.
Filter for tasks/processes that are ahead of schedule: when this filter is added, only completed tasks/processes that are ahead of schedule will be returned in the report.
Deprecated.
This annotation may be removed from the public API in a future release.
 
This class holds information about an error.
A builder to create instances of AppianError.
Builds localized AppianError objects using Appian error codes.
 
 
Callback used to format an AppianErrorCode.
Callback used to format an AppianErrorCode's title.
Deprecated.
AppianException is the base class of all application-level exceptions thrown in the product.
AppianPrivilegeNotFoundException acts as a wrapper around an equivalent AppianPrivelegeException.
 
A builder to create instances of AppianResponseError.
AppianRuntimeException is the base class of all application-level runtime exceptions thrown in the product.
Functions annotated with this annotation will show up under the internal "Appian Scripting Functions" category.
Abstract servlet class that provide inject functionality.
Abstract class to extend when creating a custom smart service.
This exception is thrown when an issue is encountered when interacting with Appian file storage.
AppianType List of built-in System Type constants.
Holds the ids and display names of Appian-typed objects such as users and groups.
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.
Implements the Spring UserDetails interface and holds Appian-specific data about a user.
Retrieves the user data from UserProfileService and returns an instance of AppianUserDetails.
Represents an Application object, which consists of metadata, a navigation definition, and references to associated objects.
Deprecated.
The Portal functionality will be removed in a future release.
Definition of the Application Actions: a collection of ApplicationAction associated to the application.
The end-user navigation definition of the application.
Stores the references to the applications associated with the application.
Stores the references to the objects associated with the application.
 
An application is logically divided in four different sections: 1.
Represents an action that can be executed in the context of an Application.
Supporting bean for ApplicationAction.
Convenience annotation to indicate a value represents an Appian Object.
Represents each item in the navigation definition of the application.
Exception thrown by the Service whenever an Application ID does not match any object stored in the database
 
Application service.
 
The approval bean contains the approval status for a list of content items.
This bean contains information about an approved action.
This exception is thrown if the user calls an API method that acts on a process that has been archived.
Deprecated. 
Deprecated. 
Holds the configuration for the assignment of an attended node.
A user, group, role, or function that is assigned to a task.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Bean used to represent the Process/Task attachment.
 
Bean used to represent the Process/Task attachment.
This class has fields which convey various permissions that the user has for process or Task attachments.
 
This represents the Attribute object.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated. 
Title: AttributeType
AuditHistory Audit Process History allows reading the process history of live processes and processes deleted, but still archived in Kafka.
AuditHistoryException
AuditHistoryOptions
AuditHistoryOptionsBuilder
AuditHistoryProcessModelOptions
AuditHistoryProcessModelOptionsBuilder
AuditHistoryProcessOptions
AuditHistoryProcessOptionsBuilder
AuditHistoryRow AuditHistoryRow represents one row of audit log process history.
AuditHistoryRowConstants The domain!
AuditInfo Information about the audit history returned.
The AuthenticationProviderWrapper contains an AuthenticationProvider to which it delegates the actual authentication of an AuthenticationToken.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
 
 
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Base class for all analytics filters.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
This class implements very basic conversion from a Spring LDAP DirContextOperations bean to a UserDetails bean.
Filter for tasks/processes that are behind schedule: when this filter is added, only the incomplete and completed tasks/processes that are behind schedule will be returned in the report.
Utility class used to combine an array of array into a single array of combined length and vice versa.
BulkNodeOption This provides options to fine-tune the behavior of the bulk node process execution methods.
This bean represents the Business Information that is registered with the WebServices Registry.
A bean detailing contact information
The CalendarDateElement is similar to the CalendarElement but it has an additional field which specifies the specific day to which this element is applied.
The CalendarElement stores a start and end time, which is used by the WorkingCalendar to specify all start and end times per day.
This service provides methods which retrieve and update calendars in the system.
 
Defines the category in the expression editor in which the function annotated with this annotation should appear.
Deprecated.
Use the class ContentRoleMap instead.
Deprecated.
Use the class ContentService instead.
Deprecated.
Use the class ContentService instead.
Immutable bean representing the column dot notation, its alias and its visibility (if it should be shown to the client or not).
The Column bean contains information necessary to retrieve a column of data from the backend and display it properly.
Immutable bean representing the column dot notation and it's alias.
Deprecated.
This annotation may be removed from the public API in a future release.
Deprecated.
Use the class Community instead.
Represents a Knowledge community, which can contain KnowledgeCenter and Community items.
Convenience annotation to indicate a value represents an Appian Object.
Represents a community knowledge center, which is a knowledge center that other users can view.
Deprecated.
Use the class ContentService instead.
Defines constants for logical comparisons between values.
Deprecated.
this unused filter will be removed in a future release
Deprecated.
this unused filter will be removed in a future release; use instead DueTodayFilter as it returns the same results
Filter for completed tasks/processes: when this filter is added, only completed tasks/processes will be returned in the report.
CompleteValue Some AuditHistoryRows will have PartialValues, others will have CompleteValues.
Allows multiple SessionAuthenticationStrategy implementations to be executed as a single SessionAuthenticationStrategy.
 
 
Interface that exposes the public configuration properties in custom.properties for use in custom code.
Provides support for loading configuration files for the product.
Factory for returning an instance of Configuration.
Represents a directional link between two process nodes (startNode and endNode).
Deprecated.
This annotation may be removed from the public API in a future release.
Represents a constant, which can be used in expressions throughout the product.
Convenience annotation to indicate a value represents an Appian Object.
Interface to represent constants used for retrieving and sorting results obtained from database.
This is the abstract class used to represent Content objects that may contain other Content objects.
Represents an item of content.
This class provides methods accessible through JSON, which are relevant to Content objects.
Provides utility methods for creating content objects based on the type identifiers.
Contains constants for use with Content.
This exception may be thrown by service methods if the content they are referencing is expired.
Filters may be applied to Content Service operations in order to filter the final results by the criteria listed here.
This represents a Key and Value of a Content Attribute.
Deprecated.
since 23.2.
Holds the data for an individual role within a Content object's role map.
This class represents the access permissions for an element in the collaboration center.
This class represents the access permissions for a Content item.
This interface provides access to the Content service (formerly the Collaboration service).
This interface provides access to the Content Statistics service.
Represents a document and its output stream to which the document's content should be written during an upload.
This exception is thrown if the context is null or not valid.
Marks a singleton service as context-sensitive, meaning that the service will have a ServiceContextProvider associated with it.
Deprecated.
This functionality is no longer supported and will be removed in the next release.
Controller is the root of the controller objects that allow the automatic control of processes and their tasks.
ControllerException This exception is thrown for controller errors.
LogElement The object log is composed of LogElements.
LogLevel enumeration supported by Controller logging.
Represents a reference to a copied Content item.
Represents an instruction for the source of a Content copy.
Bean that represents a User's credentials
Deprecated. 
Marker interface to be able to create a tree structure while combining filters, search and logical expressions.
 
 
Custom Content object.
This exception may be thrown by service methods detecting a failure when backing up and/or saving the Database.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
This annotation may be removed from the public API in a future release.
Available strategies for working with EPEx data.
Service Provider Interface: this is not intended for external implementation See DataStrategies for available implementers of this interface.
DataStrategyFailedException EPEx could not convert the given data using this strategy.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
Datatype The Datatype of a TypedValue.
Datatype Properties The Datatype Properties of a TypedValue.
Available strategies for working with EPEx data types.
Service Provider Interface: this is not intended for external implementation See DataTypeStrategies for available implementers of this interface.
DataTypeStrategyFailedException EPEx could not convert the given data type using this strategy.
 
Runtime exception thrown when an attempt at text decryption throws an exception.
This marker interface identifiers a class that supports the clone method with deep copy semantics, rather than shallow copy semantics.
 
This exception may be thrown by service methods which themselves are deprecated, or that contain a deprecated combination of parameters.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
Use the class Document instead.
Represents a document in the Knowledge application.
Convenience annotation to indicate a value represents an Appian Object.
Deprecated.
This annotation may be removed from the public API in a future release.
Represents an input stream for a Document object.
Deprecated.
This annotation may be removed from the public API in a future release.
Convenience annotation to indicate a value represents an Appian Object.
Represents an output stream for a Document object.
Deprecated.
Use the class ContentService instead.
This class represents a versioned document in the collaboration application.
This class represents a fragment of a download-related query.
The DrillPath bean describes how data in a report Column links to more information.
Filter for tasks/processes that are due today.
This exception may be thrown while trying to create or modify a Rule with a name that is already registered as an expression function.
This exception may be thrown by service methods detecting that a given id is not unique.
This exception may be thrown by service methods detecting that a given name of a user, group, grouptype, or attribute name is not unique.
Thrown when attempting to place a portlet into a page that already contains the same portlet.
This exception may be thrown by service methods that create content if the UUID specified is already in use for another piece of content.
This exception may be thrown by service methods that create content if the UUID specified is already in use for another piece of content.
Exception that is thrown if the user tries to create a web service to start a process model, and a web service with the same name already exists.
Deprecated.
The Portal functionality will be removed in a future release.
Bean representing dynamic forms
 
ElasticProcess This is the access point for all Elastic Process APIs.
Convenience annotation to indicate a value represents an Appian Object.
Deprecated.
The Notification functionality will be removed in a future release.
Convenience annotation to indicate a value represents an Appian Object.
This class provides default, do-nothing implementations of all ActivityParameterHelper methods.
Convenience annotation to indicate a value represents an Encrypted Text object.
Runtime exception thrown when an attempt at text encryption throws an exception.
Service that provides the capability to encrypt plaintext values and decrypt values of type Encrypted Text.
 
EPExException Root of EPEx API exceptions.
 
Used to indicate that an error includes Appian ErrorCode information
An EscalatedServiceContext is used to strongly-type mark methods that require privilege escalation.
An escalation is an action that occurs if the task has not been completed before the configured TimerEventTrigger triggers.
This class is used to specify escalation properties for a particular node instance.
Base class for all events (both EventTrigger and EventProducer extend this class).
Represents an event producer (an event that performs an action immediately when it is reached in flow).
Deprecated. 
Deprecated. 
Deprecated.
This annotation may be removed from the public API in a future release.
Represents an event trigger (an event that waits for something to occur before continuing flow).
Deprecated. 
Encapsulates reusable logic for handling exceptions.
Provides methods relating to process exception handling.
An ImportDiagnostic that has an associated AppianException.
Deprecated.
use individual method replacements
Title: Expression
This bean will be populated with expression evaluation results when testing a rule.
A TypeDependency represents the variety of type literals that may be discovered as dependencies.
This exception may be thrown by service methods detecting that a given expression is invalid.
Defines service methods related to the use of expressions within the application.
This class holds the metadata for a facet and its options.
This class holds the metadata for an individual option for a facet.
Deprecated.
This class will be removed from the public API in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Bean representing a configured Filter on a column.
The base interface for all filters in analytics.
Enumeration of existing filter expression operators.
Categories used by FilterOperator.
 
Deprecated.
This class pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
Deprecated.
Use the class KnowledgeFolder instead.
Represents a folder in any application.
Deprecated.
The Portal functionality will be removed in a future release.
Convenience annotation to indicate a value represents an Appian Object.
Deprecated.
Use the class ContentService instead.
Bean representing the formconfig
Map of FormConfig objects, keyed by locale.
Deprecated. 
Deprecated. 
 
 
 
The binding to an ActivityClassParameter for an input or element on the form.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Represents a freeform rule, which has a set of parameters and an expression which is run whenever the rule is called.
Indicates that either a method is a function (if placed on a method), or that all public methods in a class are functions (if placed on a class).
This class represents a function in the Expression Editor.
This class represents a function category in the Expression Editor.
This class represents a parameter of a function in the Expression Editor.
This class encapsulates a request by a user for a function to be evaluated.
Deprecated.
This annotation may be removed from the public API in a future release.
This class holds the metadata for a facet and its options.
A builder that will construct a GenericFacet with the correct parameters
This class holds the metadata for an individual option for a facet.
Immutable bean representing a configured Filter on a column.
This class represents a logical expression combining multiple filters in a query.
A Query concrete class An instance can only be obtained by using the helper class GenericQuery.GenericBuilder
A class for incrementally build a GenericQuery.
This class encapsulates all the available Aggregation Functions in a more object oriented way.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This is how you instantiate columns to configure a query for selection, grouping or aggregation.
Deprecated.
Use the class NamedTypedValue instead.
This bean is used to identify an object with Long Id both locally and remotely.
Deprecated.
Globalization updates should be done via the Admin Console.
This bean is used to identify an object with String Id both locally and remotely.
This represents the Group object.
This represents the basic Group object.
Convenience annotation to indicate a value represents an Appian Object.
 
This exception is thrown when trying to delete a group that is being used as an attribute for another group
Holds the group member policy.
The group member viewing policy.
Deprecated.
The Group Message channel and code will be removed in a future release.
Deprecated.
The Group Message channel and code will be removed in a future release.
Deprecated.
The Group Message channel and code will be removed in a future release.
This represents the Group search object.
Group security type bean, holds the groupSecurityTypeID and groupSecurityTypeName
Provides the main functionality needed to create, update, delete, and get groups.
This exception is thrown when an attempt is made to delete a group type but groups exist that reference that group type.
Title: GroupSummary
This represents the common GroupType object.
This represents the base GroupType object.
Provides the main functionality needed to create, update, delete, and get groups types.
Exception indicating that the attempted action could not completed because a GroupType involved in the action is being used by a rule.
 
This exception may be thrown by service methods that delete or deactive content if the content has children and the flag was not set to automatically delete or deactive any children.
Datatypes created from a POJO containing this annotation will be created as hidden data types.
Functions annotated with this annotation will not show up in the Expression Editor UI.
An individual history record, representing an element of an audit trail in a process.
Information about a process model, including id, version, name and uuid.
This bean is used to represent an object with a String name, Long Id, and String UUID.
Deprecated.
This annotation may be removed from the public API in a future release.
This exception may be thrown by service methods that create or modify a content item if the parent is set to the item itself.
Import diagnostics are generated during the import of data types to provide details on any issues or problems that are encountered during the import.
Represents the severity of an import diagnostic.
 
Thrown when a new type could not be imported.
 
Represents the resulting object after an import or inspect operation.
Holds the result of an import of types into the system.
Detailed results from importing or inspecting a package with objects.
This exception is thrown if an archived process file is from an incompatible release version, requiring the migration of the archived process file(s).
The @Input annotation is an optional annotation for smart service setter methods that allows for additional input behaviors to be described.
Class defines how many instances of the node will be created.
This exception may be thrown by service methods that create or modify a content item if the name of the content is insufficiently unique for the type of uniqueness specified (ContentConstants.UNIQUE_NONE, ContentConstants.UNIQUE_FOR_PARENT, ContentConstants.UNIQUE_FOR_TYPE, or ContentConstants.UNIQUE_FOR_ALL).
 
 
An internal form is form that has been uploaded into Collaboration.
This interface will allow for the parsing and processing of forms stored in the collaboration center.
Represents a JMS message to be posted to JMS.
Represents a message in the Appian Messaging framework.
Interval define a period of time in terms of Minutes, Hours, Days, Weeks, Months and Years.
Exception thrown to indicate an invalid ApplicationAction element.
This exception is thrown if the user provides an ActivityClassParameter for an Activity Class, and that Activity Class does not take that parameter.
This exception is thrown if the user calls an API method that acts on an activity class schema (or schemaId or local Id), and that schema does not exist in the database.
This exception is thrown if the user calls an API method that acts on an activity (a task or an unattended activity) and that activity does not exist in the database.
This exception may be thrown by service methods detecting that a given user or group does not exist as an admin of a group.
This exception may be thrown by service methods detecting that the user is logged in as 'anonymous', but anonymous access has not been enabled.
This exception may be thrown by service methods when they detect an invalid state in the Application Object
This exception may be thrown by ContentService.approveVersion(Long, Integer)
Exception that is thrown if the user references an attachment that does not exist in the database.
This exception is thrown when trying to get, update, or delete an attribute for a group type that does not exist
Exception that can be thrown if the user attempts to configure a group or group type attribute incorrectly (that is, by giving an attribute a value which is incompatible with its type).
This exception is thrown if an API method is called that acts on a calendar (or calendar Id) and that calendar does not exist.
Thrown when a category id is used that does not refer to an existing category.
This exception may be thrown by service methods detecting that a collaboration community does not exist.
This exception may be thrown by service methods detecting that a content item does not exist.
Deprecated.
use InvalidUserException
This exception may be thrown by service methods when invalid data formats are passed to the service methods e.g.
 
Exception that is thrown if the user tries to delete a process model, but completed or active processes of that model exist.
This exception may be thrown by service methods detecting that a document or any versions of a document does not exist.
This exception may be thrown by service methods detecting that given email address in invalid.
This exception may be thrown by service methods detecting that the escalation is non-existent or has been deleted.
This exception may be thrown by service methods detecting that an event does not exist.
This exception is thrown if the user calls an API method that acts on a ProcessExceptionType (or exception type id) and that exception type does not exist in the database.
This exception may be thrown by service methods detecting that the expression with the given ID is non-existent or has been deleted.
This exception is thrown if the user calls an API method that acts on an expression group (a task or an unattended activity) and that expression group does not exist in the database.
This exception may be thrown by service methods detecting that a folder does not exist.
Deprecated.
The Portal functionality will be removed in a future release.
Exception that is thrown when a user references a forum that does not exist in the database.
This exception may be thrown by service methods detecting that a given group does not exist.
Deprecated.
The Group Message Channel will be removed in a future release
This exception may be thrown by service methods detecting that a given group type does not exist.
 
This exception may be thrown by service methods detecting that a given knowledge center does not exist.
Deprecated.
The Leader Message channel and code will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
This exception may be thrown by service methods detecting that a local object type does not exist.
This exception is thrown by authenticating service methods detecting that a given username and password do not match.
This exception may be thrown by service methods detecting that a given user or group does not exist as a member of a group.
This exception may be thrown by service methods detecting that a given member policy id when creating a group is either not supported or is not supported in combination with the given security map id and/or viewing policy id.
This exception is thrown by service classes to indicate that a thread message is invalid.
Thrown when a metadata rule id references a rule that is not in the database.
This exception may be thrown by service methods detecting that an invalid or null name was specified for an object.
This exception is thrown whenever an invalid ApplicationNavigationItem element is found.
 
This exception may be thrown by service methods detecting that the user has referenced a node that is not in the database.
Exception that is thrown if a node is started through IFM, but that node is not allowed to have multiple instance (i.e. is restricted by activity chaining).
Exception that is thrown if an invalid operation such as reassigning or starting the logic node is performed.
Exception that is thrown if an invalid operation such as starting node which is set to recur.
This exception is thrown if the user calls an API method that acts on a note (or noteId) and that note does not exist in the database.
Thrown when a notification id is used that does not refer to an existing notification.
Thrown when the user references a notification type that is not in the database.
This exception is thrown if the user calls an API method that acts on an object type id that does not correspond to an id block allocated in Service Manager.
This exception may be thrown by service methods when the given method does not support a particular operation - for instance, it may be thrown when attempting to delete a collaboration folder that contains documents.
Thrown when a page id is used that does not refer to an existing page.
Thrown when the parent group is set for a group that the user does not have permission to set or does not exist.
Thrown when a portlet id is used that does not refer to an existing portlet.
Deprecated.
The Portal functionality will be removed in a future release.
Thrown when a portlet type id is used that does not refer to an existing portlet type.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
This exception may be thrown by service methods detecting that the user has referenced a priority that is not in the database.
This exception is thrown if the user calls an API method that acts on a process (or process Id), and that process does not exist in the database.
This exception may be thrown by service methods detecting that the user has referenced a process model that is not in the database.
Exception that is thrown if the user calls a method with a process variable name that does not match any variable in the database.
 
This exception may be thrown by service methods detecting that the rank name is invalid.
This exception may be thrown by ContentService.rejectVersion(Long, Integer)
This exception should be thrown whenever an invalid role is passed in.
Thrown when an invalid schedule type is triggered.
This exception may be thrown by service methods detecting that an Invalid or null security map Id was specified for new group.
Thrown when a page is not in a state compatible with the action attempted on it.
 
 
This exception may be thrown when trying to create or update a user with a supervisor that does not exist in the database.
Deprecated.
use InvalidActivityException
Exception that is thrown if the user references a thread (now known as Topic) that does not exist in the database.
This exception may be thrown by service methods detecting that the title (rank) is invalid.
Thrown when a type id is used that does not refer to an existing datatype.
This exception may be thrown by service methods if they detect that the type mask provided is invalid.
Thrown when a QName is used to reference an non-existing datatype
This exception may be thrown by service methods detecting that a referenced user does not exist.
Exception that is thrown if a user references a UUID that does not exist in the database.
This exception may be thrown by service methods detecting that a referenced version of an entity (eg a process model) does not exist.
This exception may be thrown by service methods detecting that a given viewing policy id when creating a group is either not supported or is not supported in combination with the given security map id and/or member policy policy id.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Thrown when an XML schema file being imported is found to be invalid.
Thrown when attempting to place a portlet into a non-existing zone in the page.
Contains the values pulled out of jms.properties.
Factory for obtaining JMS connections from the JMS connection pool.
Represents a JMS topic.
Represents an object that can be converted to JSON format so that an equivalent JavaScript object can be created on the client machine.
This marker interface indicates that a JSONable class always returns the same hidden attributes and thus its JSON marshaling information may be cached rather than recalculated each time.
Specifies the location of the JSP for forms that of type JSPForm
Thrown when a key is not found in a map.
Deprecated.
Use the class CommunityKnowledgeCenter instead.
Represents a knowledge center.
Convenience annotation to indicate a value represents an Appian Object.
Deprecated.
Use the class ContentService instead.
Represents a folder in the Knowledge application.
For Kougar connections, this should be used instead of ServiceContext.
 
 
This analytics filter will return the last N processes/tasks to have been completed.
Filter for processes/tasks which have been started in the last N days.
Deprecated.
The Leader Message channel and code will be removed in a future release.
Deprecated.
The Leader Message channel and code will be removed in a future release.
Deprecated.
The Leader Message channel and code will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
An enumeration used as keys for the fields of a ListViewItem.
 
ErrorCodeFormatter based upon a Locale.
LocaleString LocaleString represents one String with representations in one or more Locales, or in all Locales (an insensitive String).
Deprecated. 
Deprecated. 
 
This interface represents the local identifier of an object.
This is a wrapper Exception for the purposes of localizing the exception before it is sent to the client
 
 
This class represents the base class for all first-class Appian Objects.
 
This bean represents the local identifier of an object.
This exception is thrown when the user cannot login because the account is locked.
Exception that indicates operation faliure due to a locking issue.
This class represents a logical expression combining multiple filters in a query.
 
Enumeration containing the valid logical operators which can be used to construct filters.
Deprecated.
The Portal functionality will be removed in a future release.
Represents a name-value mapping.
Deprecated. 
A simple POJO for holding a particular metric.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Container populated with error messages by the validate or onSave methods in a smart service class that extends AppianSmartService.
Represents a send message event.
Represents a receive message event.
Interface to hold error messages.
Represents a schema for a header property of a JMS message.
Service to publish messages to Appian Process and JMS.
Represents a schema (standard set of properties used for a particular purpose) for a JMS message.
Contains the values pulled out of messaging.properties.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Model A Model represents a given process model that is intended to run in EPEx.
ModelMismatchException The model requested does not match the model retrieved.
ModelNotAvailableException The given EPEx model cannot be retrieved.
ModelReference An ModelReference is a reference to a possible Model.
Models Models provides access to models stored in EPEx.
ModelsNotAvailableException Cannot obtain the EPEx environment and its models.
The class includes the multiple instance execution configuration of the node.
Defines the name of the annotated item.
This is a simple bean that represents a name, type and value.
Deprecated. 
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
NodeActionProcessModelResult represents the result of a node action, e.g., starting a node as a task, in the context of a process model.
NodeActionProcessResult represents the result of a node action, e.g., starting a node as a task, in the context of a process.
NodeActionResult contains all the results of NodeActions, e.g., starting a node as a task, grouped initially by process model.
Permissions for the user on a given Task
Thrown when a non-system type is attempted to be used in a context where they are not yet supported.
Deprecated. 
Deprecated. 
Exception that indicates an operation failed because a container was not empty, such as an attempt to delete a Community that still has children.
Deprecated. 
Deprecated. 
Exception that is thrown if the user tries to attach a Note to a process (or task), but the maximum number of allowable notes have already been attached.
Deprecated.
The Notification functionality will be removed in a future release.
Deprecated.
The Notification functionality will be removed in a future release.
Deprecated.
The Notification functionality will be removed in a future release.
Deprecated.
The Notification functionality will be removed in a future release.
This exception may be thrown by ContentService.lock(Long) and ContentService.lock(Long[]) if the content is locked and the current user is not the owner.
Deprecated.
this unused filter will be removed in a future release
NullUserRenameException
 
Enables mapping between Appian type objects and their corresponding type constants.
Holds the operator id and its display name.
 
 
Arguments may or may not have parameters.
Any extender of Execute MUST implement one of these methods.
 
This annotation is used for specifying the order in which the inputs and outputs of the Smart Service should appear in the data tab.
Deprecated.
The Portal functionality will be removed in a future release.
The OutsideNStandardDeviationsFilter returns processes/tasks whose completion duration is more than the specified number of standard deviations above or below the average completion duration.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
Helper functions to convert between PagingInfo Java objects and Appian data types
 
Holds a collection of nodes that can be dropped onto a canvas in the designer to create a process.
A name/id object that can be used by the UI
A category that holds palettes and/or other palette categories in a hierarchy.
This bean is used to represent the top level of all categories in the hierarchy component
A descriptive object that can be used by the UI
Defines the different palette categories that can be used on a custom smart service
Defines the different palettes that can be used on a custom smart service
Empty class needed to create a new node type in the palette hierarchy.
 
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.
This represents a parameter to a model.
Defines the behavior of an expression function parameter.
This class represents the partial evaluation of a function in the Expression Editor, as well as the result of that evaluation.
 
PartialValue A PartialValue contains instructions to modify another value, such as changing particular fields or array elements, done in this way to save storage space.
Convenience annotation to indicate a value represents an Appian Object.
This exception is thrown when the user's password has expired.
This enumeration specifies the different states that a user's password can have in Appian.
Holds information on which content is pending access for making it a favorite.
This exception may be thrown by service methods detecting that content is pending approval, which makes the attempted action illegal.
This object represents the attribute that was executed while generating the report.
This object represents the metrics for the generated report.
Deprecated.
The Portal functionality will be removed in a future release.
Provides access to search methods within Personalization.
Represents a personal knowledge center, which is a knowledge center that only the creator can view.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
Deprecated.
The Notification functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
 
Implementation for the portalState tag, which provides access to a PortalState object initialized from the current HttpServletRequest.
Deprecated.
The Portal functionality will be removed in a future release.
This is the base class for all portlet import/export (ix) helper classes.
Allows mapping local ids to UUIDs.
Allows mapping UUIDs to local ids.
 
 
Deprecated.
The Portal functionality will be removed in a future release.
Encapsulates HTTP session attributes that are specific to a given portlet.
Thrown if (1) user tries to create/modify a portlet so that it is shareable and inherits security from the page it is on or, (2) user tries to unshare a portlet that is on other pages (without using a method explicitly designed to do this).
Deprecated.
The Portal functionality will be removed in a future release.
Deprecated.
The Portal functionality will be removed in a future release.
Indicates that the target of this annotation is exposed in the Appian public API as a preview of new functionality that may be subject to change in future releases.
The precedence of any item in its queue.
 
Exception thrown to indicate that an operation failed because the actor had insufficient security permissions.
PrivilegeException Cannot perform the requested action due to insufficient privilege.
ProcessAdministrationService is used to create and modify properties of the overall process application.
ProcessAnalyticsService provides access to reports on entities and events throughout the process application.
This class supplements the ProcessAnalyticsService with additional methods.
Permissions for the user on the Process Application
Defines the roles of users and groups for a process object.
Exception that is thrown if the user tries to attach an attachment to a process, but that object already has the maximum number of allowed attachments.
ProcessController provides simplified access for controlling a process.
Convenience annotation to indicate a value represents an Appian Object.
ProcessDeletedException This MIGHT have been valid, but is no longer valid.
The ProcessDesignService is used for creating and modifying ProcessModel which are organized by storing them in ProcessModelFolder objects.
Contains detailed information about a process.
A runtime representation of a ProcessModel.
Contains metadata about an exception (error) that occurred while a process was executing.
Metadata about a class of process exceptions (errors that occur while a process is executing).
Interface to the business logic for the process runtime.
Utility methods dealing with processes
ProcessInstance This represents an EPEx process instance.
Deprecated.
This annotation may be removed from the public API in a future release.
The template from which processes are created.
Inner class that holds the name, id, and description of a process model.
Convenience annotation to indicate a value represents an Appian Object.
Holds detailed metadata about a ProcessModel.
Manages the loading and storing and other utility functions of process models.
Bean that represents a folder into which ProcessModels can be stored.
Permissions for the user to folders where process models are stored
 
 
Permissions for the user on the Process Model
Holds the properties of a process model.
Holds summary information about a process model, such as who created it, when, how many process instances are running, and how many have completed.
Bean for process model web service
Bean containing a ProcessModel and the errors that were found when trying to publish it.
A node in a process model.
This class encapsulates the permissions of a user for a particular process
Holds the properties of a process.
ProcessReference This represents a reference to an EPEx process instance.
Bean detailing an analytics report specification.
ProcessRequestedException This MIGHT become valid soon, but we won't know until the process has finished initialization.
Defines the roles of users and groups for a process object.
Specifies options and configurations that control behavior when starting a process.
Bean for process starting info
ProcessState represents the state of a process.
Holds high-level, summary metadata about a process.
The outcome of an attempted upgrade of a process.
Represents the outcome of an attempted upgrade of a process.
A variable that is global to a process.
Represents the runtime instance of process variable for a process.
Marker interface for Selection and Aggregation.
An object capable of providing instances of type T.
 
Defines the roles of users and groups for an object.
Deprecated. 
Deprecated. 
An object-oriented representation of a query.
A class for incrementally build a Query.
Interface for incrementally build a Query.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
This interface is available as a preview of functionality that will be added to the supported public API in a future release.
 
This class encapsulates all the available Aggregation Functions in a more object oriented way.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This is how you instantiate columns to configure a query for selection, grouping or aggregation.
A QuickFilter is a set of QuickFilterItems.
A QuickFilterItem is a set of Filters.
READ ONLY: Only methods that access read-only data.
Used to specify properties of a node that is set to re-execute after every configurable interval of time.
Class defines condition under which Recurrence stops for a node in process.
This class is used to specify properties for a particular node instance that is set to re-execute after every configurable interval of time.
Defines a time interval for an event that repeats after a fixed delay.
Class defines Daily recurring interval
Class defines time interval for Monthly events.
Class that defines time interval for events that occur on a Weekly basis.
Class defines time interval for Yearly events.
This exception is thrown when a relationship is trying to be created that will result in a recursive loop.
This class decorates another UserDetailsService implementation, allowing for a regular expression to be used to extract the username from the value passed into RegexDelegatingUserDetailsService.loadUserByUsername(String).
This bean represents the remote identifier of an object.
This bean represents the remote identifier of an object.
This exception should be thrown when renaming of a Content (like Rule or Constant) is not allowed in certain scenarios.
This exception is thrown if the expression is too complex.
Bean defining the type of data contained in an analytics report.
Bean detailing how an analytics report is to be displayed.
Defines related methods for usage reporting within collaboration.
Contains the results of an Analytics query.
 
This exception is thrown if the report has too many cells.
Validator for ProcessReports.
Declares whether the input parameter is required.
 
This exception is thrown when a user attempts to access a resource (for example, a service API) which is disabled (ie, turned off).
This exception is thrown when a user attempts to access a resource (for example, a service API) which is restricted, and the user does not have sufficient privileges for access (usually determined by group membership).
Base class for storing the results returned by a service call.
Class for storing the results returned by a service call.
Class for storing the results returned by a paging service call.
Deprecated. 
 
 
A marker interface indicating that an Exception is transient.
An ActivityExecutionException that is transient.
A subclass of AppianException that indicates that the exception is transient and the operation can be safely retried.
A subclass of AppianRuntimeException that indicates that the exception is transient and the operation can be safely retried.
A subclass of SmartServiceException that indicates that the exception is transient and the smart service can be safely retried.
The Builder inner class is used to create an instance of the SmartServiceException.
Holds the data for an individual role within a role map.
Takes a set of existing permissions and a set of new permissions and decides how to combine them into a result set.
A mapping of roles and the users and groups that fill those roles.
This class returns information about which users/groups were approved/rejected when modifying the roleMap for a content item.
 
Represents a single condition in the set of conditions on an event trigger.
Represents a rule or a constant in rules (constants are actually a special case of rules).
Convenience annotation to indicate a value represents an Appian Object.
Represents the trigger for a rule event.
Deprecated.
This annotation may be removed from the public API in a future release.
Title: RuleForm
Represents a folder in the Rules application.
Filter for running processes and tasks.
Information about a node in an executed process.
Wrapper for ActivityReturnVariable that enforces non-null value, and contains only getters so that users cannot change the values.
A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
A Schedule is used to define a time for an event based either on an absolute Timestamp or relative to some other event.
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
This class holds a full-text search query, such as "2004 TPS report deadline".
 
 
 
 
 
This bean is used to represent the security on objects in the Application, and what securities that the object can inherit from 'parent' entities, if there are any.
Base class for entities to which security can be applied.
Holds the List of Columns to project the Query by.
This exception will be thrown if a user attempts to change their own username by any means.
This is a marker interface for a Kougar service.
The context used to borrow services from the service provider.
 
Provides utility methods for creating new service contexts.
This is an unchecked exception which occurs whenever there are unforeseen problems in execution of a request served through Appian Standard Library (ASL).
Deprecated. 
Deprecated.
Use services injected by the Appian plug-in framework instead.
Exception meant to represent an error caught by an ApplicationAssociatedObjectTranslator while using an underlying service.
 
Provider implementation which will return a service from the given ServiceContext.
Simple column filter which allows you to filter on any column in the report.
 
 
 
Bean to hold the application calendar settings.
Bean to hold the application locale settings.
Bean to hold the application timezone settings.
 
 
Context available to Smart Service at runtime.
An exception thrown by a smart service in the course of its execution.
The Builder inner class is used to create an instance of the SmartServiceException.
Deprecated.
This annotation may be removed from the public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
 
Nodes that are set to Spawn create multiple instances of themselves, when the process reaches that node.
This class encapsulates the general usage statistics and patterns of the collaboration application.
This interface provides services for other applications using methods related to collaboration download statistics
This exception may be thrown by service methods detecting that the a particular entity cannot be stored because a particular limit has been reached on the server.
 
 
 
 
Defines the environments in which this function is supported
By default, all functions created with the @Function annotation will be marked as supported in the low code platform environment.
Deprecated.
This interface and all of the methods defined within are obsolete and will be removed in a future release.
This exception is thrown when trying to delete an Attribute of a Group Type that is core to the Appian Installation.
Deprecated.
This exception is thrown when trying to delete a group that is core to the Personalization service.
This exception is thrown when trying to delete a group type that is core to the Appian Installation.
TaskController enables testing processes with attended tasks via program automation.
Convenience annotation to indicate a value represents an Appian Object.
Holds a task's high level metadata during design time (i.e. in the process modeler, not during execution.)
More details about a task (attended activity) than are provided in the TaskSummary, including the notes and attachments on the task.
 
Holds the properties of a task.
Holds a high-level summary for a task.
 
Thrown if an authentication request is rejected because the account's temporary credentials have expired.
Thrown if an authentication request is rejected because it's using an account's temporary credentials but cannot be redirected to the interface that allows to enter a new password.
This exception is thrown when the user's temporary password has expired.
This exception could be thrown by an AuthenticationProvider to stop authenticating against other available AuthenticationProviders and immediately fail authentication.
Represents a terminate event producer.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Bean detailing analytics threshold object.
Represents the trigger for a timer event.
This is a marker exception that is intended to be thrown from code that requires a feature toggle to be on.
Thrown when the number of documents exceeds a specified number
This class stores a count and is extended by classes used in the ContentStatisticsService.
This bean tracks the count for a day of the week.
This bean tracks the count for an extension.
This bean tracks the count for a an hour of the day.
This bean tracks the count for a Content type.
Collection of objects such that each object has data and potentially references to other Trees, subject to the following restrictions: Each tree has exactly one root.
Represents a node in tree without relationships to other nodes.
Represents a view of a tree from the position of a node in the tree.
Deprecated. 
The Type annotation enables one to indicate that the annotated method or parameter is dealing with the specified type.
Base class for conversions between frontend and backend data representation.
This class defines mappings between datatypes and a set of TypeConverter's classes used for conversions between frontend and backend data representation.
Deprecated.
Use the TypeService and related APIs instead.
This is a simple bean that represents a type and a value.
 
 
 
 
 
 
 
 
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class holds the metadata for a facet and its options.
A builder that will construct a TypedValueFacet with the correct parameters
This class holds the metadata for an individual option for a facet.
Immutable bean representing a configured Filter on a column.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class represents a logical expression combining multiple filters in a query.
TypedValue Parameter Conversion
A Query concrete class An instance can only be obtained by using the helper class TypedValueQuery.TypedValueBuilder
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class encapsulates all the available Aggregation Functions in a more object oriented way.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This is how you instantiate columns to configure a query for selection, grouping or aggregation.
 
Deprecated.
Use the class NamedTypedValue instead.
 
Deprecated.
Use AppianType instead.
Utility class for TypedVariables
Class representing groups and/or users
HashMap that validates 'K' keys.
 
UiExpressionForm This class represents a user interface generated by expression.
 
This exception is thrown if validation fails (the validate() method of the parameter helper class returns false) when trying to execute an unattended activity.
When updating an application, we will try to lock the object before making any updates in order to avoid race conditions.
This exception is thrown when trying to create or update an attribute type that is not supported by the Personalization service.
Thrown when a given operator is not supported by the Personalization service.
This exception may be thrown by service methods detecting that a relationship type does not exist or is not currently supported.
This exception is thrown if the user calls an API method that acts on a report specification and that specification has an unsupported metric, transformation, attribute, etc.
 
 
This exception may be thrown by service methods detecting that a given role does not exist or is not supported.
This is an unchecked exception which occurs when a client makes a request for a service that was not part of the ASL configuration.
This exception may be thrown by service methods detecting that a given title is not currently supported.
Thrown when an XML schema file being imported is found to contain constructs or references that are not yet supported in the product.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class is available as a preview of functionality that will be added to the supported public API in a future release.
This class represents a fragment of an upload-related query.
This represents the common User object.
This represents the base User object.
Convenience annotation to indicate a value represents an Appian Object.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
Convenience annotation to indicate a value represents an Appian Object.
 
This represents the full User profile object.
Provides the main functionality needed to create, update, delete, and retrieve UserProfile objects from the Personalization service.
Title: UserRank
This represents the User search object.
Provides the main functionality needed to create, update, delete, and retrieve Users.
UserServiceContext can be used to request services explicitly in standalone applications.
Deprecated.
This class encapsulates the user/usage statistics of the collaboration application.
This class is used for statistics on users in the AE system.
Deprecated.
The Discussion Forums functionality will be removed in a future release.
UserUuidTransformation As process audit history returns users in user UUID form, this allows those user UUIDs to be transformed into usernames.
 
 
 
 
Classes implementing this interface can be subjected to runtime validation.
 
An ImportDiagnostic that has an associated ValidationItem.
A ValidationItem associates a ValidationCode to the the supplied parameters.
This is a reference to a variable.
VariableReferenceOnModel represents a VariableReference specific to a model.
Represents a service context that was obtained from the WebServiceContextFactory by sending it a session or request.
Used to manufacture the ServiceContext used within the product and in other web applications.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
This annotation can be used on a custom smart service to designate that it should appear in the palette in a pre-existing palette category.
A bean representing a calendar.
This class is used as a helper to output a JSON String containing the calendar information inside of a Calendar Service
This exception should be thrown when an error occurs trying to write data to a storage location (whether it be writing to a flat file on disk or writing to a DB).
The Writer is used for writing values to External Systems during the Save process of a SAIL expression re-evaluation.
This Exception is thrown when Process Model Importer fails to import or configure a WebService Node (v2)
Implementing classes can be represented in XML.
Class provides utility methods to create an XML document
 
Imports datatypes into the system from XSD.