|
webMethods Broker Administration Java API Version 9.5.1.0.171 091713 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectCOM.activesw.api.client.BrokerAdminTypeDef
public class BrokerAdminTypeDef
This type is used to represent a type definition as used by admin clients.
Constructor Summary | |
---|---|
BrokerAdminTypeDef(BrokerAdminTypeDef type_def)
Copy constructor. |
|
BrokerAdminTypeDef(BrokerTypeDef normal_def)
Create from a normal type definition. |
|
BrokerAdminTypeDef(short type)
Create a new type definition for a non-Event type. |
|
BrokerAdminTypeDef(java.lang.String type_name,
short type)
Create a new type definition. |
Method Summary | |
---|---|
void |
clearField(java.lang.String field_name)
Clear/delete a given field. |
void |
clearFields()
Clear/delete all fields. |
void |
clearModificationFlag()
Clear the modification flag for the type definition to false. |
java.lang.String |
getBaseTypeName()
Get the base name (name without scope qualifier) of this event type. |
java.lang.String |
getDescription()
Get the type's description. |
BrokerAdminTypeDef |
getFieldDef(java.lang.String field_name)
Get the type of a field as a BrokerAdminTypeDef. |
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. |
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. |
boolean |
hasBeenModified()
Get the modification flag for the type definition. |
void |
insertFieldDef(java.lang.String field_name,
int index,
BrokerAdminTypeDef field_def)
Insert the a field using a BrokerAdminTypeDef. |
boolean |
isSystemDefined()
Check if type is system defined. |
void |
orderFields(java.lang.String field_name,
java.lang.String[] new_field_names)
Set the order of fields in a type. |
void |
renameField(java.lang.String old_field_name,
java.lang.String new_field_name)
Rename or move a field. |
void |
setDescription(java.lang.String description)
Set the type's description. |
void |
setFieldDef(java.lang.String field_name,
BrokerAdminTypeDef field_def)
Set the type of a field. |
void |
setFieldType(java.lang.String field_name,
short field_type,
java.lang.String type_name)
Set the type for a given field. |
void |
setModificationFlag()
Set the modification flag for the type definition to true. |
void |
setStorageType(int storage_type)
Set the type's storage type. |
void |
setTimeToLive(int time_to_live)
Set the type's time-to-live. |
void |
setTypeName(java.lang.String type_name)
Set the fully qualified name of this event type. |
void |
setValidationType(int validation_type)
Set the type's validation type. |
java.lang.String |
toExtendedString()
--- Used by test cases only --- Get a string representation of the type definition and of all related definitions. |
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 |
Constructor Detail |
---|
public BrokerAdminTypeDef(java.lang.String type_name, short type) throws BrokerException
BrokerInvalidEventTypeNameException
- If the type name is not valid.
BrokerInvalidTypeException
- If type is not event or struct.
BrokerNullParameterException
- If type_name is null and type is event.
BrokerException
public BrokerAdminTypeDef(short type) throws BrokerException
BrokerInvalidTypeException
- If type is not valid.
BrokerException
public BrokerAdminTypeDef(BrokerAdminTypeDef type_def) throws BrokerException
BrokerNullParameterException
- If type_def is null.
BrokerException
public BrokerAdminTypeDef(BrokerTypeDef normal_def) throws BrokerException
BrokerNullParameterException
- If normal_def is null.
BrokerException
Method Detail |
---|
public java.lang.String getTypeName()
public java.lang.String getBaseTypeName()
public java.lang.String getScopeTypeName()
public void setTypeName(java.lang.String type_name) throws BrokerException
BrokerInvalidEventTypeNameException
- If the type_name is not valid.
BrokerInvalidTypeException
- If the type is not a struct or event.
BrokerNullParameterException
- If type_name is null.
BrokerException
public int getTimeToLive() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerException
public void setTimeToLive(int time_to_live) throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerOutOfRangeException
- If time_to_live is less than zero.
BrokerException
public int getStorageType() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerException
public void setStorageType(int storage_type) throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerOutOfRangeException
- If storage_type is not a valid type.
BrokerException
public int getValidationType() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerException
public void setValidationType(int validation_type) throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerOutOfRangeException
- If validation_type is not a valid type.
BrokerException
public java.lang.String getDescription() throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerException
public void setDescription(java.lang.String description) throws BrokerException
BrokerInvalidTypeException
- If the type is not an event.
BrokerNullParameterException
- If description is null.
BrokerException
public boolean isSystemDefined()
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 void setFieldType(java.lang.String field_name, short field_type, java.lang.String type_name) throws BrokerException
BrokerFieldTypeMismatchException
- If this definition is not an event, struct, or sequence.
BrokerInvalidFieldNameException
- If the field name is not valid.
BrokerInvalidTypeException
- If try to change a field's type to a sequence.
BrokerNullParameterException
- If field_name is null.
BrokerException
public BrokerAdminTypeDef 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 void setFieldDef(java.lang.String field_name, BrokerAdminTypeDef field_def) throws BrokerException
BrokerFieldTypeMismatchException
- If this definition is not an event, struct, or sequence.
BrokerInvalidFieldNameException
- If the field name is not valid.
BrokerNullParameterException
- If field_name or field_def are null.
BrokerException
public void insertFieldDef(java.lang.String field_name, int index, BrokerAdminTypeDef field_def) throws BrokerException
BrokerFieldTypeMismatchException
- If this definition is not an event, struct, or sequence.
BrokerInvalidFieldNameException
- If the field name is not valid.
BrokerInvalidTypeException
- If the field is not a struct or event.
BrokerNullParameterException
- If field_name or field_def are null.
BrokerOutOfRangeException
- If index is less than zero.
BrokerException
public void renameField(java.lang.String old_field_name, java.lang.String new_field_name) throws BrokerException
BrokerFieldNotFoundException
- If the old 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 either field name is not valid.
BrokerInvalidTypeException
- If either field name does not refer to a named field. For example, "x[]" is not a named field.
BrokerNullParameterException
- If old_field_name or new_field_name are null.
BrokerException
public void orderFields(java.lang.String field_name, java.lang.String[] new_field_names) 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.
BrokerInvalidTypeException
- If the field is not a struct or event.
BrokerNullParameterException
- If new_field_names is null, or if any entry in the array is null.
BrokerException
public void clearField(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.
BrokerInvalidTypeException
- If the type is not a struct or event.
BrokerNullParameterException
- If field_name is null.
BrokerException
public void clearFields() throws BrokerException
BrokerInvalidTypeException
- If the type is not a struct or event.
BrokerException
public boolean hasBeenModified()
public void setModificationFlag()
public void clearModificationFlag()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(int indent_level)
public java.lang.String toExtendedString()
|
webMethods Broker Administration Java API Version 9.5.1.0.171 091713 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |