webMethods Broker Administration Java API
Version 9.5.1.0.171 091713

COM.activesw.api.client
Class BrokerCompleteEventType

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

public class BrokerCompleteEventType
extends java.lang.Object

Holds all of the information describing an event type as far as import and export are concerned.


Field Summary
 BrokerEvent[] infosets
           
 boolean replace_infosets_on_store
           
 BrokerAdminTypeDef type_def
           
 
Constructor Summary
BrokerCompleteEventType()
          Constructor.
BrokerCompleteEventType(BrokerAdminTypeDef type_def)
          Constructor.
 
Method Summary
 void refresh(BrokerAdminClient client)
          Refreshes the information about the Event Type using the given client.
static BrokerCompleteEventType retrieve(BrokerAdminClient client, java.lang.String event_type_name)
          Retrieves the information about the specified Event Type with the given client.
 void store(BrokerAdminClient client)
          Stores the information from this object into the broker for which the given client object has been provided.
 java.lang.String toString()
          Converts this event type's information into a string.
 java.lang.String toString(int indent_level)
          Converts this event type's information into a string.
 void write(java.io.Writer writer, int indent_level)
          Writes this event type's information out in a textual format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

type_def

public BrokerAdminTypeDef type_def

replace_infosets_on_store

public boolean replace_infosets_on_store

infosets

public BrokerEvent[] infosets
Constructor Detail

BrokerCompleteEventType

public BrokerCompleteEventType()
Constructor.


BrokerCompleteEventType

public BrokerCompleteEventType(BrokerAdminTypeDef type_def)
Constructor. Sets the BrokerAdminTypeDef.

Method Detail

retrieve

public static BrokerCompleteEventType retrieve(BrokerAdminClient client,
                                               java.lang.String event_type_name)
                                        throws BrokerException
Retrieves the information about the specified Event Type with the given client.

Throws:
BrokerNullParameterException - If client or event_type_name is null.
BrokerInvalidClientException - If client has been destroyed or disconnected.
BrokerNoPermissionException - If the client does not have permission to read the specified information.
BrokerUnknownEventTypeException - If the event type does not exist on the broker.
BrokerException

refresh

public void refresh(BrokerAdminClient client)
             throws BrokerException
Refreshes the information about the Event Type using the given client. Requires that the 'type_def' member have a value.

Throws:
BrokerNullParameterException - If client parameter is null or the 'type_def' instance variable is null or the or the event type name in it is null.
BrokerInvalidClientException - If client has been destroyed or disconnected.
BrokerNoPermissionException - If the client does not have permission to read the specified information. When this exception is thrown, all information that can be retrieved is still retrieved. Inaccessible information is set to null.
BrokerUnknownEventTypeException - If the event type does not exist on the broker.
BrokerException

store

public void store(BrokerAdminClient client)
           throws BrokerException
Stores the information from this object into the broker for which the given client object has been provided.

If the Event Type does not exist, the Event Type is created and initialized with whatever information is set in this object.

If the Event Type does exist, then some items are overwritten and some are merged.

If the event type is system-defined, attempts to change the type definition, time-to-live, storage type, or description will generate an error.

If any exception is thrown, nothing is changed on the broker.

Throws:
BrokerNullParameterException - If client is null.
BrokerInvalidClientException - If client has been destroyed or disconnected.
BrokerNoPermissionException - If the client does not have permission to change the specified information.
BrokerException

write

public void write(java.io.Writer writer,
                  int indent_level)
           throws java.io.IOException,
                  BrokerException
Writes this event type's information out in a textual format. This is usually done to a file. The indent_level is the number of 4 character indents to use.

Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).

Does not write anything if type_def is null.

Throws:
java.io.IOException - If there is an error wrtiting to the file.
BrokerNullParameterException - If writer is null.
BrokerOutOfRangeException - If indent_level is less than 0.
BrokerException

toString

public java.lang.String toString(int indent_level)
                          throws BrokerException
Converts this event type's information into a string. The string is in proper format for saving to a file. The indent_level is the number of 4 character indents to use.

Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).

Returns an empty string if type_def is null.

Throws:
BrokerOutOfRangeException - If indent_level is less than 0.
BrokerException

toString

public java.lang.String toString()
Converts this event type's information into a string. The string is in proper format for saving to a file.

Unicode characters in the output are escaped using backslash-u notiation (e.g. ?).

Returns an empty string if type_def is null.

Overrides:
toString in class java.lang.Object

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.