Package com.appiancorp.suiteapi.process
Class TypeDescriptor
java.lang.Object
com.appiancorp.suiteapi.process.TypeDescriptor
Deprecated.
Use the TypeService and related APIs instead.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated.static final TypeDescriptor
Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic final TypeDescriptor
getByType
(int type_) Deprecated.Retrieves the type descriptor for the givenTypedVariable
type.static final TypeDescriptor
Deprecated.Retrieves the type descriptor for the givenTypedVariable
type.int
Deprecated.Gets the type classification of this type.int
Deprecated.Gets the underlying datatype of this type.int
getType()
Deprecated.Gets theTypedVariable
type that this type descriptor describes.Deprecated.Gets the class of the objects that should be set as the value for this type.boolean
Deprecated.Determines whether this type is only supported at design time.boolean
Deprecated.Determines whether this type can support multiple values.
-
Field Details
-
CLASS_NONE
public static final int CLASS_NONEDeprecated.- See Also:
-
CLASS_PRIMARY
public static final int CLASS_PRIMARYDeprecated.- See Also:
-
CLASS_APPIAN
public static final int CLASS_APPIANDeprecated.- See Also:
-
DATATYPE_UNKNOWN
public static final int DATATYPE_UNKNOWNDeprecated.- See Also:
-
DATATYPE_DATE
public static final int DATATYPE_DATEDeprecated.- See Also:
-
DATATYPE_TIME
public static final int DATATYPE_TIMEDeprecated.- See Also:
-
DATATYPE_DATETIME
public static final int DATATYPE_DATETIMEDeprecated.- See Also:
-
DATATYPE_LONG
public static final int DATATYPE_LONGDeprecated.- See Also:
-
DATATYPE_DOUBLE
public static final int DATATYPE_DOUBLEDeprecated.- See Also:
-
DATATYPE_STRING
public static final int DATATYPE_STRINGDeprecated.- See Also:
-
DATATYPE_BOOLEAN
public static final int DATATYPE_BOOLEANDeprecated.- See Also:
-
DATATYPE_PEOPLE
public static final int DATATYPE_PEOPLEDeprecated.- See Also:
-
DATATYPE_CONTENT
public static final int DATATYPE_CONTENTDeprecated.- See Also:
-
DATATYPE_BEAN
public static final int DATATYPE_BEANDeprecated.- See Also:
-
DATATYPE_DEFERRED
public static final int DATATYPE_DEFERREDDeprecated.- See Also:
-
DATATYPE_EMAIL_RECIPIENT
public static final int DATATYPE_EMAIL_RECIPIENTDeprecated.- See Also:
-
DATE
Deprecated. -
TIME
Deprecated. -
DATETIME
Deprecated. -
LONG
Deprecated. -
DOUBLE
Deprecated. -
STRING
Deprecated. -
BOOLEAN
Deprecated. -
USER
Deprecated. -
GROUP
Deprecated. -
PEOPLE
Deprecated. -
EMAIL_ADDRESS
Deprecated. -
EMAIL_RECIPIENT
Deprecated. -
DOCUMENT
Deprecated. -
FOLDER
Deprecated. -
CONTENT
Deprecated. -
KNOWLEDGE_CENTER
Deprecated. -
COLLABORATION_COMMUNITY
Deprecated. -
PAGE
Deprecated. -
MESSAGE
Deprecated. -
THREAD
Deprecated. -
FORUM
Deprecated. -
BEAN
Deprecated. -
PASSWORD
Deprecated. -
DEFERRED
Deprecated. -
EVENT
Deprecated. -
PROCESS_MODEL
Deprecated. -
PROCESS
Deprecated.
-
-
Method Details
-
getByType
Deprecated.Retrieves the type descriptor for the givenTypedVariable
type.- Parameters:
type_
- The type of the descriptor to return; this should be one of theTypedVariable
constants defined inTypedVariable
.- Returns:
- The type descriptor, or
null
if no descriptor exists for this type.
-
getByType
Deprecated.Retrieves the type descriptor for the givenTypedVariable
type.- Parameters:
type_
- ALong
holding the type of the descriptor to return; this should be one of theTypedVariable
constants defined inTypedVariable
.- Returns:
- The type descriptor, or
null
if no descriptor exists for this type or if the passed object isnull
.
-
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, andfalse
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, andfalse
otherwise
-
getType
public int getType()Deprecated.Gets theTypedVariable
type that this type descriptor describes.- Returns:
- The type that this descriptor describes, which is one of the
TypedVariable
constants defined inTypedVariable
.
-
getUnderlyingClass
Deprecated.Gets the class of the objects that should be set as the value for this type. The class for DOCUMENT, for example, isjava.lang.Long
. Variables of type DEFERRED have no value, so their underlying class isnull
. Variables of type BEAN should have values that are of the same class as the variable (such asActivityClassParameter
), 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
-