|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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. 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 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 |
public DataElement addElement(DataElement aDataElement)
throws DSEInvalidRequestException
aDataElement - com.ibm.dse.base.DataElement
public 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.String
public 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.String
public 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 name)
name - java.lang.Stringpublic void setOperation(Operation anOperation)
anOperation - com.ibm.dse.base.Operationpublic void setParams(KeyedCollection kc)
kc - com.ibm.dse.base.KeyedCollection
public 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 | ||||||||