|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.server.flow.al.base.BaseSnippet
com.ibm.btt.server.flow.al.base.BaseOperSnippet
This class enables users to migrate the non-step operation in BTT4.x to the business process activity in BTT5.1. Users should substitute this class for DSEServerOperation as the base class.
Field Summary | |
---|---|
static java.lang.String |
CS_REPLY_FORMAT_NAME
CS_REPLY_FORMAT_NAME |
static java.lang.String |
CS_REQUEST_FORMAT_NAME
CS_REQUEST_FORMAT_NAME |
static java.lang.String |
HOST_RECEIVE_FORMAT_NAME
HOST_RECEIVE_FORMAT_NAME |
static java.lang.String |
HOST_SEND_FORMAT_NAME
HOST_SEND_FORMAT_NAME |
Constructor Summary | |
---|---|
BaseOperSnippet()
|
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds the data element aDataElement to the business process context. |
void |
chainTo(Context aContext)
Chains the business process context to the context aContext. |
void |
clearKeyedCollection(boolean keepKCollStatus,
boolean clearOnlyValues)
Clears the keyed collection of the business process context. |
void |
close()
Closes the operation. |
int |
execute()
Executes the operation |
java.lang.String |
getApplicationId()
Returns the business process application id. |
Context |
getContextByType(java.lang.String aContextType)
Returns the context whose type is aContextType in the chain of contexts. |
java.lang.String |
getContextName()
Returns the name of the business process context. |
FormatElement |
getCSReplyFormat()
Returns the format element named CS_REPLY_FORMAT_NAME. |
FormatElement |
getCSRequestFormat()
Returns the format element named CS_REQUEST_FORMAT_NAME. |
FormatElement |
getHostReceiveFormat()
Returns the format element named HOST_RECEIVE_FORMAT_NAME. |
FormatElement |
getHostSendFormat()
Returns the format element named HOST_SEND_FORMAT_NAME. |
KeyedCollection |
getKeyedCollection()
Returns the keyed collection of the business process context. |
java.lang.String |
getName()
Returns the operation name. |
java.lang.String |
getOriginWorkstation()
Returns the workstation terminal identifier (TID) belonging to the workstation that performed the request, which caused the operation to be executed. |
Context |
getParent()
Returns the parent of the business process context. |
java.lang.String |
getSessionId()
Returns the business process session id. |
java.lang.String |
getType()
Returns the type of the business process context. |
boolean |
isCacheable()
Returns true if this operation object can be cached. |
boolean |
isChained()
Returns true if the business process context is chained to the hierarchy. |
void |
prune()
Prunes the business process context from the hierarchy. |
DataElement |
removeAt(java.lang.String aCompositeKey)
Removes the data element identified by aCompositeKey from the business process context. |
void |
setContextName(java.lang.String aContextName)
Sets the name of the business process context. |
void |
setKeyedCollection(KeyedCollection aKeyedCollection)
Sets the keyed collection of the business process context. |
void |
setOriginWorkstation(java.lang.String aString)
Sets the workstation terminal identifier (TID) belonging to the workstation that performed the request. |
void |
setType(java.lang.String aContextType)
Sets the type of the business process context. |
java.lang.String |
toString()
Returns a string representing the operation. |
Vector |
toStrings()
Returns a vector with the operation represented as strings. |
void |
unchain()
Unchains the business process context form the hierarchy. |
Methods inherited from class com.ibm.btt.server.flow.al.base.BaseSnippet |
---|
assignService, getContext, getDataFromWorkArea, getElementAt, getFormat, getService, getSystemData, getValueAt, releaseService, setContext, setValueAt, unassignService |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String HOST_RECEIVE_FORMAT_NAME
public static final java.lang.String HOST_SEND_FORMAT_NAME
public static final java.lang.String CS_REPLY_FORMAT_NAME
public static final java.lang.String CS_REQUEST_FORMAT_NAME
Constructor Detail |
public BaseOperSnippet()
Method Detail |
public DataElement addElement(DataElement aDataElement) throws BTTBPException
aDataElement
- The data element to be added.
BTTBPException
public void chainTo(Context aContext) throws BTTBPException
aContext
- The context.
BTTBPException
public void clearKeyedCollection(boolean keepKCollStatus, boolean clearOnlyValues) throws BTTBPException
keepKCollStatus
- To keep the attributes of the keyed collection or not.clearOnlyValues
- To clear only the data element values or the data elements.
BTTBPException
public void close() throws BTTBPException
Now it only unchains the business process context. It should be implemented by the subclasses to perform housekeeping before ending the operation.
BTTBPException
public int execute() throws BTTBPException
execute
in class BaseSnippet
BTTBPException
public java.lang.String getApplicationId() throws BTTBPException
The application id is read-only here and should be set by the invoker of the business process in BTT system data as subsession id.
BTTBPException
public Context getContextByType(java.lang.String aContextType) throws BTTBPException
aContextType
- The context type.
BTTBPException
public java.lang.String getContextName() throws BTTBPException
BTTBPException
public FormatElement getHostReceiveFormat()
public FormatElement getHostSendFormat()
public KeyedCollection getKeyedCollection() throws BTTBPException
BTTBPException
public java.lang.String getName() throws BTTBPException
BTTBPException
public Context getParent() throws BTTBPException
BTTBPException
public java.lang.String getSessionId() throws BTTBPException
The session id is read-only here and should be set by the invoker of the business process in BTT system data as session id.
BTTBPException
public java.lang.String getType() throws BTTBPException
BTTBPException
public boolean isCacheable()
public boolean isChained() throws BTTBPException
BTTBPException
public void prune() throws BTTBPException
BTTBPException
public DataElement removeAt(java.lang.String aCompositeKey) throws BTTBPException
aCompositeKey
- The key of the data element.
BTTBPException
public void setContextName(java.lang.String aContextName) throws BTTBPException
aContextName
- The name of the business process context
BTTBPException
public void setKeyedCollection(KeyedCollection aKeyedCollection) throws BTTBPException
aKeyedCollection
- The keyed collection of the business process context
BTTBPException
public void setType(java.lang.String aContextType) throws BTTBPException
aContextType
- The type of the business process context
BTTBPException
public java.lang.String toString()
public Vector toStrings()
public void unchain() throws BTTBPException
BTTBPException
public FormatElement getCSReplyFormat()
public FormatElement getCSRequestFormat()
public java.lang.String getOriginWorkstation()
public void setOriginWorkstation(java.lang.String aString)
aString
- The origin workstation.
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |