ParameterNoticeBoard
Class ParameterSubscriber

java.lang.Object
  extended by ParameterNoticeBoard.ParameterSubscriber

 class ParameterSubscriber
extends java.lang.Object

A entity class which holds the details of the subscribers to the items in the parameter noticeboard.

Version:
$Id: ParameterSubscriber.java,v 1.2 2008/05/21 11:16:23 cb Exp $
Author:
Craige Bevil

Field Summary
 java.lang.String ClientID
          This is an identifier which allows the parameter noticeboard to perform management on the listeners.
 iParameterNoticeBoard.ParameterNoticeBoardListener Listener
          This is a CORBA object which will receive updates when there are events on the associated parameter.
 
Constructor Summary
ParameterSubscriber(iParameterNoticeBoard.ParameterNoticeBoardListener Listener, java.lang.String ClientID)
          Constructor
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Listener

public iParameterNoticeBoard.ParameterNoticeBoardListener Listener
This is a CORBA object which will receive updates when there are events on the associated parameter.


ClientID

public java.lang.String ClientID
This is an identifier which allows the parameter noticeboard to perform management on the listeners. For example, a client may instruct the parameter noticeboard to cancel all subscriptions associated with a specific client id.

Constructor Detail

ParameterSubscriber

ParameterSubscriber(iParameterNoticeBoard.ParameterNoticeBoardListener Listener,
                    java.lang.String ClientID)
Constructor

Parameters:
Listener - This a reference to a remote CORBA object which will be informed when the value in the parameter noticeboard which it is listening to changes.
ClientID - This is a optional Client ID which identifies the client.