ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able
Interface AbleRemoteBean

All Superinterfaces:
AbleEventListenerRemoteManager, AbleEventQueueRemoteManager, AbleRemoteEventListener, java.rmi.Remote, java.io.Serializable
All Known Subinterfaces:
AblePlatformAgent, AbleRemoteAgent, AbleRemoteDataSink, AbleRemoteDataSource, AutotuneAgentIf, JasKnnDistributedAgentIF, JasNaiveBayesDistributedAgentIF
All Known Implementing Classes:
AbleRemoteObject

public interface AbleRemoteBean
extends java.rmi.Remote, AbleRemoteEventListener, AbleEventListenerRemoteManager, AbleEventQueueRemoteManager

The AbleRemoteBean interface represents the unique behaviors required for remote AbleBeans. It extends interfaces required for event processing as well as providing specific methods for its name, state parentage, and methods which result in state changes such as init(), suspendAll() and reset().


Method Summary
 java.lang.String getName()
          Returns the name of this bean.
 int getState()
          Returns the current state of this bean.
 void init()
          Initialize and configure the bean.
 void init(java.lang.Object theArg)
          Initialize and configure the bean, using the specified Object.
 void process()
          Perform the main, synchronous, standard processing function performed by this bean.
 java.lang.Object process(java.lang.Object theArg)
          Perform the main, standard processing function performed by this bean, using the argument Object (usually passed via an AbleEvent).
 void quitAll()
          Stop all of the bean's asynchronous threads of control.
 void reset()
          Reset this bean.
 void resumeAll()
          Resume all of the bean's suspended asynchronous threads of control.
 void suspendAll()
          Temporarily suspend all of the bean's asynchronous threads of control.
 
Methods inherited from interface com.ibm.able.AbleRemoteEventListener
handleAbleEvent
 
Methods inherited from interface com.ibm.able.AbleEventListenerRemoteManager
addAbleEventListener, notifyAbleEventListeners, removeAbleEventListener
 
Methods inherited from interface com.ibm.able.AbleEventQueueRemoteManager
flushAbleEventQueue, getAbleEventProcessingEnabled, getAbleEventQueueSize, getSleepTime, isTimerEventProcessingEnabled, quitEnabledEventProcessing, restartEnabledEventProcessing, resumeEnabledEventProcessing, setAbleEventProcessingEnabled, setSleepTime, setTimerEventProcessingEnabled, startEnabledEventProcessing, suspendEnabledEventProcessing
 

Method Detail

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException
Returns the name of this bean.
Returns:
The current name of this AbleRemoteBean object or the empty string if no name has been set. The value is never expected to be null.
Throws:
java.rmi.RemoteException - If an error occurs.

getState

public int getState()
             throws java.rmi.RemoteException
Returns the current state of this bean.
Returns:
An AbleState value.
Throws:
java.rmi.RemoteException - If an error occurs.

init

public void init()
          throws java.rmi.RemoteException
Initialize and configure the bean. If needed, this method calls AbleEventQueueRemoteManager.startEnabledEventProcessing() to start a new thread for asynchronous or timer event processing. The bean's state changes to AbleState.Initiated or AbleState.Waiting.

A bean implementing AbleBeanRemoteContainer may choose to call this method on each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

init

public void init(java.lang.Object theArg)
          throws java.rmi.RemoteException
Initialize and configure the bean, using the specified Object. If needed, this method calls AbleEventQueueRemoteManager.startEnabledEventProcessing() to start a new thread for asynchronous or timer event processing. The bean's state changes to AbleState.Initiated or AbleState.Waiting.

A bean implementing AbleBeanContainer may choose to call this method on each bean it contains and accumulate errors from each contained bean.

Parameters:
theArg - An Object used to initialize the bean, typically by getting parameters of interest.
Throws:
java.rmi.RemoteException - If an error occurs.

reset

public void reset()
           throws java.rmi.RemoteException
Reset this bean. The implementation is highly bean dependant. Issues for implementors to consider are described in AbleBean.reset().

A bean implementing AbleBeanRemoteContainer should reset each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

process

public void process()
             throws java.rmi.RemoteException
Perform the main, synchronous, standard processing function performed by this bean. Typically, this function involves taking data from the input buffer, processing the data, creating an output buffer, and placing the processed data into it.

A bean implementing AbleBeanRemoteContainer may choose to call process on each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

process

public java.lang.Object process(java.lang.Object theArg)
                         throws java.rmi.RemoteException
Perform the main, standard processing function performed by this bean, using the argument Object (usually passed via an AbleEvent). Typically, this function involves taking data from the argument object, processing the data, and placing the processed data into an AbleEvent.

A bean implementing AbleBeanRemoteContainer may choose to call process on each bean it contains and accumulate errors from each contained bean.

Parameters:
theArg - An Object used to provide data for the bean derive a result.
Returns:
The results of the process() computation, usually a clone of the bean's OutputBuffer.
Throws:
java.rmi.RemoteException - If an error occurs.

quitAll

public void quitAll()
             throws java.rmi.RemoteException
Stop all of the bean's asynchronous threads of control. The bean's state changes to AbleState.Unknown.

If the bean is a simple AbleBean, this method just calls AbleEventQueueRemoteManager.quitEnabledEventProcessing(). A bean implementing AbleBeanRemoteContainer should call quitAll on each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

suspendAll

public void suspendAll()
                throws java.rmi.RemoteException
Temporarily suspend all of the bean's asynchronous threads of control. The bean's state changes to AbleState.Suspended.

If the bean is a simple AbleBean, this method just calls AbleEventQueueRemoteManager.suspendEnabledEventProcessing(). A bean implementing AbleBeanRemoteContainer should call this method on each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

resumeAll

public void resumeAll()
               throws java.rmi.RemoteException
Resume all of the bean's suspended asynchronous threads of control. The bean's state changes from AbleState.Suspended to AbleState.Waiting.

If the bean is a simple AbleBean, this method just calls AbleEventQueueRemoteManager.resumeEnabledEventProcessing(). A bean implementing AbleBeanRemoteContainer should call this method on each bean it contains and accumulate errors from each contained bean.

Throws:
java.rmi.RemoteException - If an error occurs.

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003