|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.BTTOperation
public abstract class BTTOperation
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.
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. |
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 |
---|
protected static final java.lang.String COMPID
protected static Externalizer externalizer
protected transient OperationRepliedListener aOperationRepliedListener
Constructor Detail |
---|
public BTTOperation()
public BTTOperation(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String - the operation name
java.lang.Exception.
java.io.IOException
public BTTOperation(java.lang.String anOperationName, Context aParentContext) throws java.io.IOException, DSEInvalidRequestException
anOperationName
- java.lang.String - the operation nameaParentContext
- java.lang.String - the parent context
java.io.IOException
DSEInvalidRequestException
public BTTOperation(java.lang.String anOperationName, java.lang.String aParentContext) throws java.io.IOException, DSEInvalidRequestException, DSEObjectNotFoundException
anOperationName
- java.lang.String - the operation nameaParentContext
- java.lang.String - the parent context name
java.io.IOException
DSEInvalidRequestException
DSEObjectNotFoundException
Method Detail |
---|
public void chainTo(Context aContext) throws DSEInvalidRequestException
chainTo
in interface Operation
aContext
- com.ibm.btt.base.Context - the parent context
DSEInvalidRequestException
public static Externalizer getExternalizer() throws java.io.IOException
java.io.IOException
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.btt.base.Tag - An operation Tag
java.io.IOException
DSEException
public java.lang.Object initializeFormatFrom(Tag aTag) throws java.io.IOException
aTag
- com.ibm.btt.base.Tag - A format Tag
java.io.IOException
public void initializeOpStep(Tag aTag) throws java.io.IOException, DSEInvalidArgumentException
aTag
- com.ibm.btt.base.Tag - An opStep Tag
java.io.IOException
DSEInvalidArgumentException
public void initializeOpStepsFrom(Tag aTag) throws java.io.IOException
aTag
- com.ibm.btt.base.Tag - A refOpSteps Tag
java.io.IOException
public java.lang.Object initializeKeyedCollectionValueFrom(Tag aTag) throws java.io.IOException
aTag
- com.ibm.btt.base.Tag - An iniValue Tag
java.io.IOException
public void setContext(Context aContext)
setContext
in interface Operation
aContext
- com.ibm.btt.base.Contextpublic KeyedCollection getKeyedCollection() throws DSEInvalidRequestException
getKeyedCollection
in interface Operation
DSEInvalidRequestException
DSEInvalidRequestException
public void execute() throws java.lang.Exception
execute
in interface Operation
java.lang.Exception
public KeyedCollection getOperationStep(int index) throws java.lang.Exception
index
- int - the opStep index position
com.ibm.btt.base.DSEObjectNotFoundException.
java.lang.Exception
public OperationStepInterface getInstanceOfOperationStep(java.lang.String anOpStep) throws java.lang.Exception
anOpStep
- java.lang.String - the OpStep name
java.lang.Exception
public java.lang.String[] xValidate()
xValidate
in interface Operation
public OperationXValidate getXValidator()
public static void setExternalizer(Externalizer anExternalizer)
anExternalizer
- Externalizer - an Externalizer instancepublic Externalizer externalizer() throws java.io.IOException
java.io.IOException
public java.lang.String getName()
getName
in interface Cacheable
getName
in interface Operation
public void readExternal() throws java.io.IOException
java.io.IOException
public TagInputStream getSelfDefinedOpTagInputStream(java.lang.String aSelfDefinedOperationId) throws java.io.IOException
aSelfDefinedOperationId
- java.lang.String - the self-defined operation id
java.io.IOException
public java.lang.String getSgmlSelfDefinedOpFileName(java.lang.String anOperationId)
anOperationId
- java.lang.String
public void removeExternal() throws java.io.IOException
java.io.IOException
public void setName(java.lang.String aName)
setName
in interface Operation
aName
- java.lang.String - the operation namepublic Vector toStrings()
java.lang.Exception
public KeyedCollection getOperationSteps()
public Vector toTags() throws java.io.IOException
java.io.IOException
public void writeExternal() throws java.io.IOException
java.io.IOException
public void readExternal(java.io.ObjectInput s) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
s
- java.io.ObjectInput
java.io.IOException
java.lang.ClassNotFoundException
public static Context getContextNamed(java.lang.String aContextName) throws DSEInvalidRequestException
aContextName
- java.lang.String - a context name
DSEInvalidRequestException
public Hashtable getFormats()
getFormats
in interface Operation
public java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
getValueAt
in interface Operation
aCompositeKey
- java.lang.String - a CompositeKey name
DSEObjectNotFoundException
public void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
setValueAt
in interface Operation
aCompositeKey
- java.lang.String - a CompositeKey nameaDataValue
- java.lang.Object - a Data Element value
DSEObjectNotFoundException
DSEInvalidArgumentException
public boolean isCacheable()
isCacheable
in interface Cacheable
public void reinitialize()
reinitialize
in interface Cacheable
public void writeExternal(java.io.ObjectOutput s) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
s
- java.io.ObjectOutput
java.io.IOException
public Context getContext()
getContext
in interface Operation
public static java.lang.Object readObject(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String - a operation name
java.io.IOException
public void unchain() throws DSEInvalidRequestException, DSEObjectNotFoundException
unchain
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public DataElement addElement(DataElement aDataElement) throws DSEInvalidRequestException
addElement
in interface Operation
aDataElement
- com.ibm.btt.base.DataElement - a Data Element
DSEInvalidRequestException
public void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
close
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public java.lang.String getApplicationId()
getApplicationId
in interface Operation
public void setApplicationId(java.lang.String appId)
setApplicationId
in interface Operation
appId
- String - The new value of the applicationIdpublic java.lang.String getContextName()
getContextName
in interface Operation
public DataElement getElementAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
getElementAt
in interface Operation
aCompositeKey
- java.lang.String
DSEObjectNotFoundException
public java.lang.Object getFormat(java.lang.String aFormatName) throws DSEInvalidArgumentException
getFormat
in interface Operation
aFormatName
- java.lang.String - the format name
DSEInvalidArgumentException
public Context getParent() throws DSEInvalidRequestException
getParent
in interface Operation
DSEInvalidRequestException
DSEInvalidRequestException
public java.lang.String getType() throws DSEInvalidRequestException
getType
in interface Operation
DSEInvalidRequestException
DSEInvalidRequestException
public boolean isChained() throws DSEInvalidRequestException
isChained
in interface Operation
DSEInvalidRequestException
DSEInvalidRequestException
public void prune() throws DSEInvalidRequestException, DSEObjectNotFoundException
prune
in interface Operation
DSEInvalidRequestException
DSEObjectNotFoundException
public DataElement removeAt(java.lang.String aCompositeKey) throws DSEInvalidRequestException, DSEObjectNotFoundException
removeAt
in interface Operation
aCompositeKey
- java.lang.String - a CompositeKey value
DSEInvalidRequestException
DSEObjectNotFoundException
public void setContextName(java.lang.String aContextName)
setContextName
in interface Operation
aContextName
- java.lang.String - a operarion context namepublic void setKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidRequestException
setKeyedCollection
in interface Operation
aKeyedCollection
- com.ibm.btt.base.KeyedCollection
DSEInvalidRequestException
public void setType(java.lang.String aContextType) throws DSEInvalidRequestException
setType
in interface Operation
aContextType
- java.lang.String - a operation context type
DSEInvalidRequestException
DSEInvalidRequestException
public void setDefinedContext(boolean anIsDefinedContext)
isDefinedContext
- The isDefinedContext to set.public void clearKeyedCollection(boolean keepKCollStatus, boolean clearOnlyValues) throws java.io.IOException, DSEInvalidRequestException, DSEInvalidArgumentException
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)
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
public Context getContextByType(java.lang.String aContextType) throws DSEInvalidRequestException
DSEInvalidRequestException
public java.lang.Object getHostReceiveFormat()
public java.lang.Object getHostSendFormat()
public int getOperationStepRC()
public Service getService(java.lang.String aServiceName) throws DSEObjectNotFoundException
getService
in interface Operation
DSEObjectNotFoundException
public java.lang.String getSessionId()
public void setHostReceiveFormat(java.lang.Object aFormat)
public void setHostSendFormat(java.lang.Object aFormat)
public void setSessionId(java.lang.String sessId)
sessId
- String - The new value of the sessionIdpublic void setXValidator(OperationXValidate xValidator)
xValidator
- OperationXValidatepublic java.lang.String toString()
toString
in class java.lang.Object
public void addOperationRepliedListener(OperationRepliedListener newListener)
Operation
addOperationRepliedListener
in interface Operation
newListener
- com.ibm.btt.base.OperationRepliedListenerpublic void removeOperationRepliedListener(OperationRepliedListener newListener)
Operation
removeOperationRepliedListener
in interface Operation
newListener
- com.ibm.btt.base.OperationRepliedListenerpublic void fireHandleOperationRepliedEvent(OperationRepliedEvent event)
event
- com.ibm.btt.base.OperationRepliedEventpublic java.lang.Object preExecute()
public void postExecute(java.lang.Object object)
object
-
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |