IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base
Class DSEClientOperation

java.lang.Object
  extended bycom.ibm.dse.base.DSEOperation
      extended bycom.ibm.dse.base.DSEClientOperation
All Implemented Interfaces:
Cacheable, ClientOperation, Externalizable, java.io.Externalizable, Operation, java.io.Serializable
Direct Known Subclasses:
EventManagerClientOperation

public abstract class DSEClientOperation
extends DSEOperation
implements ClientOperation

The DSEClientOperation Class derives from DSEOperation and implements the interface ClientOperation. This is an abstract class and it cannot be instantiated. A DSEClientOperation has two attributes : - a A serverOperation: contains the name of the operation that is executed on the server workstation through the client/server mechanism. - a A serverOperationParentContext: contains the name of the parent context of the operation that is executed on the server workstation through the client/server mechanism.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.dse.base.DSEOperation
aOperationRepliedListener, externalizer
 
Constructor Summary
DSEClientOperation()
          This constructor creates the DSEClientOperation object.
DSEClientOperation(java.lang.String anOperationName)
          This constructor creates a new instance of ClientOperation with its corresponding Context (obtained from the definition files through anOperationName).
DSEClientOperation(java.lang.String anOperationName, Context aParentContext)
          This constructor creates a new instance of ClientOperation (obtained from the definition files through anOperationName) chained to aParentContext.
DSEClientOperation(java.lang.String anOperationName, java.lang.String aParentContext)
          This constructor creates a new instance of ClientOperation (obtained from the definition files through anOperationName) chained to the Context Named aParentContextName.
 
Method Summary
 void execute()
          The execute method contains the operation logic.
 FormatElement getCSReplyFormat()
          Returns the csReplyFormat formatElement of the formats Hashtable.
 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 in the server.
 java.lang.Object initializeFrom(Tag aTag)
          Returns the clientOperation implemented by the Tag aTag This method throws an IOException if the externalizer hasn't been initialized.
 void setCSReplyFormat(FormatElement aFormat)
          Sets the csReplyFormat formatElement of the formats Hashtable to aFormat.
 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 context on the server.
 Vector toStrings()
          Returns a visual representation of the clientOperation.
 
Methods inherited from class com.ibm.dse.base.DSEOperation
addElement, addOperationRepliedListener, chainTo, chainToContextNamed, chainToCurrentContext, clearKeyedCollection, close, externalizer, fireHandleOperationRepliedEvent, getApplicationId, getContext, getContextByType, getContextName, getContextNamed, getElementAt, getExternalizer, getFormat, getFormats, getHostReceiveFormat, getHostSendFormat, getInstanceOfOperationStep, getKeyedCollection, getMinOperationConsumeTimeForTrace, getName, getOperationStep, getOperationStepRC, getOperationSteps, getParent, getSelfDefinedOpTagInputStream, getService, getServiceByType, getSessionId, getSgmlSelfDefinedOpFileName, getTraceOperationConsumeTime, getType, getValueAt, getXValidator, hasServices, initializeFormatFrom, initializeKeyedCollectionValueFrom, initializeOpStep, initializeOpStepsFrom, isCacheable, isChained, isContext, occurrencesNamed, prune, readExternal, readExternal, readObject, reinitialize, removeAt, removeExternal, removeOperationRepliedListener, setApplicationId, setContext, setContextName, setExternalizer, setHostReceiveFormat, setHostSendFormat, setKeyedCollection, setMinOperationConsumeTimeForTrace, setName, setSessionId, setTraceOperationConsumeTime, setType, setValueAt, setXValidator, toString, toTags, unchain, writeExternal, writeExternal, xValidate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.dse.base.Operation
addElement, addOperationRepliedListener, chainTo, chainToContextNamed, close, 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
 

Constructor Detail

DSEClientOperation

public DSEClientOperation()
This constructor creates the DSEClientOperation object.


DSEClientOperation

public DSEClientOperation(java.lang.String anOperationName)
                   throws java.io.IOException
This constructor creates a new instance of ClientOperation with its corresponding Context (obtained from the definition files through anOperationName).


DSEClientOperation

public DSEClientOperation(java.lang.String anOperationName,
                          Context aParentContext)
                   throws java.io.IOException,
                          DSEInvalidRequestException
This constructor creates a new instance of ClientOperation (obtained from the definition files through anOperationName) chained to aParentContext.


DSEClientOperation

public DSEClientOperation(java.lang.String anOperationName,
                          java.lang.String aParentContext)
                   throws java.io.IOException,
                          DSEInvalidRequestException,
                          DSEObjectNotFoundException
This constructor creates a new instance of ClientOperation (obtained from the definition files through anOperationName) chained to the Context Named aParentContextName.

Method Detail

execute

public void execute()
             throws java.lang.Exception
The execute method contains the operation logic. It should be implemented by subclasses.

Specified by:
execute in interface Operation
Overrides:
execute in class DSEOperation
Throws:
java.lang.Exception

getCSReplyFormat

public FormatElement getCSReplyFormat()
Returns the csReplyFormat formatElement of the formats Hashtable.


getCSRequestFormat

public FormatElement getCSRequestFormat()
Returns the csRequestFormat formatElement of the formats Hashtable.

Specified by:
getCSRequestFormat in interface ClientOperation

getServerOperation

public java.lang.String getServerOperation()
Returns the name of the operation to be run on the server. If it is not initialized, it defaults to its self name, removes ClientOp and adds ServerOp instead.

Specified by:
getServerOperation in interface ClientOperation

getServerOperationParentContext

public java.lang.String getServerOperationParentContext()
Returns the name of the operation parent context in the server. If it is not initialized, the client/server mechanism chains the operation on the server to the context for the current session.

Specified by:
getServerOperationParentContext in interface ClientOperation

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Returns the clientOperation implemented by the Tag aTag This method throws an IOException if the externalizer hasn't been initialized.

Specified by:
initializeFrom in interface Externalizable
Overrides:
initializeFrom in class DSEOperation
Parameters:
aTag - com.ibm.dse.base.Tag - An operation Tag
Returns:
java.lang.Object
Throws:
java.io.IOException
DSEException

setCSReplyFormat

public void setCSReplyFormat(FormatElement aFormat)
Sets the csReplyFormat formatElement of the formats Hashtable to aFormat.


setCSRequestFormat

public void setCSRequestFormat(FormatElement aFormat)
Sets the csRequestFormat formatElement of the formats Hashtable to aFormat.

Specified by:
setCSRequestFormat in interface ClientOperation

setServerOperation

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

Specified by:
setServerOperation in interface ClientOperation

setServerOperationParentContext

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

Specified by:
setServerOperationParentContext in interface ClientOperation

toStrings

public Vector toStrings()
Returns a visual representation of the clientOperation.

Specified by:
toStrings in interface Externalizable
Overrides:
toStrings in class DSEOperation

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005