|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Operation interface. This is the generic interface for any operation. Any object implementing this interface has to provide the corresponding protocol for initializing, executing, and closing the operation, as well as providing the corresponding context protocol to handle the operation as a context (get/set objects from/to its context, get formats and services, etc.).
Method Summary | |
DataElement |
addElement(DataElement aDataElement)
Adds an element aDataElement to the KeyedCollection of the operation. |
void |
addOperationRepliedListener(OperationRepliedListener newListener)
Adds an operation replied listener. |
void |
chainTo(Context aContext)
Sets the receiving context as a child of aContext and as the new current child. |
void |
chainToContextNamed(java.lang.String aContextName)
Sets the context as a child of the context named aContextName in the hierarchy. |
void |
close()
This method must include whatever housekeeping process before ending the operation process. |
void |
execute()
This method must provide the whole operation flow process. |
java.lang.String |
getApplicationId()
Returns the applicationId. |
Context |
getContext()
Returns the operation context. |
java.lang.String |
getContextName()
Returns the context name. |
DataElement |
getElementAt(java.lang.String aCompositeKey)
Returns the DataElement identified by the aCompositeKey parameter. |
java.lang.Object |
getFormat(java.lang.String aFormatName)
Returns the formatElement named aFormatName from the formats Hashtable. |
Hashtable |
getFormats()
* Returns the operation formats Hashtable. |
KeyedCollection |
getKeyedCollection()
Returns the context keyedCollection. |
java.lang.String |
getName()
Returns the operation name. |
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 from the chain of contexts attached to the operation. |
Service |
getServiceByType(java.lang.String aServiceType)
Returns the service of type aServiceType from the chain of contexts attached to the operation. |
java.lang.String |
getType()
Returns the operation context type. |
java.lang.Object |
getValueAt(java.lang.String aCompositeKey)
Returns value of the data element identified by aConpositeKey. |
boolean |
hasServices()
Returns true if the operation context has any service defined. |
boolean |
isChained()
Returns true if the operation context is chained to the hierarchy. |
void |
prune()
Removes the operation context from the hierarchy. |
DataElement |
removeAt(java.lang.String aCompositeKey)
Removes the data element identified by aCompositeKey from the context data collection. |
void |
removeOperationRepliedListener(OperationRepliedListener newListener)
Removes the operation replied listener. |
void |
setApplicationId(java.lang.String appId)
Sets the operation application id to applicationId. |
void |
setContext(Context aContext)
Sets the operation context to aContext. |
void |
setContextName(java.lang.String aContextName)
This method sets the context identifier to aContextName. |
void |
setKeyedCollection(KeyedCollection aKeyedCollection)
Sets the operation context keyed collection to aKeyedCollection. |
void |
setName(java.lang.String name)
Sets the operation name to name. |
void |
setType(java.lang.String aContextType)
Sets the operation context type to aContextType. |
void |
setValueAt(java.lang.String aCompositeKey,
java.lang.Object aDataValue)
Sets the value of the data identified by aCompositeKey to aDataValue. |
void |
unchain()
Removes the operation context from the context hierarchy. |
java.lang.String[] |
xValidate()
Returns a String that indicates if the validation has been achieved successfully or not. |
Method Detail |
public DataElement addElement(DataElement aDataElement) throws DSEInvalidRequestException
This method throws a DSEInvalidRequestException.
public void addOperationRepliedListener(OperationRepliedListener newListener)
newListener
- com.ibm.dse.base.OperationRepliedListenerpublic void chainTo(Context aContext) throws DSEInvalidRequestException
This method throws a DSEInvalidRequestException.
public void chainToContextNamed(java.lang.String aContextName) throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException generated by the chainTo method and throws a DSEObjectNotFoundException if context parent is not found.
public void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
public void execute() throws java.lang.Exception
public java.lang.String getApplicationId()
public Context getContext()
public java.lang.String getContextName()
public DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
public java.lang.Object getFormat(java.lang.String aFormatName) throws DSEInvalidArgumentException
public Hashtable getFormats()
public KeyedCollection getKeyedCollection()
public java.lang.String getName()
public Context getParent()
public Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the service is not found.
public Service getServiceByType(java.lang.String aServiceType) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the type of service is not found.
public java.lang.String getType()
public java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the data element is not found.
public boolean hasServices()
public boolean isChained()
public void prune() throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
public DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
public void removeOperationRepliedListener(OperationRepliedListener newListener)
public void setApplicationId(java.lang.String appId)
name
- java.lang.Stringpublic void setContext(Context aContext)
public void setContextName(java.lang.String aContextName)
public void setKeyedCollection(KeyedCollection aKeyedCollection)
public void setName(java.lang.String name)
name
- java.lang.Stringpublic void setType(java.lang.String aContextType)
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() and throws a DSEObjectNotFoundException if the data element is not found.
public void unchain() throws DSEInvalidRequestException, DSEObjectNotFoundException
This method throws a DSEInvalidRequestException and throws a DSEObjectNotFoundException.
public java.lang.String[] xValidate()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |