Overview  Package   Class  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

sajas.proto
Interface SubscriptionResponder.SubscriptionManager
Enclosing class:
SubscriptionResponder

public static interface SubscriptionResponder.SubscriptionManager
Inner interface SubscriptionManager.

A SubscriptionResponder, besides enforcing and controlling the sequence of messages in a subscription conversation, also stores current subscriptions into an internal table. In many cases however it is desirable to manage Subscription objects in an application specific way (e.g. storing them to a persistent support such as a DB). To enable that, it is possible to pass a SubscriptionManager implementation to the SubscriptionResponder. The SubscriptionManager is notified about subscription and cancellation events by means of the register() and deregister() methods.


Method Summary
boolean
deregister(SubscriptionResponder.Subscription s)
          Deregister a Subscription object
boolean
register(SubscriptionResponder.Subscription s)
          Register a new Subscription object
Method Detail
register
boolean register(SubscriptionResponder.Subscription s)
          throws jade.domain.FIPAAgentManagement.RefuseException,
                 jade.domain.FIPAAgentManagement.NotUnderstoodException
Register a new Subscription object
Parameters:
s - The Subscription object to be registered
Returns:
The boolean value returned by this method provides an indication to the SubscriptionResponder about whether or not an AGREE message should be sent back to the initiator. The default implementation of the handleSubscription() method of the SubscriptionResponder ignores this indication, but programmers can override it.
Throws:
jade.domain.FIPAAgentManagement.RefuseException
jade.domain.FIPAAgentManagement.NotUnderstoodException

deregister
boolean deregister(SubscriptionResponder.Subscription s)
            throws jade.domain.FIPAAgentManagement.FailureException
Deregister a Subscription object
Returns:
The boolean value returned by this method provides an indication to the SubscriptionResponder about whether or not an INFORM message should be sent back to the initiator. The default implementation of the handleCancel() method of the SubscriptionResponder ignores this indication, but programmers can override it.
Throws:
jade.domain.FIPAAgentManagement.FailureException

Overview  Package   Class  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Java API documentation generated with DocFlex/Doclet 1.6.1 using JavadocPro template set.
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc, which is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com