IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base
Interface OperationStepInterface

All Known Implementing Classes:
OperationStep

public interface OperationStepInterface

OperationStepInterface interface. This is the generic interface for any operation step.


Method Summary
 DataElement addElement(DataElement aDataElement)
          Adds the element aDataElement to the keyed collection of the operation.
 int execute()
          This is an abstract method.
 java.lang.String getApplicationId()
          Returns the operation applicationId.
 Context getContext()
          Returns the operation context.
 DataElement getElementAt(java.lang.String aCompositeKey)
          Returns the DataElement identified by aCompositeKey.
 java.lang.Object getFormat(java.lang.String aFormatName)
          Returns the operation format named FormatName.
 Hashtable getFormats()
          Returns the operation formats Hashtable.
 KeyedCollection getKeyedCollection()
          Returns the context keyedCollection.
 java.lang.String getName()
          Returns the operation step name.
 Operation getOperation()
          Returns the operation attribute of operationStep.
 KeyedCollection getParams()
          Returns the parameters of the operation step.
 Context getParent()
          Returns the Context object defined as the parent context of the operation context.
 Service getService(java.lang.String aServiceName)
          Returns the operation service named aServiceName.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of the data element identified by aConpositeKey.
 DataElement removeAt(java.lang.String aCompositeKey)
          Removes the data element identified by aCompositeKey from the context data collection.
 void setApplicationId(java.lang.String appId)
          Sets the operation application id to applicationId.
 void setName(java.lang.String name)
          Sets the operation step name to name.
 void setOperation(Operation anOperation)
          Sets the operation attribute of operationStep.
 void setParams(KeyedCollection kc)
          Sets the parameters of the operation step.
 void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue)
          Sets the value of the data identified by aCompositeKey to aDataValue.
 

Method Detail

addElement

public DataElement addElement(DataElement aDataElement)
                       throws DSEInvalidRequestException
Adds the element aDataElement to the keyed collection of the operation. Refer to the Context class addElement method for an example of implementing this method.

Parameters:
aDataElement - com.ibm.dse.base.DataElement
Returns:
com.ibm.dse.base.DataElement
Throws:
DSEInvalidRequestException

execute

public int execute()
            throws java.lang.Exception
This is an abstract method.

Returns:
int
Throws:
java.lang.Exception

getApplicationId

public java.lang.String getApplicationId()
Returns the operation applicationId.


getContext

public Context getContext()
Returns the operation context. The value defaults to the name of the operation removing ClientOp/ServerOp and adding ClientOc/ServerOc.

Returns:
com.ibm.dse.base.Context

getElementAt

public DataElement getElementAt(java.lang.String aCompositeKey)
                         throws DSEObjectNotFoundException
Returns the DataElement identified by aCompositeKey. Refer to the same method in KeyedCollection class for an example of implementing this method.

Returns:
com.ibm.dse.base.DataElement
Throws:
DSEObjectNotFoundException

getFormat

public java.lang.Object getFormat(java.lang.String aFormatName)
Returns the operation format named FormatName.

Parameters:
aFormatName - java.lang.String
Returns:
java.lang.Object

getFormats

public Hashtable getFormats()
Returns the operation formats Hashtable.

Returns:
com.ibm.dse.base.Hashtable

getKeyedCollection

public KeyedCollection getKeyedCollection()
Returns the context keyedCollection. Refer to the Context class getKeyedCollection method for an example of implementing this method.

Returns:
com.ibm.dse.base.KeyedCollecion

getName

public java.lang.String getName()
Returns the operation step name.


getOperation

public Operation getOperation()
Returns the operation attribute of operationStep.

Returns:
com.ibm.dse.base.Operation

getParams

public KeyedCollection getParams()
Returns the parameters of the operation step.

Returns:
com.ibm.dse.base.KeyedCollection

getParent

public Context getParent()
Returns the Context object defined as the parent context of the operation context.


getService

public Service getService(java.lang.String aServiceName)
                   throws DSEObjectNotFoundException
Returns the operation service named aServiceName.

Parameters:
aServiceName - java.lang.String
Returns:
com.ibm.dse.base.Service
Throws:
DSEObjectNotFoundException

getValueAt

public java.lang.Object getValueAt(java.lang.String aCompositeKey)
                            throws DSEObjectNotFoundException
Returns the value of the data element identified by aConpositeKey. Refer to the same method of the KeyedCollection class for an example of implementing this method. This method throws a "DSEObjectNotFoundException" if the data element is not found.

Parameters:
aCompositeKey - java.lang.String
Returns:
java.lang.Object
Throws:
DSEObjectNotFoundException

removeAt

public DataElement removeAt(java.lang.String aCompositeKey)
                     throws DSEInvalidRequestException,
                            DSEObjectNotFoundException
Removes the data element identified by aCompositeKey from the context data collection. Refer to the Context class removeAt method for an example of implementing this method. This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException.

Parameters:
aCompositeKey - java.lang.String
Returns:
com.ibm.ds.ebase.DataElement
Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

setApplicationId

public void setApplicationId(java.lang.String appId)
Sets the operation application id to applicationId.


setName

public void setName(java.lang.String name)
Sets the operation step name to name.

Parameters:
name - java.lang.String

setOperation

public void setOperation(Operation anOperation)
Sets the operation attribute of operationStep.

Parameters:
anOperation - com.ibm.dse.base.Operation

setParams

public void setParams(KeyedCollection kc)
Sets the parameters of the operation step.

Parameters:
kc - com.ibm.dse.base.KeyedCollection

setValueAt

public void setValueAt(java.lang.String aCompositeKey,
                       java.lang.Object aDataValue)
                throws DSEObjectNotFoundException,
                       DSEInvalidArgumentException
Sets the value of the data identified by aCompositeKey to aDataValue. This method throws a DSEInvalidRequestException if the data type doesn't allow a setValue(). It throws a DSEObjectNotFoundException if the data is not found.

Parameters:
aCompositeKey - java.lang.String
aDataValue - java.lang.Object
Throws:
DSEObjectNotFoundException
DSEInvalidArgumentException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005