webMethods Broker Administration Java API
Version 9.5.1.0.171 091713

COM.activesw.api.client
Class BrokerTypeDef

java.lang.Object
  extended by COM.activesw.api.client.BrokerTypeDef

public class BrokerTypeDef
extends java.lang.Object

This type is used to represent a type definition. A type definition is valid until its client disconnects (or is desstroyed) or until the type cache is flushed.

The constants FIELD_TYPE_* are for use throughout the API as a way to identify a type.


Field Summary
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
           
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FIELD_TYPE_BYTE

public static final short FIELD_TYPE_BYTE
See Also:
Constant Field Values

FIELD_TYPE_SHORT

public static final short FIELD_TYPE_SHORT
See Also:
Constant Field Values

FIELD_TYPE_INT

public static final short FIELD_TYPE_INT
See Also:
Constant Field Values

FIELD_TYPE_LONG

public static final short FIELD_TYPE_LONG
See Also:
Constant Field Values

FIELD_TYPE_FLOAT

public static final short FIELD_TYPE_FLOAT
See Also:
Constant Field Values

FIELD_TYPE_DOUBLE

public static final short FIELD_TYPE_DOUBLE
See Also:
Constant Field Values

FIELD_TYPE_BOOLEAN

public static final short FIELD_TYPE_BOOLEAN
See Also:
Constant Field Values

FIELD_TYPE_DATE

public static final short FIELD_TYPE_DATE
See Also:
Constant Field Values

FIELD_TYPE_CHAR

public static final short FIELD_TYPE_CHAR
See Also:
Constant Field Values

FIELD_TYPE_UNICODE_CHAR

public static final short FIELD_TYPE_UNICODE_CHAR
See Also:
Constant Field Values

FIELD_TYPE_STRING

public static final short FIELD_TYPE_STRING
See Also:
Constant Field Values

FIELD_TYPE_UNICODE_STRING

public static final short FIELD_TYPE_UNICODE_STRING
See Also:
Constant Field Values

FIELD_TYPE_SEQUENCE

public static final short FIELD_TYPE_SEQUENCE
See Also:
Constant Field Values

FIELD_TYPE_STRUCT

public static final short FIELD_TYPE_STRUCT
See Also:
Constant Field Values

FIELD_TYPE_EVENT

public static final short FIELD_TYPE_EVENT
See Also:
Constant Field Values

FIELD_TYPE_UNKNOWN

public static final short FIELD_TYPE_UNKNOWN
See Also:
Constant Field Values

STORAGE_VOLATILE

public static final int STORAGE_VOLATILE
See Also:
Constant Field Values

STORAGE_PERSISTENT

@Deprecated
public static final int STORAGE_PERSISTENT
Deprecated. 
See Also:
Constant Field Values

STORAGE_GUARANTEED

public static final int STORAGE_GUARANTEED
See Also:
Constant Field Values

VALIDATION_FULL

public static final int VALIDATION_FULL
See Also:
Constant Field Values

VALIDATION_OPEN

public static final int VALIDATION_OPEN
See Also:
Constant Field Values

VALIDATION_NONE

public static final int VALIDATION_NONE
See Also:
Constant Field Values
Method Detail

getBrokerHost

public java.lang.String getBrokerHost()
Get the broker host where this event type is defined. Returns null if this object is not associated with a broker.


getBrokerPort

public int getBrokerPort()
Get the broker host port where this event type is defined. Returns -1 if this object is not associated with a broker.


getTerritoryName

public java.lang.String getTerritoryName()
Get the territory name where this event type is defined. Returns null if this object is not associated with a broker.


getBrokerName

public java.lang.String getBrokerName()
Get the broker name where this event type is defined. Returns null if this object is not associated with a broker.


getTypeName

public java.lang.String getTypeName()
Get the fully qualified name of this event type.


getBaseTypeName

public java.lang.String getBaseTypeName()
Get the base name (name without scope qualifier) of this event type.


getScopeTypeName

public java.lang.String getScopeTypeName()
Get the name of this event type's scope.


getTimeToLive

public int getTimeToLive()
                  throws BrokerException
Get the type's time-to-live. Zero is 'forever'.

Throws:
BrokerInvalidTypeException - If the type is not an event.
BrokerException

getStorageType

public int getStorageType()
                   throws BrokerException
Get the type's storage type. Uses the STORAGE_* values.

Throws:
BrokerInvalidTypeException - If the type is not an event.
BrokerException

getValidationType

public int getValidationType()
                      throws BrokerException
Get the type's validation type. Uses the VALIDATION_* values.

Throws:
BrokerInvalidTypeException - If the type is not an event.
BrokerException

getDescription

public java.lang.String getDescription()
                                throws BrokerException
Get the type's description.

Throws:
BrokerInvalidTypeException - If the type is not an event.
BrokerException

getFieldNames

public java.lang.String[] getFieldNames(java.lang.String field_name)
                                 throws BrokerException
Get the list of field names in an event type. If field_name is null or "", it gets the fields a the top level of the event. Otherwise, the field_name should refer to a structure field and it will return the names at that level. Non-structured types will return zero names.

Throws:
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

getFieldType

public short getFieldType(java.lang.String field_name)
                   throws BrokerException
Get the type for a given field.

Throws:
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

getFieldDef

public BrokerTypeDef getFieldDef(java.lang.String field_name)
                          throws BrokerException
Get the BrokerTypeDef for a given field.

Throws:
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

getFieldDefInternal

public BrokerTypeDef getFieldDefInternal(java.lang.String full_field_name,
                                         java.lang.String field_name)
                                  throws BrokerException
Throws:
BrokerException

toString

public java.lang.String toString()
Get a string representation of the type definition.

Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(int indent_level)
Get a string representation of the type definition. The "indent_level" is the number of 4-space indents that the output should be generated for.


webMethods Broker Administration Java API
Version 9.5.1.0.171 091713


Copyright © 2001 - 2013 Software AG Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their suppliers.