Package com.appiancorp.suiteapi.process

Class TypeDescriptor

java.lang.Object
com.appiancorp.suiteapi.process.TypeDescriptor
@Deprecated public class TypeDescriptor extends Object
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 Details

  • Method Details

    • 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(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 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