public class BrokerTypeDef
extends java.lang.Object
The constants FIELD_TYPE_* are for use throughout the API as a way to identify a type.
Modifier and Type | Field and Description |
---|---|
static short |
FIELD_TYPE_BOOLEAN |
static short |
FIELD_TYPE_BYTE |
static short |
FIELD_TYPE_CHAR |
static short |
FIELD_TYPE_DATE |
static short |
FIELD_TYPE_DOUBLE |
static short |
FIELD_TYPE_EVENT |
static short |
FIELD_TYPE_FLOAT |
static short |
FIELD_TYPE_INT |
static short |
FIELD_TYPE_LONG |
static short |
FIELD_TYPE_SEQUENCE |
static short |
FIELD_TYPE_SHORT |
static short |
FIELD_TYPE_STRING |
static short |
FIELD_TYPE_STRUCT |
static short |
FIELD_TYPE_UNICODE_CHAR |
static short |
FIELD_TYPE_UNICODE_STRING |
static short |
FIELD_TYPE_UNKNOWN |
static int |
STORAGE_GUARANTEED |
static int |
STORAGE_PERSISTENT
Deprecated.
|
static int |
STORAGE_VOLATILE |
static int |
VALIDATION_FULL |
static int |
VALIDATION_NONE |
static int |
VALIDATION_OPEN |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBaseTypeName()
Get the base name (name without scope qualifier) of this event type.
|
java.lang.String |
getBrokerHost()
Get the broker host where this event type is defined.
|
java.lang.String |
getBrokerName()
Get the broker name where this event type is defined.
|
int |
getBrokerPort()
Get the broker host port where this event type is defined.
|
java.lang.String |
getDescription()
Get the type's description.
|
BrokerTypeDef |
getFieldDef(java.lang.String field_name)
Get the BrokerTypeDef for a given field.
|
BrokerTypeDef |
getFieldDefInternal(java.lang.String full_field_name,
java.lang.String field_name) |
java.lang.String[] |
getFieldNames(java.lang.String field_name)
Get the list of field names in an event type.
|
short |
getFieldType(java.lang.String field_name)
Get the type for a given field.
|
java.lang.String |
getScopeTypeName()
Get the name of this event type's scope.
|
int |
getStorageType()
Get the type's storage type.
|
java.lang.String |
getTerritoryName()
Get the territory name where this event type is defined.
|
int |
getTimeToLive()
Get the type's time-to-live.
|
java.lang.String |
getTypeName()
Get the fully qualified name of this event type.
|
int |
getValidationType()
Get the type's validation type.
|
java.lang.String |
toString()
Get a string representation of the type definition.
|
java.lang.String |
toString(int indent_level)
Get a string representation of the type definition.
|
public static final short FIELD_TYPE_BYTE
public static final short FIELD_TYPE_SHORT
public static final short FIELD_TYPE_INT
public static final short FIELD_TYPE_LONG
public static final short FIELD_TYPE_FLOAT
public static final short FIELD_TYPE_DOUBLE
public static final short FIELD_TYPE_BOOLEAN
public static final short FIELD_TYPE_DATE
public static final short FIELD_TYPE_CHAR
public static final short FIELD_TYPE_UNICODE_CHAR
public static final short FIELD_TYPE_STRING
public static final short FIELD_TYPE_UNICODE_STRING
public static final short FIELD_TYPE_SEQUENCE
public static final short FIELD_TYPE_STRUCT
public static final short FIELD_TYPE_EVENT
public static final short FIELD_TYPE_UNKNOWN
public static final int STORAGE_VOLATILE
@Deprecated public static final int STORAGE_PERSISTENT
public static final int STORAGE_GUARANTEED
public static final int VALIDATION_FULL
public static final int VALIDATION_OPEN
public static final int VALIDATION_NONE
public java.lang.String getBrokerHost()
public int getBrokerPort()
public java.lang.String getTerritoryName()
public java.lang.String getBrokerName()
public java.lang.String getTypeName()
public java.lang.String getBaseTypeName()
public java.lang.String getScopeTypeName()
public int getTimeToLive() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.BrokerException
public int getStorageType() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.BrokerException
public int getValidationType() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.BrokerException
public java.lang.String getDescription() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.BrokerException
public java.lang.String[] getFieldNames(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event type.BrokerFieldTypeMismatchException
- If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public short getFieldType(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event type.BrokerFieldTypeMismatchException
- If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public BrokerTypeDef getFieldDef(java.lang.String field_name) throws BrokerException
BrokerFieldNotFoundException
- If the field name does not exist in the event type.BrokerFieldTypeMismatchException
- If the field name incorrectly accesses a type (such as using [2] on a non-sequence field).BrokerInvalidFieldNameException
- If the field name is not valid.BrokerException
public BrokerTypeDef getFieldDefInternal(java.lang.String full_field_name, java.lang.String field_name) throws BrokerException
BrokerException
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(int indent_level)
Copyright © 2002-2006 webMethods, Inc. Copyright © 2007-2021 Software AG Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.