com.ibm.dse.automaton.html
Interface ProcessorOperation

All Known Implementing Classes:
DSEHtmlProcessorOperation

public interface ProcessorOperation

This interface provides an abstract definition of a processor operation. A processor operation is basically a manager for processor objects.


Method Summary
 void close()
          Close this processor operation, performing housekeeping tasks.
 void closeProcessor(Processor processor)
          Closes the current processor object being managed by the processor operation
 void execute(java.lang.String eventName)
          Provides the entry point for execution of the processor object currently being managed by this processor operation.
 Processor getProcessor()
          Returns the processor object currently being managed by this processor operation
 java.lang.String getResponseId()
          Returns an appropriate response id in response to execution of the processor object currently being managed.
 java.lang.String getStatus()
          Returns the status of the processor operation.
 void initializeProcessor(KeyedCollection coll)
          This method is called to initialize a processor object based on data passed in the keyed collection.
 void setProcessor(Processor processor)
          Sets the processor object currently being managed by this processor operation
 void setResponseId(java.lang.String id)
          Sets an appropriate response id corresponding to the execution of the currently managed processor.
 void setStatus(java.lang.String newStatus)
          Sets the status of the processor operation.
 boolean updateContext(KeyedCollection collection)
          Updates the context of the processor object currently being managed by this processor operation, from the data supplied in the keyed collection.
 

Method Detail

close

public void close()
           throws DSEInvalidRequestException,
                  DSEObjectNotFoundException
Close this processor operation, performing housekeeping tasks.
Throws:
DSEInvalidRequestException -  
com.ibm.dse.base.DSEDSEObjectNotFoundException -  

closeProcessor

public void closeProcessor(Processor processor)
Closes the current processor object being managed by the processor operation
Parameters:
processor - com.ibm.dse.automaton.Processor

execute

public void execute(java.lang.String eventName)
             throws DSEException,
                    DSEInvalidArgumentException
Provides the entry point for execution of the processor object currently being managed by this processor operation. The supplied event name is used as input, for execution of the processor state machine.
Parameters:
eventName - java.lang.String
Throws:
DSEException -  
DSEInvalidArgumentException -  

getProcessor

public Processor getProcessor()
Returns the processor object currently being managed by this processor operation
Returns:
com.ibm.dse.automaton.Processor

getResponseId

public java.lang.String getResponseId()
                               throws DSEException
Returns an appropriate response id in response to execution of the processor object currently being managed.
Returns:
java.lang.String
Throws:
DSEException -  

getStatus

public java.lang.String getStatus()
Returns the status of the processor operation.
Returns:
java.lang.String

initializeProcessor

public void initializeProcessor(KeyedCollection coll)
                         throws DSEException
This method is called to initialize a processor object based on data passed in the keyed collection. The processor object initialized should be set as the current processor being managed by the processor operation.
Parameters:
coll - com.ibm.dse.base.KeyedCollection
Throws:
DSEException -  

setProcessor

public void setProcessor(Processor processor)
Sets the processor object currently being managed by this processor operation
Parameters:
processor - com.ibm.dse.automaton.Processor

setResponseId

public void setResponseId(java.lang.String id)
                   throws DSEInvalidArgumentException,
                          DSEObjectNotFoundException
Sets an appropriate response id corresponding to the execution of the currently managed processor.
Parameters:
id - java.lang.String
Throws:
DSEInvalidArgumentException -  
DSEObjectNotFoundException -  

setStatus

public void setStatus(java.lang.String newStatus)
Sets the status of the processor operation.
Parameters:
newStatus - java.lang.String

updateContext

public boolean updateContext(KeyedCollection collection)
                      throws DSEObjectNotFoundException,
                             DSEException
Updates the context of the processor object currently being managed by this processor operation, from the data supplied in the keyed collection.
Parameters:
collection - com.ibm.dse.base.KeyedCollection
Returns:
boolean
Throws:
DSEObjectNotFoundException -  
DSEException -