|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.base.OperationStep
This class enables you to break an operation into a set of operation steps. This provides an opportunity to reuse code when performing the same specific tasks within different operations. This class accepts the main Operation protocol so that pieces of code can be moved from the main operation flow to a specific operation step and the other way around without changing the code. Customized operation steps can be defined as children of this class for multiple purposes.
Field Summary | |
---|---|
KeyedCollection |
params
The operation step parameters. |
static int |
RC_ERROR
|
static int |
RC_OK
|
Constructor Summary | |
---|---|
OperationStep()
|
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds the element aDataElement to the keyed collection of the operation. |
abstract 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 aName)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int RC_OK
public static final int RC_ERROR
public KeyedCollection params
Constructor Detail |
public OperationStep()
Method Detail |
public DataElement addElement(DataElement aDataElement) throws DSEInvalidRequestException
addElement
in interface OperationStepInterface
aDataElement
- com.ibm.dse.base.DataElement
DSEInvalidRequestException
public abstract int execute() throws java.lang.Exception
execute
in interface OperationStepInterface
java.lang.Exception
public java.lang.String getApplicationId()
getApplicationId
in interface OperationStepInterface
public Context getContext()
getContext
in interface OperationStepInterface
public DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
getElementAt
in interface OperationStepInterface
DSEObjectNotFoundException
public java.lang.Object getFormat(java.lang.String aFormatName)
getFormat
in interface OperationStepInterface
aFormatName
- java.lang.String
public Hashtable getFormats()
getFormats
in interface OperationStepInterface
public KeyedCollection getKeyedCollection()
getKeyedCollection
in interface OperationStepInterface
public java.lang.String getName()
getName
in interface OperationStepInterface
public Operation getOperation()
getOperation
in interface OperationStepInterface
public KeyedCollection getParams()
getParams
in interface OperationStepInterface
public Context getParent()
getParent
in interface OperationStepInterface
public Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
getService
in interface OperationStepInterface
aServiceName
- java.lang.String
DSEObjectNotFoundException
public java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
getValueAt
in interface OperationStepInterface
aCompositeKey
- java.lang.String
DSEObjectNotFoundException
public DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
removeAt
in interface OperationStepInterface
aCompositeKey
- java.lang.String
DSEInvalidRequestException
DSEObjectNotFoundException
public void setApplicationId(java.lang.String appId)
setApplicationId
in interface OperationStepInterface
public void setName(java.lang.String aName)
setName
in interface OperationStepInterface
aName
- java.lang.Stringpublic void setOperation(Operation anOperation)
setOperation
in interface OperationStepInterface
anOperation
- com.ibm.dse.base.Operationpublic void setParams(KeyedCollection kc)
setParams
in interface OperationStepInterface
kc
- com.ibm.dse.base.KeyedCollectionpublic void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
setValueAt
in interface OperationStepInterface
aCompositeKey
- java.lang.StringaDataValue
- java.lang.Object
DSEObjectNotFoundException
DSEInvalidArgumentException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |