com.appiancorp.suiteapi.process

Class AppianTypeCache

java.lang.Object

com.appiancorp.suiteapi.process.AppianTypeCache

All Implemented Interfaces:

JSONable, JSONCacheable, XMLable, java.io.Serializable

public class AppianTypeCache
extends java.lang.Object
implements JSONCacheable, XMLable, java.io.Serializable

Holds the ids and display names of Appian-typed objects such as users and groups. Generally, a cache is created for an entity such as an ActivityClass or a ProcessModel, and when that entity is loaded, the primary keys of all of the Appian-typed objects in the entity's object graph are added to the cache using addAppianType(java.lang.Integer, java.lang.Long). After the primary keys have been added, one can call populate(com.appiancorp.services.ServiceContext) to fetch the display names. Once the cache has been populated,display names can be retrieved through the getDisplayName(java.lang.Long, java.lang.Integer) and getDisplayNames(java.lang.Long[], java.lang.Integer) methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	AT_COMMUNITIES Appian type constant for communities
static java.lang.Integer	AT_CONTENT Appian type constant for content
static java.lang.Integer	AT_CONTENT_CONSTANT Appian type constant for content
static java.lang.Integer	AT_DOCS Appian type constant for documents
static java.lang.Integer	AT_EMAIL_ADDRESSES Appian type constant for email addresses
static java.lang.Integer	AT_EVENTS
static java.lang.Integer	AT_FOLDERS Appian type constant for folders
static java.lang.Integer	AT_FORUMS Appian type constant for forums
static java.lang.Integer	AT_GROUPS Appian type constant for groups
static java.lang.Integer	AT_KCS Appian type constant for knowledge centers
static java.lang.Integer	AT_MESSAGES Appian type constant for messages
static java.lang.Integer	AT_PAGES Appian type constant for pages
static java.lang.Integer	AT_PROCESS_MODELS Appian type constant for process models
static java.lang.Integer	AT_PROCESSES Appian type constant for processes
static java.lang.Integer	AT_PROCESSMODEL_FOLDER Appian type constant for process model folders
static java.lang.Integer	AT_THREADS Appian type constant for threads
static java.lang.Integer	AT_USERS Appian type constant for users

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
AppianTypeCache()

Method Summary

Modifier and Type	Method and Description
void	addAppianType(java.lang.Integer type_, java.lang.Long id_) Adds the primary key of the given Appian type to the table of Appian-typed objects.
void	addAppianType(java.lang.Integer type_, java.lang.String id_) Adds a String primary key of the given Appian type to the table of Appian-typed objects.
void	addAppianTypeOrTypes(int type_, boolean isMultiple_, java.lang.Object value_)
void	addAppianTypes(java.lang.Integer type_, java.lang.Long[] ids_)
void	addAppianTypes(java.lang.Integer type_, java.lang.String[] ids_) Adds String primary keys to the cache for the given type.
java.lang.String[]	getAllDisplayNames(java.util.Locale l_)
static java.lang.Integer	getAtcTypeForTypedVariableType(int type_) Utility method to retrieve the cache key for the given TypedVariable type.
java.lang.String	getDisplayName(LocalObject lo_, java.lang.Integer type_)
java.lang.String	getDisplayName(java.lang.Long id_, java.lang.Integer type_) Fetches the display name for the integer primary key of the given type.
java.lang.String	getDisplayName(java.lang.String id_, java.lang.Integer type_) Fetches the display name for the string primary key of the given type.
java.lang.String[]	getDisplayNames(LocalObject[] los_, java.lang.Integer type_)
java.lang.String[]	getDisplayNames(java.lang.Long[] ids_, java.lang.Integer type_) Fetches the display names for the integer primary keys of the given type.
java.lang.String[]	getDisplayNames(java.lang.Object id_, java.lang.Integer type_)
java.lang.String[]	getDisplayNames(java.lang.Object id_, java.lang.Integer type_, boolean isMultiple)
java.lang.String[]	getDisplayNames(java.lang.String[] ids_, java.lang.Integer type_) Fetches the display names for the string primary keys of the given type.
java.util.Map	getFullMap()
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
boolean	getInvalidReferences() Adds multiple instances of the given Appian type to the table of Appian-typed objects.
java.util.Map	getMap(java.lang.Integer key_) Retreives the map of ids to display names for the given key.
java.lang.Integer[]	getPopulatedTypes() Retrieves the keys for the Appian types for which this cache has entries.
com.appiancorp.process.design.validation.Errors	populate(ServiceContext sc) Uses the given user to populate the display names.
com.appiancorp.process.design.validation.Errors	populate(ServiceContext sc, boolean includeCurrentUser_)
void	setDisplayName(java.lang.Integer type_, java.lang.Long id_, java.lang.String display_)
void	setDisplayName(java.lang.Integer type_, java.lang.String id_, java.lang.String display_)
java.lang.String	toXML() Generates an XML representation of this object (including all child objects).
void	toXML(java.lang.StringBuilder buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Detail

AT_USERS

public static final java.lang.Integer AT_USERS

Appian type constant for users

AT_GROUPS

public static final java.lang.Integer AT_GROUPS

Appian type constant for groups

AT_FOLDERS

public static final java.lang.Integer AT_FOLDERS

Appian type constant for folders

AT_DOCS

public static final java.lang.Integer AT_DOCS

Appian type constant for documents

AT_PAGES

public static final java.lang.Integer AT_PAGES

Appian type constant for pages

AT_FORUMS

public static final java.lang.Integer AT_FORUMS

Appian type constant for forums

AT_THREADS

public static final java.lang.Integer AT_THREADS

Appian type constant for threads

AT_MESSAGES

public static final java.lang.Integer AT_MESSAGES

Appian type constant for messages

AT_KCS

public static final java.lang.Integer AT_KCS

Appian type constant for knowledge centers

AT_CONTENT

public static final java.lang.Integer AT_CONTENT

Appian type constant for content

AT_CONTENT_CONSTANT

public static final java.lang.Integer AT_CONTENT_CONSTANT

Appian type constant for content

AT_EMAIL_ADDRESSES

public static final java.lang.Integer AT_EMAIL_ADDRESSES

Appian type constant for email addresses

AT_PROCESS_MODELS

public static final java.lang.Integer AT_PROCESS_MODELS

Appian type constant for process models

AT_PROCESSES

public static final java.lang.Integer AT_PROCESSES

Appian type constant for processes

AT_COMMUNITIES

public static final java.lang.Integer AT_COMMUNITIES

Appian type constant for communities

AT_EVENTS

public static final java.lang.Integer AT_EVENTS

AT_PROCESSMODEL_FOLDER

public static final java.lang.Integer AT_PROCESSMODEL_FOLDER

Appian type constant for process model folders

Constructor Detail

AppianTypeCache

public AppianTypeCache()

Method Detail

getHiddenAttributes

public java.util.HashSet getHiddenAttributes()

Description copied from interface: JSONable

Returns the set of attributes (properties) that should not be included in the JSON representation of the object.

Specified by:

getHiddenAttributes in interface JSONable

Returns:

the set of hidden attributes

toXML

public java.lang.String toXML()

Description copied from interface: XMLable

Generates an XML representation of this object (including all child objects). A typical implementation is to create a new StringBuilder and call toXML( StringBuilder ) on it.

Specified by:

toXML in interface XMLable

Returns:

The XML representation of this object.

toXML

public void toXML(java.lang.StringBuilder buffer_)

Description copied from interface: XMLable

Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance.

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - The buffer on which to append the XML representation.

getInvalidReferences

public boolean getInvalidReferences()

Adds multiple instances of the given Appian type to the table of Appian-typed objects.

Parameters:

type_ - one of the AT_XXX constants

ids_ - an array of integer primary keys of Appian objects

addAppianTypes

public void addAppianTypes(java.lang.Integer type_,
                           java.lang.Long[] ids_)

setDisplayName

public void setDisplayName(java.lang.Integer type_,
                           java.lang.Long id_,
                           java.lang.String display_)

setDisplayName

public void setDisplayName(java.lang.Integer type_,
                           java.lang.String id_,
                           java.lang.String display_)

addAppianType

public void addAppianType(java.lang.Integer type_,
                          java.lang.Long id_)

Adds the primary key of the given Appian type to the table of Appian-typed objects.

Parameters:

type_ - one of the AT_XXX constants

id_ - an integer primary key of an Appian object

addAppianTypes

public void addAppianTypes(java.lang.Integer type_,
                           java.lang.String[] ids_)

Adds String primary keys to the cache for the given type.

Parameters:

type_ - one of the AT_XXX constants

ids_ - array of String primary keys

addAppianType

public void addAppianType(java.lang.Integer type_,
                          java.lang.String id_)

Adds a String primary key of the given Appian type to the table of Appian-typed objects.

Parameters:

type_ - one of the AT_XXX constants

id_ - a String primary key of an Appian object

addAppianTypeOrTypes

public void addAppianTypeOrTypes(int type_,
                                 boolean isMultiple_,
                                 java.lang.Object value_)

getPopulatedTypes

public java.lang.Integer[] getPopulatedTypes()

Retrieves the keys for the Appian types for which this cache has entries. If any calls to the addAppianType or addAppianTypes methods have been made with a key, the returned array will contain that key.

populate

public com.appiancorp.process.design.validation.Errors populate(ServiceContext sc)

Uses the given user to populate the display names.

populate

public com.appiancorp.process.design.validation.Errors populate(ServiceContext sc,
                                                                boolean includeCurrentUser_)

getAtcTypeForTypedVariableType

public static java.lang.Integer getAtcTypeForTypedVariableType(int type_)

Utility method to retrieve the cache key for the given TypedVariable type.

Parameters:

type_ - one of the constants from TypedVariable

Returns:

the cache key for the given type. Arrays have the same key as their corresponding scalars.

Throws:

java.lang.IllegalArgumentException - if type_is not a valid type.

See Also:

TypedVariable

getAllDisplayNames

public java.lang.String[] getAllDisplayNames(java.util.Locale l_)

getDisplayName

public java.lang.String getDisplayName(java.lang.Long id_,
                                       java.lang.Integer type_)

Fetches the display name for the integer primary key of the given type.

Parameters:

id_ - an integer primary key

type_ - one of the AT_XXX constants indicating an Appian type

Returns:

the display name for the Appian type object of the given type and with the given id, or null if no scuh object exists (or the display name has not been retrieved).

getDisplayNames

public java.lang.String[] getDisplayNames(java.lang.Long[] ids_,
                                          java.lang.Integer type_)

Fetches the display names for the integer primary keys of the given type. Display names will be in the same order as the primary keys, and null will correspond to any primary key for which there is no display name in the cache.

Parameters:

ids_ - an array of integer primary keys

type_ - one of the AT_XXX constants indicating an Appian type

getDisplayName

public java.lang.String getDisplayName(java.lang.String id_,
                                       java.lang.Integer type_)

Fetches the display name for the string primary key of the given type.

Parameters:

id_ - a String primary key

type_ - one of the AT_XXX constants indicating an Appian type

Returns:

the display name for the Appian type object of the given type and with the given id, or null if no scuh object exists (or the display name has not been retrieved).

getDisplayNames

public java.lang.String[] getDisplayNames(java.lang.String[] ids_,
                                          java.lang.Integer type_)

Fetches the display names for the string primary keys of the given type. Display names will be in the same order as the primary keys, and null will correspond to any primary key for which there is no display name in the cache.

Parameters:

ids_ - an array of String primary keys

type_ - one of the AT_XXX constants indicating an Appian type

getDisplayName

public java.lang.String getDisplayName(LocalObject lo_,
                                       java.lang.Integer type_)

getDisplayNames

public java.lang.String[] getDisplayNames(LocalObject[] los_,
                                          java.lang.Integer type_)

getDisplayNames

public java.lang.String[] getDisplayNames(java.lang.Object id_,
                                          java.lang.Integer type_)

getDisplayNames

public java.lang.String[] getDisplayNames(java.lang.Object id_,
                                          java.lang.Integer type_,
                                          boolean isMultiple)

getMap

public java.util.Map getMap(java.lang.Integer key_)

Retreives the map of ids to display names for the given key.

Parameters:

key_ - one of the AT_XXX constants

Returns:

the corresponding map, never null

getFullMap

public java.util.Map getFullMap()