com.filenet.api.constants
Class TypeID

java.lang.Object
  extended by com.filenet.api.constants.TypeID
All Implemented Interfaces:
java.io.Serializable

public final class TypeID
extends java.lang.Object
implements java.io.Serializable

Provides a set of constants that specify the data type of the values that a property, choice list, or column definition can hold. These constants are returned by the DataType property. When creating a choice list, you must set its DataType property to either LONG or STRING.

See Also:
Serialized Form

Field Summary
static TypeID BINARY
          Specifies a binary data type.
static int BINARY_AS_INT
          An int value associated with the BINARY instance of this class.
static TypeID BOOLEAN
          Specifies a Boolean data type.
static int BOOLEAN_AS_INT
          An int value associated with the BOOLEAN instance of this class.
static TypeID DATE
          Specifies a DateTime data type.
static int DATE_AS_INT
          An int value associated with the DATE instance of this class.
static TypeID DOUBLE
          Specifies a double (Float64) data type.
static int DOUBLE_AS_INT
          An int value associated with the DOUBLE instance of this class.
static TypeID GUID
          Specifies a GUID (ID) data type.
static int GUID_AS_INT
          An int value associated with the GUID instance of this class.
static TypeID LONG
          Specifies a integer data type.
static int LONG_AS_INT
          An int value associated with the LONG instance of this class.
static TypeID OBJECT
          Specifies an object data type.
static int OBJECT_AS_INT
          An int value associated with the OBJECT instance of this class.
static TypeID STRING
          Specifies a string data type.
static int STRING_AS_INT
          An int value associated with the STRING instance of this class.
 
Method Summary
static TypeID getInstanceFromInt(int value)
          Returns an instance of this class using its associated integer value.
 int getValue()
          Returns the internal integer value associated with a specific instance of this class.
 java.lang.String toString()
          Returns a String representation of this enumeration instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OBJECT_AS_INT

public static final int OBJECT_AS_INT
An int value associated with the OBJECT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

OBJECT

public static final TypeID OBJECT
Specifies an object data type. Represents an object that is instantiated from a Content Engine class.


GUID_AS_INT

public static final int GUID_AS_INT
An int value associated with the GUID instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

GUID

public static final TypeID GUID
Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.


LONG_AS_INT

public static final int LONG_AS_INT
An int value associated with the LONG instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

LONG

public static final TypeID LONG
Specifies a integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647.


BOOLEAN_AS_INT

public static final int BOOLEAN_AS_INT
An int value associated with the BOOLEAN instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

BOOLEAN

public static final TypeID BOOLEAN
Specifies a Boolean data type. Represents Boolean data having a value of true or false.


DOUBLE_AS_INT

public static final int DOUBLE_AS_INT
An int value associated with the DOUBLE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DOUBLE

public static final TypeID DOUBLE
Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308.


BINARY_AS_INT

public static final int BINARY_AS_INT
An int value associated with the BINARY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

BINARY

public static final TypeID BINARY
Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes.


STRING_AS_INT

public static final int STRING_AS_INT
An int value associated with the STRING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

STRING

public static final TypeID STRING
Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters.


DATE_AS_INT

public static final int DATE_AS_INT
An int value associated with the DATE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DATE

public static final TypeID DATE
Specifies a DateTime data type. Represents an instance in time as a date and a time of day in accordance with ISO 8601.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static TypeID getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


© Copyright IBM Corporation 2006, 2009. All rights reserved.