com.hcl.domino.data

Enum ItemDataType

java.lang.Object

java.lang.Enum<ItemDataType>

com.hcl.domino.data.ItemDataType

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<ItemDataType>

public enum ItemDataType
extends Enum<ItemDataType>
implements INumberEnum<Short>

Enum for Item datatypes All datatypes below are passed to NSF in either host (machine-specific byte ordering and padding) or canonical form (Intel 86 packed form). The format of each datatype, as it is passed to and from NSF functions, is listed below in the comment field next to each of the data types. (This host/canonical issue is NOT applicable to Intel86 machines, because on that machine, they are the same and no conversion is required). On all other machines, use the ODS subroutine package to perform conversions of those datatypes in canonical format before they can be interpreted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TYPE_ACTION
TYPE_ASSISTANT_INFO
TYPE_CALENDAR_FORMAT
TYPE_COLLATION
TYPE_COMPOSITE Richtext item
TYPE_ERROR
TYPE_FORMULA
TYPE_HIGHLIGHTS
TYPE_HTML
TYPE_ICON
TYPE_INVALID_OR_UNKNOWN
TYPE_LSOBJECT
TYPE_MIME_PART
TYPE_NOTELINK_LIST
TYPE_NOTEREF_LIST
TYPE_NUMBER
TYPE_NUMBER_RANGE
TYPE_OBJECT
TYPE_QUERY
TYPE_RFC822_TEXT
TYPE_SCHED_LIST
TYPE_SEAL
TYPE_SEAL_LIST
TYPE_SEAL2
TYPE_SEALDATA
TYPE_SIGNATURE
TYPE_TEXT
TYPE_TEXT_LIST
TYPE_TIME
TYPE_TIME_RANGE
TYPE_UNAVAILABLE
TYPE_USERDATA
TYPE_USERID
TYPE_VIEW_FORMAT
TYPE_VIEWMAP_DATASET
TYPE_VIEWMAP_LAYOUT
TYPE_WORKSHEET_DATA

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static ItemDataType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ItemDataType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE_ERROR

public static final ItemDataType TYPE_ERROR

TYPE_UNAVAILABLE

public static final ItemDataType TYPE_UNAVAILABLE

TYPE_TEXT

public static final ItemDataType TYPE_TEXT

TYPE_TEXT_LIST

public static final ItemDataType TYPE_TEXT_LIST

TYPE_NUMBER

public static final ItemDataType TYPE_NUMBER

TYPE_NUMBER_RANGE

public static final ItemDataType TYPE_NUMBER_RANGE

TYPE_TIME

public static final ItemDataType TYPE_TIME

TYPE_TIME_RANGE

public static final ItemDataType TYPE_TIME_RANGE

TYPE_FORMULA

public static final ItemDataType TYPE_FORMULA

TYPE_USERID

public static final ItemDataType TYPE_USERID

TYPE_SIGNATURE

public static final ItemDataType TYPE_SIGNATURE

TYPE_ACTION

public static final ItemDataType TYPE_ACTION

TYPE_WORKSHEET_DATA

public static final ItemDataType TYPE_WORKSHEET_DATA

TYPE_VIEWMAP_LAYOUT

public static final ItemDataType TYPE_VIEWMAP_LAYOUT

TYPE_SEAL2

public static final ItemDataType TYPE_SEAL2

TYPE_LSOBJECT

public static final ItemDataType TYPE_LSOBJECT

TYPE_ICON

public static final ItemDataType TYPE_ICON

TYPE_VIEW_FORMAT

public static final ItemDataType TYPE_VIEW_FORMAT

TYPE_SCHED_LIST

public static final ItemDataType TYPE_SCHED_LIST

TYPE_VIEWMAP_DATASET

public static final ItemDataType TYPE_VIEWMAP_DATASET

TYPE_SEAL

public static final ItemDataType TYPE_SEAL

TYPE_MIME_PART

public static final ItemDataType TYPE_MIME_PART

TYPE_SEALDATA

public static final ItemDataType TYPE_SEALDATA

TYPE_NOTELINK_LIST

public static final ItemDataType TYPE_NOTELINK_LIST

TYPE_COLLATION

public static final ItemDataType TYPE_COLLATION

TYPE_RFC822_TEXT

public static final ItemDataType TYPE_RFC822_TEXT

TYPE_COMPOSITE

public static final ItemDataType TYPE_COMPOSITE

Richtext item

TYPE_OBJECT

public static final ItemDataType TYPE_OBJECT

TYPE_HTML

public static final ItemDataType TYPE_HTML

TYPE_ASSISTANT_INFO

public static final ItemDataType TYPE_ASSISTANT_INFO

TYPE_HIGHLIGHTS

public static final ItemDataType TYPE_HIGHLIGHTS

TYPE_NOTEREF_LIST

public static final ItemDataType TYPE_NOTEREF_LIST

TYPE_QUERY

public static final ItemDataType TYPE_QUERY

TYPE_USERDATA

public static final ItemDataType TYPE_USERDATA

TYPE_INVALID_OR_UNKNOWN

public static final ItemDataType TYPE_INVALID_OR_UNKNOWN

TYPE_SEAL_LIST

public static final ItemDataType TYPE_SEAL_LIST

TYPE_CALENDAR_FORMAT

public static final ItemDataType TYPE_CALENDAR_FORMAT

Method Detail

values

public static ItemDataType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ItemDataType c : ItemDataType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ItemDataType 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

NullPointerException - if the argument is null

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum