Package com.appiancorp.suiteapi.common

Classes and interfaces for working with data structures and concepts that are common throughout Appian.

See: Description

Interface Summary

Interface	Description
Constants	Interface to represent constants used for retrieving and sorting results obtained from database.
DeepCloneable	This marker interface identifiers a class that supports the clone method with deep copy semantics, rather than shallow copy semantics.
GlobalId	This bean is used to identify an object with Long Id both locally and remotely.
GlobalStringId	This bean is used to identify an object with String Id both locally and remotely.
JSONable	Represents an object that can be converted to JSON format so that an equivalent JavaScript object can be created on the client machine.
JSONCacheable	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.
LocalId	This interface represents the local identifier of an object.
LocalStringId	This bean represents the local identifier of an object.
Provider<T>	An object capable of providing instances of type T.
RemoteId	This bean represents the remote identifier of an object.
RemoteStringId	This bean represents the remote identifier of an object.
Role.PermissionMergeStrategy	Takes a set of existing permissions and a set of new permissions and decides how to combine them into a result set.
ServiceName
SynchronizationService	Deprecated This interface and all of the methods defined within are obsolete and will be removed in a future release.
XMLable	Implementing classes can be represented in XML.

Class Summary

Class	Description
AEVRoleMap	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.
BulkArrayConverter	Utility class used to combine an array of array into a single array of combined length and vice versa.
Configuration	Provides support for loading configuration files for the product.
Credentials	Bean that represents a User's credentials
CredentialsReturnConverter	Deprecated
Identity	This bean is used to represent an object with a String name, Long Id, and String UUID.
IntAsBooleanXmlAdapter
LocaleString	LocaleString LocaleString represents one String with representations in one or more Locales, or in all Locales (an insensitive String).
LocaleStringParameterConverter	Deprecated
LocaleStringReturnConverter	Deprecated
LocaleStringXmlAdapter
LocalizedIdentity
LocalObject	This class represents the base class for all first-class Appian Objects.
LocalObjectTypeMapping
NamedTypedValueReturnConverter	Deprecated
ObjectTypeMapping	Enables mapping between Appian type objects and their corresponding type constants.
PartialResultReturnConverter
PublicRoleMap	Defines the roles of users and groups for an object.
Result	Base class for storing the results returned by a service call.
ResultList	Class for storing the results returned by a service call.
ResultPage	Class for storing the results returned by a paging service call.
ResultPageReturnConverter	Deprecated
Role	Holds the data for an individual role within a role map.
RoleMap	A mapping of roles and the users and groups that fill those roles.
RoleSet
Security	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.
SecurityEntry	Base class for entities to which security can be applied.
ServiceFactory	Deprecated
ServiceLocator	Deprecated Use services injected by the Appian plug-in framework instead.
ServiceProvider<T>	Provider implementation which will return a service from the given ServiceContext.
SimpleEngineCredentials
SimpleValueMap
Suggestion
SuggestParam
SuggestParam.SuggestFilter
Tree	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.
TreeNode	Represents a node in tree without relationships to other nodes.
TreePivot	Represents a view of a tree from the position of a node in the tree.
TypeConverter	Base class for conversions between frontend and backend data representation.
TypeConverterResolver	This class defines mappings between datatypes and a set of TypeConverter's classes used for conversions between frontend and backend data representation.
TypedValueParameterConverter	TypedValue Parameter Conversion
Utilities
ValidationCode
ValidationItem	A ValidationItem associates a ValidationCode to the the supplied parameters.

Exception Summary

Exception	Description
ProvisionException

Annotation Types Summary

Annotation Type	Description
Name	Defines the name of the annotated item.
Preview	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.

Package com.appiancorp.suiteapi.common Description

Classes and interfaces for working with data structures and concepts that are common throughout Appian.