IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Interface OperationStepInterface

All Known Implementing Classes:
AbstractPolicyOperationStep, CompareAssertion, ExistsAssertion, NumOfElementsAssertion, OperationStep, PolicyOperationStep

public interface OperationStepInterface

BTTOperationStepInterface 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 service named aServiceName.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of the data element identified by aConpositeKey.
 void postExecute(java.lang.Object object)
          execute the method after excuting this opstep
 java.lang.Object preExecute()
          execute this method before excuting this opstep
 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 setContext(Context aContext)
          Sets the operation context to aContext.
 void setKeyedCollection(KeyedCollection kColl)
          Sets the operation KeyedCollection
 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

execute

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

Returns:
int
Throws:
java.lang.Exception

getContext

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.btt.base.Context

getFormat

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

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

getOperation

Operation getOperation()
Returns the operation attribute of operationStep.

Returns:
com.ibm.btt.base.Operation

getParams

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

Returns:
com.ibm.btt.base.KeyedCollection

getValueAt

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

setOperation

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

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

setParams

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

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

setValueAt

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

setContext

void setContext(Context aContext)
Sets the operation context to aContext.

Parameters:
aContext - com.ibm.btt.base.Context
Since:
5.2

getService

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

Parameters:
aServiceName - The name of the service.
Returns:
com.ibm.btt.base.Service
Throws:
DSEObjectNotFoundException

getFormats

Hashtable getFormats()
Returns the operation formats Hashtable.

Returns:
com.ibm.btt.base.Hashtable

getParent

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

Throws:
DSEInvalidRequestException

getApplicationId

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


setApplicationId

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

Parameters:
name - java.lang.String

getName

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


setName

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

Parameters:
name - java.lang.String
Throws:
DSEInvalidArgumentException

addElement

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.btt.base.DataElement
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEInvalidRequestException

removeAt

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

getKeyedCollection

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

Returns:
com.ibm.btt.base.KeyedCollecion
Throws:
DSEInvalidRequestException

setKeyedCollection

void setKeyedCollection(KeyedCollection kColl)
                        throws DSEInvalidRequestException
Sets the operation KeyedCollection

Throws:
DSEInvalidRequestException

preExecute

java.lang.Object preExecute()
execute this method before excuting this opstep


postExecute

void postExecute(java.lang.Object object)
execute the method after excuting this opstep

Parameters:
object -

getElementAt

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.

Parameters:
aFormatName - java.lang.String
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEObjectNotFoundException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010