VisiBroker for Java

org.omg.CosNotifyChannelAdmin
Interface EventChannelOperations

All Superinterfaces:
AdminPropertiesAdminOperations, EventChannelOperations, QoSAdminOperations
All Known Subinterfaces:
EventChannel, NotifyLog, NotifyLogOperations

public interface EventChannelOperations
extends QoSAdminOperations, AdminPropertiesAdminOperations, EventChannelOperations


Method Summary
 ConsumerAdmin default_consumer_admin()
          The default_consumer_admin attribute is a readonly attribute that maintains a reference to the default ConsumerAdmin instance associated with the target EventChannel instance.
 FilterFactory default_filter_factory()
          The default_filter_factory attribute is a readonly attribute that maintains an object reference to the default factory to be used by the EventChannel instance with which it?s associated for creating filter objects.
 SupplierAdmin default_supplier_admin()
          The default_supplier_admin attribute is a readonly attribute that maintains a reference to the default SupplierAdmin instance associated with the target EventChannel instance.
 int[] get_all_consumeradmins()
          The get_all_consumeradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style ConsumerAdmin instances, which have been created by the target EventChannel instance.
 int[] get_all_supplieradmins()
          The get_all_supplieradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style SupplierAdmin instances, which have been created by the target EventChannel instance.
 ConsumerAdmin get_consumeradmin(int id)
           
 SupplierAdmin get_supplieradmin(int id)
           
 EventChannelFactory MyFactory()
          The MyFactory attribute is a readonly attribute that maintains the object reference of the event channel factory, which created a given Notification Service EventChannel instance.
 ConsumerAdmin new_for_consumers(InterFilterGroupOperator op, IntHolder id)
          The new_for_consumers operation is invoked to create a new Notification Service style ConsumerAdmin instance.
 SupplierAdmin new_for_suppliers(InterFilterGroupOperator op, IntHolder id)
          The new_for_suppliers operation is invoked to create a new Notification Service style SupplierAdmin instance.
 
Methods inherited from interface org.omg.CosNotification.QoSAdminOperations
get_qos, set_qos, validate_qos
 
Methods inherited from interface org.omg.CosNotification.AdminPropertiesAdminOperations
get_admin, set_admin
 
Methods inherited from interface org.omg.CosEventChannelAdmin.EventChannelOperations
destroy, for_consumers, for_suppliers
 

Method Detail

get_all_supplieradmins

int[] get_all_supplieradmins()
The get_all_supplieradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style SupplierAdmin instances, which have been created by the target EventChannel instance.

Returns:
A sequence of the unique identifiers assigned to all Notification Service style SupplierAdmin instances, which have been created by the target EventChannel instance so far.

get_all_consumeradmins

int[] get_all_consumeradmins()
The get_all_consumeradmins operation takes no input parameters and returns a sequence of the unique identifiers assigned to all Notification Service style ConsumerAdmin instances, which have been created by the target EventChannel instance.

Returns:
A sequence of all unique identifiers assigned to all Notification Service style ConsumerAdmin instances, which have been created by the target EventChannel instance so far.

get_supplieradmin

SupplierAdmin get_supplieradmin(int id)
                                throws AdminNotFound
Parameters:
id - A numeric value, which is intended to be the unique identifier of one of the SupplierAdmin instances associated with the target EventChannel instance.
Returns:
A reference to one of the SupplierAdmin instances associated with the target EventChannel instance.
Throws:
AdminNotFound - If the passed id does not turn to be the unique identifier associated with any target EventChannel instance. Note that while a Notification Service style event channel can support both Event Service and Notification Service style SupplierAdmin instances, only Notification Service style SupplierAdmin instances have associated unique identifiers.

get_consumeradmin

ConsumerAdmin get_consumeradmin(int id)
                                throws AdminNotFound
Parameters:
id - A numeric value, which is intended to be the unique identifier of one of the ConsumerAdmin instances associated with the target EventChannel instance.
Returns:
A reference to one of the ConsumerAdmin instances associated with the target EventChannel instance.
Throws:
AdminNotFound - If the passed id does not turn to be the unique identifier associated with any target EventChannel instance. Note that while a Notification Service style event channel can support both Event Service and Notification Service style ConsumerAdmin instances, only Notification Service style ConsumerAdmin instances have associated unique identifiers.

new_for_suppliers

SupplierAdmin new_for_suppliers(InterFilterGroupOperator op,
                                IntHolder id)
The new_for_suppliers operation is invoked to create a new Notification Service style SupplierAdmin instance.

Parameters:
op - A boolean flag, which indicates whether AND or OR semantics will be used when combining the filter objects associated with the newly created SupplierAdmin instance with those associated with a consumer proxy, which was created by the SupplierAdmin during the evaluation of each event against a set of filter objects.
id - An output parameter containing a numeric identifier corresponding to the newly created SupplierAdmin instance. This identifier is unique among all SupplierAdmin instances currently associated with the channel.
Returns:
The reference to the new SupplierAdmin instance.

new_for_consumers

ConsumerAdmin new_for_consumers(InterFilterGroupOperator op,
                                IntHolder id)
The new_for_consumers operation is invoked to create a new Notification Service style ConsumerAdmin instance.

Parameters:
op - A boolean flag, which indicates whether AND or OR semantics will be used when combining the filter objects associated with the newly created ConsumerAdmin instance with those associated with a supplier proxy, which was created by the ConsumerAdmin during the evaluation of each event against a set of filter objects.
id - An output parameter containing a numeric identifier corresponding to the newly created instance. This identifier is unique among all ConsumerAdmin instances currently associated with the channel.
Returns:
The reference to the new ConsumerAdmin instance.

default_filter_factory

FilterFactory default_filter_factory()
The default_filter_factory attribute is a readonly attribute that maintains an object reference to the default factory to be used by the EventChannel instance with which it?s associated for creating filter objects. If the target channel does not support a default filter factory, the attribute will maintain the value of OBJECT_NIL.


default_supplier_admin

SupplierAdmin default_supplier_admin()
The default_supplier_admin attribute is a readonly attribute that maintains a reference to the default SupplierAdmin instance associated with the target EventChannel instance. Each EventChannel instance has an associated default SupplierAdmin instance, which exists upon creation of the channel and is assigned the unique identifier of zero. Subsequently, clients can create additional Event Service style SupplierAdmin instances by invoking the inherited for_suppliers operation, and additional Notification Service style SupplierAdmin instances by invoking the new_for_suppliers operation defined by the EventChannel interface.


default_consumer_admin

ConsumerAdmin default_consumer_admin()
The default_consumer_admin attribute is a readonly attribute that maintains a reference to the default ConsumerAdmin instance associated with the target EventChannel instance. Each EventChannel instance has an associated default ConsumerAdmin instance, which exists upon creation of the channel and is assigned the unique identifier of zero. Subsequently, clients can create additional Event Service style ConsumerAdmin instances by invoking the inherited for_consumers operation, and additional Notification Service style ConsumerAdmin instances by invoking the new_for_consumers operation defined by the EventChannel interface.


MyFactory

EventChannelFactory MyFactory()
The MyFactory attribute is a readonly attribute that maintains the object reference of the event channel factory, which created a given Notification Service EventChannel instance.


Borland Software Corporation
http://www.borland.com
100 Enterprise Way
Scotts Valley, CA 95066
Voice: (831) 431-1000
pubsweb@borland.com

Read the latest documentation online