TypeDescriptor (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.TypeDescriptor

Deprecated.
Use the TypeService and related APIs instead.
```
@Deprecated
public class TypeDescriptor
extends java.lang.Object
```
Maintains metadata about each of the TypedVariable types. This class follows the typesafe enumeration idiom, and instances can be accessed through the getByType() factory methods.

See Also:

TypedVariable

Field Summary

Fields
Modifier and Type	Field and Description
`static TypeDescriptor`	`BEAN` Deprecated.
`static TypeDescriptor`	`BOOLEAN` Deprecated.
`static int`	`CLASS_APPIAN` Deprecated.
`static int`	`CLASS_NONE` Deprecated.
`static int`	`CLASS_PRIMARY` Deprecated.
`static TypeDescriptor`	`COLLABORATION_COMMUNITY` Deprecated.
`static TypeDescriptor`	`CONTENT` Deprecated.
`static int`	`DATATYPE_BEAN` Deprecated.
`static int`	`DATATYPE_BOOLEAN` Deprecated.
`static int`	`DATATYPE_CONTENT` Deprecated.
`static int`	`DATATYPE_DATE` Deprecated.
`static int`	`DATATYPE_DATETIME` Deprecated.
`static int`	`DATATYPE_DEFERRED` Deprecated.
`static int`	`DATATYPE_DOUBLE` Deprecated.
`static int`	`DATATYPE_EMAIL_RECIPIENT` Deprecated.
`static int`	`DATATYPE_LONG` Deprecated.
`static int`	`DATATYPE_PEOPLE` Deprecated.
`static int`	`DATATYPE_STRING` Deprecated.
`static int`	`DATATYPE_TIME` Deprecated.
`static int`	`DATATYPE_UNKNOWN` Deprecated.
`static TypeDescriptor`	`DATE` Deprecated.
`static TypeDescriptor`	`DATETIME` Deprecated.
`static TypeDescriptor`	`DEFERRED` Deprecated.
`static TypeDescriptor`	`DOCUMENT` Deprecated.
`static TypeDescriptor`	`DOUBLE` Deprecated.
`static TypeDescriptor`	`EMAIL_ADDRESS` Deprecated.
`static TypeDescriptor`	`EMAIL_RECIPIENT` Deprecated.
`static TypeDescriptor`	`EVENT` Deprecated.
`static TypeDescriptor`	`FOLDER` Deprecated.
`static TypeDescriptor`	`FORUM` Deprecated.
`static TypeDescriptor`	`GROUP` Deprecated.
`static TypeDescriptor`	`KNOWLEDGE_CENTER` Deprecated.
`static TypeDescriptor`	`LONG` Deprecated.
`static TypeDescriptor`	`MESSAGE` Deprecated.
`static TypeDescriptor`	`PAGE` Deprecated.
`static TypeDescriptor`	`PASSWORD` Deprecated.
`static TypeDescriptor`	`PEOPLE` Deprecated.
`static TypeDescriptor`	`PROCESS` Deprecated.
`static TypeDescriptor`	`PROCESS_MODEL` Deprecated.
`static TypeDescriptor`	`STRING` Deprecated.
`static TypeDescriptor`	`THREAD` Deprecated.
`static TypeDescriptor`	`TIME` Deprecated.
`static TypeDescriptor`	`USER` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static TypeDescriptor`	`getByType(int type_)` Deprecated. Retrieves the type descriptor for the given `TypedVariable` type.
`static TypeDescriptor`	`getByType(java.lang.Long type_)` Deprecated. Retrieves the type descriptor for the given `TypedVariable` type.
`int`	`getClassType()` Deprecated. Gets the type classification of this type.
`int`	`getDataType()` Deprecated. Gets the underlying datatype of this type.
`int`	`getType()` Deprecated. Gets the `TypedVariable` type that this type descriptor describes.
`java.lang.Class`	`getUnderlyingClass()` Deprecated. Gets the class of the objects that should be set as the value for this type.
`boolean`	`isDesignTimeOnly()` Deprecated. Determines whether this type is only supported at design time.
`boolean`	`isPossiblyMultiple()` Deprecated. Determines whether this type can support multiple values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_NONE
```
public static final int CLASS_NONE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CLASS_PRIMARY
```
public static final int CLASS_PRIMARY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CLASS_APPIAN
```
public static final int CLASS_APPIAN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_UNKNOWN
```
public static final int DATATYPE_UNKNOWN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_DATE
```
public static final int DATATYPE_DATE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_TIME
```
public static final int DATATYPE_TIME
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_DATETIME
```
public static final int DATATYPE_DATETIME
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_LONG
```
public static final int DATATYPE_LONG
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_DOUBLE
```
public static final int DATATYPE_DOUBLE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_STRING
```
public static final int DATATYPE_STRING
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_BOOLEAN
```
public static final int DATATYPE_BOOLEAN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_PEOPLE
```
public static final int DATATYPE_PEOPLE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_CONTENT
```
public static final int DATATYPE_CONTENT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_BEAN
```
public static final int DATATYPE_BEAN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_DEFERRED
```
public static final int DATATYPE_DEFERRED
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATATYPE_EMAIL_RECIPIENT
```
public static final int DATATYPE_EMAIL_RECIPIENT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final TypeDescriptor DATE
```
    Deprecated.
  - TIME
```
public static final TypeDescriptor TIME
```
    Deprecated.
  - DATETIME
```
public static final TypeDescriptor DATETIME
```
    Deprecated.
  - LONG
```
public static final TypeDescriptor LONG
```
    Deprecated.
  - DOUBLE
```
public static final TypeDescriptor DOUBLE
```
    Deprecated.
  - STRING
```
public static final TypeDescriptor STRING
```
    Deprecated.
  - BOOLEAN
```
public static final TypeDescriptor BOOLEAN
```
    Deprecated.
  - USER
```
public static final TypeDescriptor USER
```
    Deprecated.
  - GROUP
```
public static final TypeDescriptor GROUP
```
    Deprecated.
  - PEOPLE
```
public static final TypeDescriptor PEOPLE
```
    Deprecated.
  - EMAIL_ADDRESS
```
public static final TypeDescriptor EMAIL_ADDRESS
```
    Deprecated.
  - EMAIL_RECIPIENT
```
public static final TypeDescriptor EMAIL_RECIPIENT
```
    Deprecated.
  - DOCUMENT
```
public static final TypeDescriptor DOCUMENT
```
    Deprecated.
  - FOLDER
```
public static final TypeDescriptor FOLDER
```
    Deprecated.
  - CONTENT
```
public static final TypeDescriptor CONTENT
```
    Deprecated.
  - KNOWLEDGE_CENTER
```
public static final TypeDescriptor KNOWLEDGE_CENTER
```
    Deprecated.
  - COLLABORATION_COMMUNITY
```
public static final TypeDescriptor COLLABORATION_COMMUNITY
```
    Deprecated.
  - PAGE
```
public static final TypeDescriptor PAGE
```
    Deprecated.
  - MESSAGE
```
public static final TypeDescriptor MESSAGE
```
    Deprecated.
  - THREAD
```
public static final TypeDescriptor THREAD
```
    Deprecated.
  - FORUM
```
public static final TypeDescriptor FORUM
```
    Deprecated.
  - BEAN
```
public static final TypeDescriptor BEAN
```
    Deprecated.
  - PASSWORD
```
public static final TypeDescriptor PASSWORD
```
    Deprecated.
  - DEFERRED
```
public static final TypeDescriptor DEFERRED
```
    Deprecated.
  - EVENT
```
public static final TypeDescriptor EVENT
```
    Deprecated.
  - PROCESS_MODEL
```
public static final TypeDescriptor PROCESS_MODEL
```
    Deprecated.
  - PROCESS
```
public static final TypeDescriptor PROCESS
```
    Deprecated.
- Method Detail
  - getByType
```
public static final TypeDescriptor getByType(int type_)
```
    Deprecated.
    
    Retrieves the type descriptor for the given TypedVariable type.
    
    Parameters:
    
    type_ - The type of the descriptor to return; this should be one of the TypedVariable constants defined in TypedVariable.
    
    Returns:
    
    The type descriptor, or null if no descriptor exists for this type.
  - getByType
```
public static final TypeDescriptor getByType(java.lang.Long type_)
```
    Deprecated.
    
    Retrieves the type descriptor for the given TypedVariable type.
    
    Parameters:
    
    type_ - A Long holding the type of the descriptor to return; this should be one of the TypedVariable constants defined in TypedVariable.
    
    Returns:
    
    The type descriptor, or null if no descriptor exists for this type or if the passed object is null.
  - getClassType
```
public int getClassType()
```
    Deprecated.
    
    Gets the type classification of this type.
    
    Returns:
    
    One of the CLASS_XXX constants defined by this class.
  - getDataType
```
public int getDataType()
```
    Deprecated.
    
    Gets the underlying datatype of this type.
    
    Returns:
    
    One of the DATATYPE_XXX constants defined by this class.
  - isDesignTimeOnly
```
public boolean isDesignTimeOnly()
```
    Deprecated.
    
    Determines whether this type is only supported at design time. Currently, the only such type is DEFERRED.
    
    Returns:
    
    true if the type is only supported at design time, and false otherwise
  - isPossiblyMultiple
```
public boolean isPossiblyMultiple()
```
    Deprecated.
    
    Determines whether this type can support multiple values. Currently, the only type that does not support multiples is DEFERRED.
    
    Returns:
    
    true if the type supports multiples, and false otherwise
  - getType
```
public int getType()
```
    Deprecated.
    
    Gets the TypedVariable type that this type descriptor describes.
    
    Returns:
    
    The type that this descriptor describes, which is one of the TypedVariable constants defined in TypedVariable.
  - getUnderlyingClass
```
public java.lang.Class getUnderlyingClass()
```
    Deprecated.
    
    Gets the class of the objects that should be set as the value for this type. The class for DOCUMENT, for example, is java.lang.Long. Variables of type DEFERRED have no value, so their underlying class is null. Variables of type BEAN should have values that are of the same class as the variable (such as ActivityClassParameter), and should always be arrays. For all other types, the class returned is a scalar, and if the variable supports multiple values, the value should be set as an array of objects of that class.
    
    Returns:
    
    the class of the value of a variable of this type

Class TypeDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_NONE

CLASS_PRIMARY

CLASS_APPIAN

DATATYPE_UNKNOWN

DATATYPE_DATE

DATATYPE_TIME

DATATYPE_DATETIME

DATATYPE_LONG

DATATYPE_DOUBLE

DATATYPE_STRING

DATATYPE_BOOLEAN

DATATYPE_PEOPLE

DATATYPE_CONTENT

DATATYPE_BEAN

DATATYPE_DEFERRED

DATATYPE_EMAIL_RECIPIENT

DATE

TIME

DATETIME

LONG

DOUBLE

STRING

BOOLEAN

USER

GROUP

PEOPLE

EMAIL_ADDRESS

EMAIL_RECIPIENT

DOCUMENT

FOLDER

CONTENT

KNOWLEDGE_CENTER

COLLABORATION_COMMUNITY

PAGE

MESSAGE

THREAD

FORUM

BEAN

PASSWORD

DEFERRED

EVENT

PROCESS_MODEL

PROCESS

Method Detail

getByType

getByType

getClassType

getDataType

isDesignTimeOnly

isPossiblyMultiple

getType

getUnderlyingClass