com.bmc.arsys.api
Class DataType

java.lang.Object
  com.bmc.arsys.api.DataType

All Implemented Interfaces:

Serializable

public final class DataType
extends Object
implements Serializable

The DataType class represents the data types of fields that are supported by the AR System.

See Also:

Serialized Form

Field Summary

static DataType	ATTACHMENT Attachment field.
static DataType	ATTACHMENT_POOL Attachment pool field.
static DataType	BITMASK 32-bit unsigned integer value in which each bit represents a flag turned on or off.
static DataType	BYTES List of bytes containing binary data.
static DataType	CHAR Null-terminated string that requires freeing allocated space.
static DataType	COLUMN Column field.
static DataType	CONTROL Control field.
static DataType	COORDS List of (x,y) coordinate pairs.
static DataType	CURRENCY Currency field.
static DataType	DATE Date field.
static DataType	DECIMAL Fixed-point decimal field.
static DataType	DIARY Null-terminated string that requires freeing allocated space.
static DataType	DISPLAY Specifies a display field (e.g., flashboards; character data).
static DataType	ENUM Set of integer values (beginning with zero)that represent possible selection values as an indexed list.
static DataType	INTEGER 32-bit signed integer data type.
static DataType	JOIN Join field
static DataType	KEYWORD Integer identifying the particular keyword
static DataType	NULL Specifies NULL value.
static DataType	PAGE Page field.
static DataType	PAGE_HOLDER Page holder field.
static DataType	REAL 64-bit floating-point data type.
static DataType	TABLE Table field.
static DataType	TIME UNIX®-style date/time stamp (number of seconds since midnight January 1,1970).
static DataType	TIME_OF_DAY Specifies time (number of seconds since midnight).
static DataType	TRIM Trim field.
static DataType	ULONG 32-bit unsigned integer value.
static DataType	VALUELIST
static DataType	VIEW Specifies a view field (character data).

Method Summary

boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
int	hashCode() Returns the hash code value for this instance of the current class.
static DataType	toDataType(int type) Returns an data type object from a constant.
int	toInt() Returns an integer representation of the data type.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL

public static final DataType NULL

Specifies NULL value.

KEYWORD

public static final DataType KEYWORD

Integer identifying the particular keyword

INTEGER

public static final DataType INTEGER

32-bit signed integer data type.

REAL

public static final DataType REAL

64-bit floating-point data type.

CHAR

public static final DataType CHAR

Null-terminated string that requires freeing allocated space. A NULL pointer of this type is equivalent to using AR_DATA_TYPE_NULL.

DIARY

public static final DataType DIARY

Null-terminated string that requires freeing allocated space. A NULL pointer of this type is equivalent to using AR_DATA_TYPE_NULL.

ENUM

public static final DataType ENUM

Set of integer values (beginning with zero)that represent possible selection values as an indexed list.

TIME

public static final DataType TIME

UNIX^®-style date/time stamp (number of seconds since midnight January 1,1970).

BITMASK

public static final DataType BITMASK

32-bit unsigned integer value in which each bit represents a flag turned on or off.

BYTES

public static final DataType BYTES

List of bytes containing binary data.

DECIMAL

public static final DataType DECIMAL

Fixed-point decimal field.

ATTACHMENT

public static final DataType ATTACHMENT

Attachment field.

CURRENCY

public static final DataType CURRENCY

Currency field.

DATE

public static final DataType DATE

Date field.

TIME_OF_DAY

public static final DataType TIME_OF_DAY

Specifies time (number of seconds since midnight).

JOIN

public static final DataType JOIN

Join field

TRIM

public static final DataType TRIM

Trim field.

CONTROL

public static final DataType CONTROL

Control field.

TABLE

public static final DataType TABLE

Table field.

COLUMN

public static final DataType COLUMN

Column field.

PAGE

public static final DataType PAGE

Page field.

PAGE_HOLDER

public static final DataType PAGE_HOLDER

Page holder field.

ATTACHMENT_POOL

public static final DataType ATTACHMENT_POOL

Attachment pool field.

ULONG

public static final DataType ULONG

32-bit unsigned integer value.

COORDS

public static final DataType COORDS

List of (x,y) coordinate pairs.

VIEW

public static final DataType VIEW

Specifies a view field (character data).

DISPLAY

public static final DataType DISPLAY

Specifies a display field (e.g., flashboards; character data).

VALUELIST

public static final DataType VALUELIST

Method Detail

toDataType

public static DataType toDataType(int type)

Returns an data type object from a constant.

Parameters:

type - constant

Returns:

return a datatype object

toInt

public int toInt()

Returns an integer representation of the data type.

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance