hypercast
Interface FiniteStateMachineMetaOperations


public interface FiniteStateMachineMetaOperations

This interface defines the operations that take place based on finite machine type, not finite machines instances. Such operations are needed in the MessageStore because there are various places where decisions must be made regarding a message depending on the finite state machine type. In order to implement these operations follow this convention: (1) In the file that implements your finite state machine create a second (non-inner) class that implements this interface, we'll refer to this as "FiniteStateMachineMetaOperationsChild" for the purposes of this example. (2) Provide appropriate code for each method. (3) Add a static variable to your finite state machine class of type "FiniteStateMachineMetaOperations." (4) Create a public static method in your finite state machine class that returns the singleton instance of "FiniteStateMachineMetaOperationsChild" initializing it if necessary. (5) In MessageStore.java add a line of code that registers the new MetaOperations object with the meta operations table.


Method Summary
 boolean isValidMessage(hypercast.OL_Message message)
          This method ensures that the settings of the message, e.g.
 boolean messageStoreWillForwardMessage(hypercast.OL_Message message)
          This method returns true if the message store will be solely responsible for forwarding this message.
 hypercast.events.NOTIFICATION_EVENT notifyOnSend(hypercast.OL_Message message)
          Returns a notification event that should be raised at message send time.
 boolean processIntermediateUnicastMessage(hypercast.OL_Message message)
          This method returns true if the message store will process the intermediate unicast message.
 

Method Detail

messageStoreWillForwardMessage

public boolean messageStoreWillForwardMessage(hypercast.OL_Message message)
This method returns true if the message store will be solely responsible for forwarding this message. If the forwarding engine should forward this message, this method returns false.


isValidMessage

public boolean isValidMessage(hypercast.OL_Message message)
This method ensures that the settings of the message, e.g. delivery method, is valid for the given service number.


processIntermediateUnicastMessage

public boolean processIntermediateUnicastMessage(hypercast.OL_Message message)
This method returns true if the message store will process the intermediate unicast message.


notifyOnSend

public hypercast.events.NOTIFICATION_EVENT notifyOnSend(hypercast.OL_Message message)
Returns a notification event that should be raised at message send time. If no notification should be raised, this method returns null.