Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqFieldValue.ValueType

Object
  extended by Enum<CqFieldValue.ValueType>
      extended by CqFieldValue.ValueType
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CqFieldValue.ValueType>
Enclosing interface:
CqFieldValue<T>

public static enum CqFieldValue.ValueType
extends Enum<CqFieldValue.ValueType>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

An enumeration of the possible types of values that can be stored in a record field. This enumeration is more precise than the StpProperty.Type enumeration in specifying the type of a field value.


Enum Constant Summary
ATTACHMENT_LIST
          A field containing attachments
DATE_TIME
          A GMT date/time between 12:00:01 AM January 1, 1970 and 11:59:59 PM January 18, 2038.
DBID
          A database id (integer) field
FLOAT
          A floating point value
ID
          A record id (alphanumeric) field
INTEGER
          An integer in the range -9999999999 to 9999999999
JOURNAL
          A field recording events in the history of the record
MULTILINE_STRING
          An arbitrarily long string of characters, possibly containing one or more newline characters.
RECORD_TYPE
          A field containing the record's record type name
RESOURCE
          A proxy for a Resource of a specific ResourceValueType.
RESOURCE_LIST
          A list of proxies for a Resource of a specific ResourceValueType
SHORT_STRING
          A single-line of text up to 254 characters.
STATE
          A field containing the name of the record's current state
STATE_TYPE
          A field containing the type of the record's current state
UNKNOWN
          An initial value for ValueType variables
 
Method Summary
static CqFieldValue.ValueType fromPropertyType(StpProperty.Type type)
          Returns the ValueType that exactly matches a given PropertyType; otherwise UNKNOWN.
 CqQuery.DisplayField.FieldType toFieldType()
          The CqQuery.DisplayField.FieldType that corresponds to this field type.
 StpProperty.Type toPropertyType()
          The StpProperty.Type that corresponds to this field type.
static CqFieldValue.ValueType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqFieldValue.ValueType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ATTACHMENT_LIST

public static final CqFieldValue.ValueType ATTACHMENT_LIST
A field containing attachments


DATE_TIME

public static final CqFieldValue.ValueType DATE_TIME
A GMT date/time between 12:00:01 AM January 1, 1970 and 11:59:59 PM January 18, 2038.


DBID

public static final CqFieldValue.ValueType DBID
A database id (integer) field


FLOAT

public static final CqFieldValue.ValueType FLOAT
A floating point value


ID

public static final CqFieldValue.ValueType ID
A record id (alphanumeric) field


INTEGER

public static final CqFieldValue.ValueType INTEGER
An integer in the range -9999999999 to 9999999999


JOURNAL

public static final CqFieldValue.ValueType JOURNAL
A field recording events in the history of the record


MULTILINE_STRING

public static final CqFieldValue.ValueType MULTILINE_STRING
An arbitrarily long string of characters, possibly containing one or more newline characters.


RECORD_TYPE

public static final CqFieldValue.ValueType RECORD_TYPE
A field containing the record's record type name


RESOURCE

public static final CqFieldValue.ValueType RESOURCE
A proxy for a Resource of a specific ResourceValueType.


RESOURCE_LIST

public static final CqFieldValue.ValueType RESOURCE_LIST
A list of proxies for a Resource of a specific ResourceValueType


SHORT_STRING

public static final CqFieldValue.ValueType SHORT_STRING
A single-line of text up to 254 characters. Leading and trailing whitespace is trimmed when stored in a record.


STATE

public static final CqFieldValue.ValueType STATE
A field containing the name of the record's current state


STATE_TYPE

public static final CqFieldValue.ValueType STATE_TYPE
A field containing the type of the record's current state


UNKNOWN

public static final CqFieldValue.ValueType UNKNOWN
An initial value for ValueType variables

Method Detail

fromPropertyType

public static CqFieldValue.ValueType fromPropertyType(StpProperty.Type type)
Returns the ValueType that exactly matches a given PropertyType; otherwise UNKNOWN.

Parameters:
type - a Type enumerator
Returns:
the ValueType that exactly matches the given Type PropertyType; otherwise UNKNOWN.

toFieldType

public CqQuery.DisplayField.FieldType toFieldType()
The CqQuery.DisplayField.FieldType that corresponds to this field type.

Returns:
An CqQuery.DisplayField.FieldType enumerator specifying as closely as possible the Java representation of this type of value corresponding

toPropertyType

public StpProperty.Type toPropertyType()
The StpProperty.Type that corresponds to this field type.

Returns:
An StpProperty.Type enumerator specifying as closely as possible the Java representation of this type of value corresponding

valueOf

public static CqFieldValue.ValueType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

values

public static final CqFieldValue.ValueType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CqFieldValue.ValueType c : CqFieldValue.ValueType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

Generated Tue 19-Apr-2011 10:16 PM

Copyright © IBM 2011. All rights reserved.