|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.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 an 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. Refer to the same method in KeyedCollection class for an example of implementing this method. |
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
aDataElement
- com.ibm.dse.base.DataElementpublic abstract int execute() throws java.lang.Exception
public java.lang.String getApplicationId()
public Context getContext()
public DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
aFormatName
- java.lang.Stringpublic java.lang.Object getFormat(java.lang.String aFormatName)
aFormatName
- java.lang.Stringpublic Hashtable getFormats()
public KeyedCollection getKeyedCollection()
public java.lang.String getName()
public Operation getOperation()
public KeyedCollection getParams()
public Context getParent()
public Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
aServiceName
- java.lang.Stringpublic java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the data element is not found.
aCompositeKey
- java.lang.Stringpublic DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException.
aCompositeKey
- java.lang.Stringpublic void setApplicationId(java.lang.String appId)
name
- java.lang.Stringpublic void setName(java.lang.String aName)
name
- java.lang.Stringpublic void setOperation(Operation anOperation)
anOperation
- com.ibm.dse.base.Operationpublic void setParams(KeyedCollection kc)
kc
- com.ibm.dse.base.KeyedCollectionpublic void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
This method throws a DSEInvalidRequestException if the data type doesn't allow a setValue(). It throws a DSEObjectNotFoundException if the data is not found.
aCompositeKey
- java.lang.StringaDataValue
- java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |