IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base
Interface ClientOperation

All Superinterfaces:
Cacheable, Operation
All Known Implementing Classes:
DSEClientOperation

public interface ClientOperation
extends Operation

The ClientOperation interface extends the Operation class. This is the interface for any operation running on the client side that has a client/server relationship with a partner server operation. Any object implementing this interface must provide: - The format that must be used to send data to the server side - The operation that must be launched on the server when sending a request - The context used on the server to link with the server operation context.


Method Summary
 FormatElement getCSRequestFormat()
          Returns the csRequestFormat formatElement of the formats Hashtable.
 java.lang.String getServerOperation()
          Returns the name of the operation to be run on the server.
 java.lang.String getServerOperationParentContext()
          Returns the name of the operation parent context on the server.
 void setCSRequestFormat(FormatElement aFormat)
          Sets the csRequestFormat formatElement of the formats Hashtable to aFormat.
 void setServerOperation(java.lang.String aServerOperation)
          Sets the name of the operation to be run on the server to aServerOperation.
 void setServerOperationParentContext(java.lang.String aContextName)
          Sets the name of the operation parent context on the server.
 
Methods inherited from interface com.ibm.dse.base.Operation
addElement, addOperationRepliedListener, chainTo, chainToContextNamed, close, execute, getApplicationId, getContext, getContextName, getElementAt, getFormat, getFormats, getKeyedCollection, getName, getParent, getService, getServiceByType, getType, getValueAt, hasServices, isChained, prune, removeAt, removeOperationRepliedListener, setApplicationId, setContext, setContextName, setKeyedCollection, setName, setType, setValueAt, unchain, xValidate
 
Methods inherited from interface com.ibm.dse.base.Cacheable
isCacheable, reinitialize
 

Method Detail

getCSRequestFormat

public FormatElement getCSRequestFormat()
Returns the csRequestFormat formatElement of the formats Hashtable. This is the format that is applied to the operation context to send the data to the server side.


getServerOperation

public java.lang.String getServerOperation()
Returns the name of the operation to be run on the server.


getServerOperationParentContext

public java.lang.String getServerOperationParentContext()
Returns the name of the operation parent context on the server.


setCSRequestFormat

public void setCSRequestFormat(FormatElement aFormat)
Sets the csRequestFormat formatElement of the formats Hashtable to aFormat. This is the format that is applied to the operation context in order to send the data to the server side.


setServerOperation

public void setServerOperation(java.lang.String aServerOperation)
Sets the name of the operation to be run on the server to aServerOperation.


setServerOperationParentContext

public void setServerOperationParentContext(java.lang.String aContextName)
Sets the name of the operation parent context on the server.


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005