NAME

       CosNotifyChannelAdmin_EventChannel  - This module implements the OMG  CosNotifyChannelAdmin::EventChannel
       interface.

DESCRIPTION

       To get access to the record definitions for the structures use:
       -include_lib("cosNotification/include/*.hrl").

       This module also exports the functions described in:

         * CosNotification_QoSAdmin

         * CosNotification_AdminPropertiesAdmin

EXPORTS

       _get_MyFactory(Channel) -> ChannelFactory

              Types:

                 Channel = #objref
                 ChannelFactory = #objref

              This readonly attribute maintains the reference of the event  channel  factory  that  created  the
              target channel.

       _get_default_consumer_admin(Channel) -> ConsumerAdmin

              Types:

                 Channel = #objref
                 ConsumerAdmin = #objref

              This  is  a  readonly  attribute  which  maintains  a  reference to a default ConsumerAdmin object
              associated with the target object.

       _get_default_supplier_admin(Channel) -> SupplierAdmin

              Types:

                 Channel = #objref
                 SupplierAdmin = #objref

              This is a readonly attribute which  maintains  a  reference  to  a  default  SupplierAdmin  object
              associated with the target object.

       _get_default_filter_factory(Channel) -> FilterFactory

              Types:

                 Channel = #objref
                 FilterFactory = #objref

              The  default  FilterFactory  associated  with  the  target  channel is maintained by this readonly
              attribute.

       new_for_consumers(Channel, OpType) -> Return

              Types:

                 Channel = #objref
                 OpType = 'AND_OP' | 'OR_OP'
                 Return = {ConsumerAdmin, AdminID}
                 ConsumerAdmin = #objref
                 AdminID = long()

              This operation creates a new instance of a ConsumerAdmin and supplies an Id which may be used when
              invoking other operations exported by this module. The returned object will inherit the Quality of
              Service properties of the target channel.

       for_consumers(Channel) -> ConsumerAdmin

              Types:

                 Channel = #objref
                 ConsumerAdmin = #objref

              A new new instance of a ConsumerAdmin object is created  but  no  Id  is  returned.  The  returned
              object's  operation type, i.e., 'AND_OP' or 'OR_OP', will be set to the value of the configuration
              parameter filterOp. The target object's Quality of Service properties will  be  inherited  by  the
              returned ConsumerAdmin.

       new_for_suppliers(Channel, OpType) -> Return

              Types:

                 Channel = #objref
                 OpType = 'AND_OP' | 'OR_OP'
                 Return = {SupplierAdmin, AdminID}
                 SupplierAdmin = #objref
                 AdminID = long()

              Enables  us  to  create  a new instance of a SupplierAdmin. An Id, which may be used when invoking
              other operations exported by this module,  is  also  returned.  The  current  Quality  of  Service
              settings associated with the target object will be inherited by the SupplierAdmin.

       for_suppliers(Channel) -> SupplierAdmin

              Types:

                 Channel = #objref
                 SupplierAdmin = #objref

              To  create a new SupplierAdmin with the target object's current Quality of Service settings we can
              use this function. The returned object's operation type ('AND_OP' or 'OR_OP') will  be  determined
              by the configuration variable filterOp.

       get_consumeradmin(Channel, AdminID) -> ConsumerAdmin

              Types:

                 Channel = #objref
                 AdminID = long()
                 ConsumerAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAdmin_AdminNotFound'{}}

              If  the  given  Id  is  associated  with a ConsumerAdmin the object reference is returned. If such
              association never existed or the ConsumerAdmin have terminated an exception is raised.

       get_supplieradmin(Channel, AdminID) -> SupplierAdmin

              Types:

                 Channel = #objref
                 AdminID = long()
                 SupplierAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAdmin_AdminNotFound'{}}

              Equal to the operation get_consumeradmin/2 but a reference to a SupplierAdmin is returned.

       get_all_consumeradmins(Channel) -> Reply

              Types:

                 Channel = #objref
                 Reply = [AdminID]
                 AdminID = long()

              To get access to all ConsumerAdmin Id's created by  the  target  object,  and  still  alive,  this
              operation could be invoked.

       get_all_supplieradmins(Channel) -> Reply

              Types:

                 Channel = #objref
                 Reply = [AdminID]
                 AdminID = long()

              Equal  to  the  operation  get_all_consumeradmins/1 but returns a list of all SupplierAdmin object
              ID's.

       destroy(Channel) -> ok

              Types:

                 Channel = #objref

              The destroy operation will terminate the target channel and all associated Admin objects.

Ericsson AB                                   cosNotification 1.2.1     CosNotifyChannelAdmin_EventChannel(3erl)