addElement(DataElement aDataElement)
addElement
DataElement addElement(DataElement aDataElement)
throws DSEInvalidRequestException
- Adds an element "aDataElement" to the KeyedCollection of the operation.
Refer to the Context class addElement method for an example of implementing this method.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
chainTo
void chainTo(Context aContext)
throws DSEInvalidRequestException
- Sets the receiving context as a child of "aContext" and as the new current child.
Refer to the Context class chainTo method for an example of implementing this method.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
close
void close()
throws DSEInvalidRequestException,
DSEObjectNotFoundException
- This method must include any housekeeping process before ending the operation process.
This method throws a DSEInvalidRequestException and throws
a DSEObjectNotFoundException.
- Throws:
DSEInvalidRequestException
DSEObjectNotFoundException
execute
void execute()
throws java.lang.Exception
- This method must provide the whole operation flow process.
This method throws a Exception.
- Throws:
java.lang.Exception
getApplicationId
java.lang.String getApplicationId()
- Returns the applicationId.
getContext
Context getContext()
- Returns the operation context.
getContextName
java.lang.String getContextName()
- Returns the context name.
getElementAt
DataElement getElementAt(java.lang.String aCompositeKey)
throws DSEObjectNotFoundException
- Returns the DataElement identified by the aCompositeKey parameter.
Refer to the same method in KeyedCollection class for an example of implementing this method.
This method throws a DSEObjectNotFoundException.
- Throws:
DSEObjectNotFoundException
getFormat
java.lang.Object getFormat(java.lang.String aFormatName)
throws DSEInvalidArgumentException
- Returns the formatElement named aFormatName from the formats Hashtable.
This method throws a DSEInvalidArgumentException.
- Throws:
DSEInvalidArgumentException
getFormats
Hashtable getFormats()
- * Returns the operation formats Hashtable.
getKeyedCollection
KeyedCollection getKeyedCollection()
throws DSEInvalidRequestException
- Returns the context keyedCollection.
Refer to the Context class getKeyedCollection method for an example of implementing this method.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
getName
java.lang.String getName()
- Returns the operation name.
- Specified by:
getName in interface Cacheable
- Returns:
- String
getParent
Context getParent()
throws DSEInvalidRequestException
- Returns the Context object defined as the parent context of the operation context.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
getType
java.lang.String getType()
throws DSEInvalidRequestException
- Returns the operation context type.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
getValueAt
java.lang.Object getValueAt(java.lang.String aCompositeKey)
throws DSEObjectNotFoundException
- Returns 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.
- Throws:
DSEObjectNotFoundException
isChained
boolean isChained()
throws DSEInvalidRequestException
- Returns true if the operation context is chained to the hierarchy.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
prune
void prune()
throws DSEInvalidRequestException,
DSEObjectNotFoundException
- Removes the operation context from the hierarchy. All of its descendants become orphans.
Refer to the Context class prune method for an example of implementing this method.
This method throws a "DSEInvalidRequestException" and throws
a DSEObjectNotFoundException.
- Throws:
DSEInvalidRequestException
DSEObjectNotFoundException
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 throws
a DSEObjectNotFoundException.
- Throws:
DSEInvalidRequestException
DSEObjectNotFoundException
setApplicationId
void setApplicationId(java.lang.String appId)
- Sets the operation application id to applicationId.
- Parameters:
name - java.lang.String
setContext
void setContext(Context aContext)
- Sets the operation context to aContext.
setContextName
void setContextName(java.lang.String aContextName)
- This method sets the context identifier to aContextName.
setKeyedCollection
void setKeyedCollection(KeyedCollection aKeyedCollection)
throws DSEInvalidRequestException
- Sets the operation context keyed collection to aKeyedCollection.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
setName
void setName(java.lang.String name)
- Sets the operation name to name.
- Parameters:
name - java.lang.String
setType
void setType(java.lang.String aContextType)
throws DSEInvalidRequestException
- Sets the operation context type to aContextType.
This method throws a DSEInvalidRequestException.
- Throws:
DSEInvalidRequestException
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()
and throws a DSEObjectNotFoundException if the data element is not found.
- Throws:
DSEObjectNotFoundException
DSEInvalidArgumentException
unchain
void unchain()
throws DSEInvalidRequestException,
DSEObjectNotFoundException
- Removes the operation context from the context hierarchy. The parent attribute is set to null
and the operation context is removed from the children list in the parent context.
The receiving context cannot have children.
Refer to the Context class unchain method for an example of implementing this method.
This method throws a DSEInvalidRequestException and throws
a DSEObjectNotFoundException.
- Throws:
DSEInvalidRequestException
DSEObjectNotFoundException
xValidate
java.lang.String[] xValidate()
- Returns a String that indicates if the validation has been achieved successfully or not. If method returns null
the validation was successful. If the returned value is a String[], the validation was not
successful and the returned String contains the error messages.
- Returns:
- String[] - the result of the validation (null or error messages).
getService
Service getService(java.lang.String aServiceName)
throws DSEObjectNotFoundException
- Returns the service named aServiceName from the chain of contexts attached to the operation.
Refer to the Context class getService method for an example of implementing this method.
This method throws a DSEObjectNotFoundException if the service is not found.
- Throws:
DSEObjectNotFoundException
addOperationRepliedListener
void addOperationRepliedListener(OperationRepliedListener newListener)
- Adds an operation replied listener.
- Parameters:
newListener - com.ibm.btt.base.OperationRepliedListener
removeOperationRepliedListener
void removeOperationRepliedListener(OperationRepliedListener newListener)
- Removes the operation replied listener.
(c) Copyright IBM Corporation 1998, 2009
|