public class ObjectType extends Object
This class defines all the types of objects that are supported
by the Transformer. It contains static instances of the available
object types, which can be used to subscribe to data (see
Subscriber.addSubscriptionListener
),
check an updated object's type (see
TransformerData.getObjectType
) and create a new object (see
DSFactory.createTransformerData
).
The available object types are:
Modifier and Type | Field and Description |
---|---|
static ObjectType |
CONTAINER
A container object.
|
static ObjectType |
GENERIC
The object does not exist in the Transformer cache.
|
static ObjectType |
NEWS
A news headline object.
|
static ObjectType |
PAGE
A page object.
|
static ObjectType |
PERMISSION
A permission object.
|
static ObjectType |
RECORD
A record object.
|
static ObjectType |
RECORD_TYPE2
A type 2 record object.
|
static ObjectType |
RECORD_TYPE3
A type 3 record object.
|
static ObjectType |
STORY
A news story object.
|
static ObjectType |
UNDEFINED
The object does not exist in the Transformer cache.
|
static ObjectType |
UNKNOWN
The object exists but Transformer does not know what type it is yet.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object) |
int |
getCode()
Gets the code that represents the object's type.
|
String |
getDescription()
Gets the description of the object's type.
|
static ObjectType |
getObjectType(int typeCode)
Gets the ObjectType that represents the specified code.
|
int |
hashCode() |
String |
toString()
Returns a string that describes the ObjectType, including its
description and code.
|
public static final ObjectType PAGE
A page object.
public static final ObjectType RECORD
A record object.
public static final ObjectType NEWS
A news headline object.
public static final ObjectType STORY
A news story object.
public static final ObjectType RECORD_TYPE2
A type 2 record object.
public static final ObjectType RECORD_TYPE3
A type 3 record object.
public static final ObjectType CONTAINER
A container object.
public static final ObjectType PERMISSION
A permission object.
public static final ObjectType UNKNOWN
The object exists but Transformer does not know what type it is yet.
public static final ObjectType GENERIC
The object does not exist in the Transformer cache.
public static final ObjectType UNDEFINED
The object does not exist in the Transformer cache.
public static ObjectType getObjectType(int typeCode)
Gets the ObjectType that represents the specified code.
The valid codes are:
PAGE
RECORD
NEWS
STORY
RECORD_TYPE2
RECORD_TYPE3
CONTAINER
PERMISSION
UNKNOWN
UNDEFINED
typeCode
- The code used to describe an object type.public int getCode()
Gets the code that represents the object's type.
public String getDescription()
Gets the description of the object's type.
public String toString()
Returns a string that describes the ObjectType, including its description and code.
Please send bug reports and comments to Caplin support