com.businesslink.sgi.api.sef
Interface SefHandlerControl


public interface SefHandlerControl

Defines the methods available in a handler control object for controlling the operation of an event handler.

For a handler class to obtain a reference to its handler control object, a constructor with a single SefHandlerControl argument must be implemented (note that this interface is never implemeted by any non-Strategi class). For example:

 public MySefHandler(SefHandlerControl ctlobj) {
     ...
     ctlobj.setOption("EventWaitTime","60"); // Enable a *TIMEOUT event every 60 seconds while idle
     ...
     }
 

Once a reference to the control object has been obtained, it may be stored and used as needed during the life of the event handler.


Method Summary
 boolean setOption(java.lang.String kwd, java.lang.String val)
          Sets a particular event handler option.
 

Method Detail

setOption

public boolean setOption(java.lang.String kwd,
                         java.lang.String val)
Sets a particular event handler option. Note that certain options do not take effect immediately if set during an event.

Supported option keywords:

Parameters:
kwd - keyword identifying the option to set.
val - value to set.
Returns:
true if the option was set successfully, false otherwise.