IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class BTTOperation

java.lang.Object
  extended by com.ibm.btt.base.BTTOperation
All Implemented Interfaces:
Cacheable, Operation, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
BTTClientOperation, BTTServerOperation

public abstract class BTTOperation
extends java.lang.Object
implements Externalizable, Operation, Cacheable

The BTTOperation Class derives from Object and implements the interfaces Externalizable and Operation. This is an abstract class and it cannot be instantiated. An Operation has four attributes: - an externalizer: object from the BTTOperationExternalizer hierarchy used to build Operations objects from the definition file. - a context: contains the Context where the operation runs. This could be the operation itself because the operation will be a special context. - an id: contains the operation name. - a formats: a Hashtable that contains all the formats associated with this operation. - a isSelfDefinedOperation: a boolean indicating whether the operation is generic or self-defined.

See Also:
Serialized Form

Field Summary
protected  OperationRepliedListener aOperationRepliedListener
           
protected static java.lang.String COMPID
           
protected static Externalizer externalizer
           
 
Constructor Summary
BTTOperation()
          This constructor creates a BTTOperation object.
BTTOperation(java.lang.String aName)
          This constructor creates a new instance of Operation with its corresponding Context (obtained from the definition files through anOperationName).
BTTOperation(java.lang.String anOperationName, Context aParentContext)
          This constructor creates a new instance of Operation (obtained from the definition files through anOperationName) chained to aParentContext.
BTTOperation(java.lang.String anOperationName, java.lang.String aParentContext)
          This constructor creates a new instance of Operation (obtained from the definition files through anOperationName) chained to the Context named aParentContextName.
 
Method Summary
 DataElement addElement(DataElement aDataElement)
          Adds an element aDataElement to the keyed collection 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.
 void clearKeyedCollection(boolean keepKCollStatus, boolean clearOnlyValues)
          This method clears both the typed and non-typed elements in the operation context.
 void close()
          Unchains the operation context and removes it from the hierarchy.
 void execute()
          Executes the operation steps.
 Externalizer externalizer()
          Returns the OperationExternalizer instance, which is the current builder.
 void fireHandleOperationRepliedEvent(OperationRepliedEvent event)
          Support listener events.
 java.lang.String getApplicationId()
          Returns the value of the applicationId property.
 Context getContext()
          Returns the operation context.
 Context getContextByType(java.lang.String aContextType)
          Returns the context of type aContextType in the chain of contexts.
 java.lang.String getContextName()
          Returns the context name.
static Context getContextNamed(java.lang.String aContextName)
          Returns the Context named aContextName.
 DataElement getElementAt(java.lang.String aCompositeKey)
          Return the DataElement identified by aCompositeKey.
static Externalizer getExternalizer()
          Gets the BTTOperationExternalizer instance which is the current builder.
 java.lang.Object getFormat(java.lang.String aFormatName)
          Returns the formatElement named aFormatName from the formats Hashtable.
 Hashtable getFormats()
          Returns the operation formats Hashtable.
 java.lang.Object getHostReceiveFormat()
          Returns the hostReceiveFormat formatElement from the formats Hashtable.
 java.lang.Object getHostSendFormat()
          This method returns the hostSendFormat formatElement of the formats Hashtable.
 OperationStepInterface getInstanceOfOperationStep(java.lang.String anOpStep)
          Returns an instance of the operation step named anOpStep.
 KeyedCollection getKeyedCollection()
          Returns the context keyedCollection.
 java.lang.String getName()
          Returns the operation name.
 KeyedCollection getOperationStep(int index)
          Returns the instance of the operation step at the index position.
 int getOperationStepRC()
          Returns the operation step results code.
 KeyedCollection getOperationSteps()
          Returns the opSteps
 Context getParent()
          Returns the Context object defined as the parent context of the receiving context.
 TagInputStream getSelfDefinedOpTagInputStream(java.lang.String aSelfDefinedOperationId)
          Gets the TagInputStream corresponding to an operation ID.
 Service getService(java.lang.String aServiceName)
          Returns the service in the chain of context identified by aServiceName.
 java.lang.String getSessionId()
          Returns the value of the sessionId property.
 java.lang.String getSgmlSelfDefinedOpFileName(java.lang.String anOperationId)
          Gets the self-defined operation file name corresponding to anOperationId.
 java.lang.String getType()
          Returns the context type.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of the data element identified by aConpositeKey.
 OperationXValidate getXValidator()
          Returns the operation XValidator stored in the xval attribute.
 java.lang.Object initializeFormatFrom(Tag aTag)
          This method finds, instantiates, and adds the format element referred to by aTag, into the operation's formats.
 java.lang.Object initializeFrom(Tag aTag)
          This method will initialize this operation with all the data stored inside the tag: aTag
 java.lang.Object initializeKeyedCollectionValueFrom(Tag aTag)
          Initializes a collection of values from aTag.
 void initializeOpStep(Tag aTag)
          Initializes an OpStep for the operation
 void initializeOpStepsFrom(Tag aTag)
          Get the operation steps from a refOpSteps tag.
 boolean isCacheable()
          This method finds out if THIS particular object can be cached.
 boolean isChained()
          Returns true if the context is chained to the hierarchy.
 void postExecute(java.lang.Object object)
          execute the method after excuting this operation
 java.lang.Object preExecute()
          execute this method before excuting this operation
 void prune()
          Removes context from the hierarchy.
 void readExternal()
          Initializes an operation with its external value.
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
static java.lang.Object readObject(java.lang.String aName)
          Returns an Object, which is an instance of the operation named aName.
 void reinitialize()
          This method will reinitialize THIS object.
 DataElement removeAt(java.lang.String aCompositeKey)
          Removes the data element identified by aCompositeKey from the context data collection.
 void removeExternal()
          This method is an Externalizable interface method.
 void removeOperationRepliedListener(OperationRepliedListener newListener)
          Removes the operation replied listener.
 void setApplicationId(java.lang.String appId)
          Sets the value of the applicationId property.
 void setContext(Context aContext)
          Sets the context to aContext.
 void setContextName(java.lang.String aContextName)
          Sets the context name to aContextName.
 void setDefinedContext(boolean anIsDefinedContext)
           
static void setExternalizer(Externalizer anExternalizer)
          Sets the OperationExternalizer instance which will be the current builder to anExternalizer.
 void setHostReceiveFormat(java.lang.Object aFormat)
          Sets the hostReceiveFormat formatElement of the formats Hashtable to aFormat.
 void setHostSendFormat(java.lang.Object aFormat)
          Sets the hostSendFormat formatElement of the formats Hashtable to aFormat.
 void setKeyedCollection(KeyedCollection aKeyedCollection)
          Sets the context keyed collection to aKeyedCollection.
 void setName(java.lang.String aName)
          Sets the operation name to aName.
 void setSessionId(java.lang.String sessId)
          Sets the value of the sessionId property.
 void setType(java.lang.String aContextType)
          Sets the 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 setXValidator(OperationXValidate xValidator)
          Sets the value of the xval attribute.
protected  boolean stopExecution(OperationStepInterface opStep)
          This method is invoked following the execution of every operation steps.
 java.lang.String toString()
          Returns a String representating the operation.
 Vector toStrings()
          Returns a visual representation of the operation.
 Vector toTags()
          This method returns a Vector with the operation represented as a Tag.
 void unchain()
          Removes the receiving context from the context hierarchy.
 void writeExternal()
          Writes this instance converted in tags to a file.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for BTTOperation.
 java.lang.String[] xValidate()
          Returns a String Array that indicates if the validation has been achieved successfully or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COMPID

protected static final java.lang.String COMPID
See Also:
Constant Field Values

externalizer

protected static Externalizer externalizer

aOperationRepliedListener

protected transient OperationRepliedListener aOperationRepliedListener
Constructor Detail

BTTOperation

public BTTOperation()
This constructor creates a BTTOperation object.


BTTOperation

public BTTOperation(java.lang.String aName)
             throws java.io.IOException
This constructor creates a new instance of Operation with its corresponding Context (obtained from the definition files through anOperationName).

Parameters:
aName - java.lang.String - the operation name
Throws:
java.lang.Exception.
java.io.IOException

BTTOperation

public BTTOperation(java.lang.String anOperationName,
                    Context aParentContext)
             throws java.io.IOException,
                    DSEInvalidRequestException
This constructor creates a new instance of Operation (obtained from the definition files through anOperationName) chained to aParentContext.

Parameters:
anOperationName - java.lang.String - the operation name
aParentContext - java.lang.String - the parent context
Throws:
java.io.IOException
DSEInvalidRequestException

BTTOperation

public BTTOperation(java.lang.String anOperationName,
                    java.lang.String aParentContext)
             throws java.io.IOException,
                    DSEInvalidRequestException,
                    DSEObjectNotFoundException
This constructor creates a new instance of Operation (obtained from the definition files through anOperationName) chained to the Context named aParentContextName.

Parameters:
anOperationName - java.lang.String - the operation name
aParentContext - java.lang.String - the parent context name
Throws:
java.io.IOException
DSEInvalidRequestException
DSEObjectNotFoundException
Method Detail

chainTo

public void chainTo(Context aContext)
             throws DSEInvalidRequestException
Sets the receiving context as a child of aContext. The receiving context is set as the new current child. This method throws a DSEInvalidRequestException. Refer to the Context class chainTo method.

Specified by:
chainTo in interface Operation
Parameters:
aContext - com.ibm.btt.base.Context - the parent context
Throws:
DSEInvalidRequestException

getExternalizer

public static Externalizer getExternalizer()
                                    throws java.io.IOException
Gets the BTTOperationExternalizer instance which is the current builder.

Returns:
Externalizer - the BTTOperationExternalizer instance
Throws:
java.io.IOException

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
This method will initialize this operation with all the data stored inside the tag: aTag

Parameters:
aTag - com.ibm.btt.base.Tag - An operation Tag
Returns:
java.lang.Object - an initialized operation
Throws:
java.io.IOException
DSEException

initializeFormatFrom

public java.lang.Object initializeFormatFrom(Tag aTag)
                                      throws java.io.IOException
This method finds, instantiates, and adds the format element referred to by aTag, into the operation's formats.

Parameters:
aTag - com.ibm.btt.base.Tag - A format Tag
Returns:
java.lang.Object - an initialized format element
Throws:
java.io.IOException

initializeOpStep

public void initializeOpStep(Tag aTag)
                      throws java.io.IOException,
                             DSEInvalidArgumentException
Initializes an OpStep for the operation

Parameters:
aTag - com.ibm.btt.base.Tag - An opStep Tag
Throws:
java.io.IOException
DSEInvalidArgumentException

initializeOpStepsFrom

public void initializeOpStepsFrom(Tag aTag)
                           throws java.io.IOException
Get the operation steps from a refOpSteps tag.

Parameters:
aTag - com.ibm.btt.base.Tag - A refOpSteps Tag
Throws:
java.io.IOException

initializeKeyedCollectionValueFrom

public java.lang.Object initializeKeyedCollectionValueFrom(Tag aTag)
                                                    throws java.io.IOException
Initializes a collection of values from aTag.

Parameters:
aTag - com.ibm.btt.base.Tag - An iniValue Tag
Returns:
java.lang.Object - an operation instance
Throws:
java.io.IOException

setContext

public void setContext(Context aContext)
Sets the context to aContext.

Specified by:
setContext in interface Operation
Parameters:
aContext - com.ibm.btt.base.Context

getKeyedCollection

public KeyedCollection getKeyedCollection()
                                   throws DSEInvalidRequestException
Returns the context keyedCollection. Refer to the Context class getKeyedCollection method.

Specified by:
getKeyedCollection in interface Operation
Returns:
com.ibm.btt.base.KeyedCollection - an context keyedCollection
Throws:
DSEInvalidRequestException
DSEInvalidRequestException

execute

public void execute()
             throws java.lang.Exception
Executes the operation steps. If you need another behavior then extend a new class from this one and implement the method execute of that class.

Specified by:
execute in interface Operation
Throws:
java.lang.Exception

getOperationStep

public KeyedCollection getOperationStep(int index)
                                 throws java.lang.Exception
Returns the instance of the operation step at the index position.

Parameters:
index - int - the opStep index position
Returns:
com.ibm.btt.base.KeyedCollection
Throws:
com.ibm.btt.base.DSEObjectNotFoundException.
java.lang.Exception

getInstanceOfOperationStep

public OperationStepInterface getInstanceOfOperationStep(java.lang.String anOpStep)
                                                  throws java.lang.Exception
Returns an instance of the operation step named anOpStep.

Parameters:
anOpStep - java.lang.String - the OpStep name
Throws:
java.lang.Exception

xValidate

public java.lang.String[] xValidate()
Returns a String Array that indicates if the validation has been achieved successfully or not. If null, the validation has been achieved successfully. If is a String[], then the validation has not been achieved succefully and returns its error messages.

Specified by:
xValidate in interface Operation
Returns:
String[] - the result of the validation (null or error messages).

getXValidator

public OperationXValidate getXValidator()
Returns the operation XValidator stored in the xval attribute.

Returns:
OperationXValidate

setExternalizer

public static void setExternalizer(Externalizer anExternalizer)
Sets the OperationExternalizer instance which will be the current builder to anExternalizer.

Parameters:
anExternalizer - Externalizer - an Externalizer instance

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
Returns the OperationExternalizer instance, which is the current builder. This method is an Externalizable interface method.

Returns:
Externalizer
Throws:
java.io.IOException

getName

public java.lang.String getName()
Returns the operation name.

Specified by:
getName in interface Cacheable
Specified by:
getName in interface Operation
Returns:
id java.lang.String - the operation name

readExternal

public void readExternal()
                  throws java.io.IOException
Initializes an operation with its external value. This method is an Externalizable interface method. To work properly it is assumed: - This instance has an id (name) - The externalizer and its tagInputStream are initialized.

Throws:
java.io.IOException

getSelfDefinedOpTagInputStream

public TagInputStream getSelfDefinedOpTagInputStream(java.lang.String aSelfDefinedOperationId)
                                              throws java.io.IOException
Gets the TagInputStream corresponding to an operation ID.

Parameters:
aSelfDefinedOperationId - java.lang.String - the self-defined operation id
Returns:
com.ibm.btt.base.TagInputStream
Throws:
java.io.IOException

getSgmlSelfDefinedOpFileName

public java.lang.String getSgmlSelfDefinedOpFileName(java.lang.String anOperationId)
Gets the self-defined operation file name corresponding to anOperationId.

Parameters:
anOperationId - java.lang.String
Returns:
java.lang.String - an operation id

removeExternal

public void removeExternal()
                    throws java.io.IOException
This method is an Externalizable interface method. This method removes the tags for this object from the xml file where it is externalized.

Throws:
java.io.IOException

setName

public void setName(java.lang.String aName)
Sets the operation name to aName.

Specified by:
setName in interface Operation
Parameters:
aName - java.lang.String - the operation name

toStrings

public Vector toStrings()
Returns a visual representation of the operation.

Returns:
com.ibm.btt.base.Vector
Throws:
java.lang.Exception

getOperationSteps

public KeyedCollection getOperationSteps()
Returns the opSteps

Returns:
com.ibm.btt.base.KeyedCollection

toTags

public Vector toTags()
              throws java.io.IOException
This method returns a Vector with the operation represented as a Tag. This method is an Externalizable interface method.

Returns:
com.ibm.btt.base.Vector
Throws:
java.io.IOException

writeExternal

public void writeExternal()
                   throws java.io.IOException
Writes this instance converted in tags to a file. To work properly it is assumed: - This instance has an id (name) - This instance knows its operation type (generic or self-defined) - The externalizer and its tagInputStream are initialized.

Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

getContextNamed

public static Context getContextNamed(java.lang.String aContextName)
                               throws DSEInvalidRequestException
Returns the Context named aContextName. This method returns the Context named aContextName if the context instance identified by aContextName exists in the chain of contexts. Otherwise, it returns null.

Parameters:
aContextName - java.lang.String - a context name
Returns:
com.ibm.btt.base.Context
Throws:
DSEInvalidRequestException

getFormats

public Hashtable getFormats()
Returns the operation formats Hashtable.

Specified by:
getFormats in interface Operation
Returns:
com.ibm.btt.base.Hashtable

getValueAt

public java.lang.Object getValueAt(java.lang.String aCompositeKey)
                            throws DSEObjectNotFoundException
Returns the value of the data element identified by aConpositeKey. This method throws a DSEObjectNotFoundException if the data element is not found. Refer to the same method of the KeyedCollection class.

Specified by:
getValueAt in interface Operation
Parameters:
aCompositeKey - java.lang.String - a CompositeKey name
Returns:
java.lang.Object
Throws:
DSEObjectNotFoundException

setValueAt

public 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(). This method throws a DSEObjectNotFoundException if the data is not found.

Specified by:
setValueAt in interface Operation
Parameters:
aCompositeKey - java.lang.String - a CompositeKey name
aDataValue - java.lang.Object - a Data Element value
Throws:
DSEObjectNotFoundException
DSEInvalidArgumentException

isCacheable

public boolean isCacheable()
This method finds out if THIS particular object can be cached.

Specified by:
isCacheable in interface Cacheable
Returns:
boolean

reinitialize

public void reinitialize()
This method will reinitialize THIS object. It should be called immediately after being extracted from the cache.

Specified by:
reinitialize in interface Cacheable

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Provides concrete serialization handling for BTTOperation.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException

getContext

public Context getContext()
Returns the operation context.

Specified by:
getContext in interface Operation
Returns:
boolean com.ibm.btt.base.Context

readObject

public static java.lang.Object readObject(java.lang.String aName)
                                   throws java.io.IOException
Returns an Object, which is an instance of the operation named aName. This method is an Externalizable interface method. The operation Externalizer reads the corresponding definition file to find the object. This method throws an IOException if the externalizer is not initialized.

Parameters:
aName - java.lang.String - a operation name
Returns:
java.lang.Object
Throws:
java.io.IOException

unchain

public void unchain()
             throws DSEInvalidRequestException,
                    DSEObjectNotFoundException
Removes the receiving context from the context hierarchy. The parent attribute is set to null and the receiving context is removed from the children list in the parent context. The receiving context cannot have children. This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException. Refer to the Context class unchain method.

Specified by:
unchain in interface Operation
Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

addElement

public DataElement addElement(DataElement aDataElement)
                       throws DSEInvalidRequestException
Adds an element aDataElement to the keyed collection of the operation. This method throws a DSEInvalidRequestException. Refer to the Context class addElement method.

Specified by:
addElement in interface Operation
Parameters:
aDataElement - com.ibm.btt.base.DataElement - a Data Element
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEInvalidRequestException

close

public void close()
           throws DSEInvalidRequestException,
                  DSEObjectNotFoundException
Unchains the operation context and removes it from the hierarchy. It should be implemented by the subclasses in order to perform housekeeping processes before ending the operation process.

Specified by:
close in interface Operation
Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

getApplicationId

public java.lang.String getApplicationId()
Returns the value of the applicationId property.

Specified by:
getApplicationId in interface Operation
Returns:
String - The applicationId value

setApplicationId

public void setApplicationId(java.lang.String appId)
Sets the value of the applicationId property.

Specified by:
setApplicationId in interface Operation
Parameters:
appId - String - The new value of the applicationId

getContextName

public java.lang.String getContextName()
Returns the context name.

Specified by:
getContextName in interface Operation
Returns:
String - The operation context name

getElementAt

public DataElement getElementAt(java.lang.String aCompositeKey)
                         throws DSEObjectNotFoundException
Return the DataElement identified by aCompositeKey. Refer to the same method in the KeyedCollection class.

Specified by:
getElementAt in interface Operation
Parameters:
aCompositeKey - java.lang.String
Returns:
com.ibm.btt.base.DataElement - a Data Element
Throws:
DSEObjectNotFoundException

getFormat

public java.lang.Object getFormat(java.lang.String aFormatName)
                           throws DSEInvalidArgumentException
Returns the formatElement named aFormatName from the formats Hashtable.

Specified by:
getFormat in interface Operation
Parameters:
aFormatName - java.lang.String - the format name
Returns:
java.lang.Object - a format DataElement
Throws:
DSEInvalidArgumentException

getParent

public Context getParent()
                  throws DSEInvalidRequestException
Returns the Context object defined as the parent context of the receiving context.

Specified by:
getParent in interface Operation
Returns:
com.ibm.btt.base.Context - the parent context
Throws:
DSEInvalidRequestException
DSEInvalidRequestException

getType

public java.lang.String getType()
                         throws DSEInvalidRequestException
Returns the context type.

Specified by:
getType in interface Operation
Returns:
java.lang.String.
Throws:
DSEInvalidRequestException
DSEInvalidRequestException

isChained

public boolean isChained()
                  throws DSEInvalidRequestException
Returns true if the context is chained to the hierarchy. Otherwise, it returns false.

Specified by:
isChained in interface Operation
Returns:
boolean
Throws:
DSEInvalidRequestException
DSEInvalidRequestException

prune

public void prune()
           throws DSEInvalidRequestException,
                  DSEObjectNotFoundException
Removes context from the hierarchy. All their descendants become orphans. This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException. Refer to the Context class prune method.

Specified by:
prune in interface Operation
Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

removeAt

public DataElement removeAt(java.lang.String aCompositeKey)
                     throws DSEInvalidRequestException,
                            DSEObjectNotFoundException
Removes the data element identified by aCompositeKey from the context data collection. This method throws a DSEInvalidRequestException and a DSEObjectNotFoundException. Refer to the Context class removeAt method.

Specified by:
removeAt in interface Operation
Parameters:
aCompositeKey - java.lang.String - a CompositeKey value
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEInvalidRequestException
DSEObjectNotFoundException

setContextName

public void setContextName(java.lang.String aContextName)
Sets the context name to aContextName.

Specified by:
setContextName in interface Operation
Parameters:
aContextName - java.lang.String - a operarion context name

setKeyedCollection

public void setKeyedCollection(KeyedCollection aKeyedCollection)
                        throws DSEInvalidRequestException
Sets the context keyed collection to aKeyedCollection.

Specified by:
setKeyedCollection in interface Operation
Parameters:
aKeyedCollection - com.ibm.btt.base.KeyedCollection
Throws:
DSEInvalidRequestException

setType

public void setType(java.lang.String aContextType)
             throws DSEInvalidRequestException
Sets the context type to aContextType.

Specified by:
setType in interface Operation
Parameters:
aContextType - java.lang.String - a operation context type
Throws:
DSEInvalidRequestException
DSEInvalidRequestException

setDefinedContext

public void setDefinedContext(boolean anIsDefinedContext)
Parameters:
isDefinedContext - The isDefinedContext to set.

clearKeyedCollection

public void clearKeyedCollection(boolean keepKCollStatus,
                                 boolean clearOnlyValues)
                          throws java.io.IOException,
                                 DSEInvalidRequestException,
                                 DSEInvalidArgumentException
This method clears both the typed and non-typed elements in the operation context. It can clear only the elements of the kColl and keep the kColl attributes. For the kColl elements it is possible to clear only the values or to clear all the attributes.

Parameters:
keepKCollStatus - boolean (false - clear also the context kColl attributes; true - keep the context kColl attributes and clear only the kColl data elements)
clearOnlyValues - boolean (false - clear all attributes of the context kColl data elements; true - clear only kColl data elements values)
Throws:
java.io.IOException - - This exception occurs if the keyed collection is not defined in the generic files or in the self defined file
DSEInvalidRequestException
DSEInvalidArgumentException

getContextByType

public Context getContextByType(java.lang.String aContextType)
                         throws DSEInvalidRequestException
Returns the context of type aContextType in the chain of contexts. If the context does not exist, null is returned. Refer to the Context class getContextByType method.

Throws:
DSEInvalidRequestException

getHostReceiveFormat

public java.lang.Object getHostReceiveFormat()
Returns the hostReceiveFormat formatElement from the formats Hashtable.


getHostSendFormat

public java.lang.Object getHostSendFormat()
This method returns the hostSendFormat formatElement of the formats Hashtable.


getOperationStepRC

public int getOperationStepRC()
Returns the operation step results code.

Returns:
int

getService

public Service getService(java.lang.String aServiceName)
                   throws DSEObjectNotFoundException
Returns the service in the chain of context identified by aServiceName. This method throws a DSEObjectNotFoundException if the service is not found. Refer to the Context class getService method.

Specified by:
getService in interface Operation
Throws:
DSEObjectNotFoundException

getSessionId

public java.lang.String getSessionId()
Returns the value of the sessionId property.

Returns:
String - The sessionId value

setHostReceiveFormat

public void setHostReceiveFormat(java.lang.Object aFormat)
Sets the hostReceiveFormat formatElement of the formats Hashtable to aFormat.


setHostSendFormat

public void setHostSendFormat(java.lang.Object aFormat)
Sets the hostSendFormat formatElement of the formats Hashtable to aFormat.


setSessionId

public void setSessionId(java.lang.String sessId)
Sets the value of the sessionId property.

Parameters:
sessId - String - The new value of the sessionId

setXValidator

public void setXValidator(OperationXValidate xValidator)
Sets the value of the xval attribute.

Parameters:
xValidator - OperationXValidate

toString

public java.lang.String toString()
Returns a String representating the operation.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

addOperationRepliedListener

public void addOperationRepliedListener(OperationRepliedListener newListener)
Description copied from interface: Operation
Adds an operation replied listener.

Specified by:
addOperationRepliedListener in interface Operation
Parameters:
newListener - com.ibm.btt.base.OperationRepliedListener

removeOperationRepliedListener

public void removeOperationRepliedListener(OperationRepliedListener newListener)
Description copied from interface: Operation
Removes the operation replied listener.

Specified by:
removeOperationRepliedListener in interface Operation
Parameters:
newListener - com.ibm.btt.base.OperationRepliedListener

fireHandleOperationRepliedEvent

public void fireHandleOperationRepliedEvent(OperationRepliedEvent event)
Support listener events.

Parameters:
event - com.ibm.btt.base.OperationRepliedEvent

preExecute

public java.lang.Object preExecute()
execute this method before excuting this operation


postExecute

public void postExecute(java.lang.Object object)
execute the method after excuting this operation

Parameters:
object -

stopExecution

protected boolean stopExecution(OperationStepInterface opStep)
This method is invoked following the execution of every operation steps. Its returned value determines whether the following step is executed or stop the execution of the operation directly.

Parameters:
object - opStep the operation step just executed

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011