IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.server.flow.al.base
Class BaseOperSnippet

java.lang.Object
  extended bycom.ibm.btt.server.flow.al.base.BaseSnippet
      extended bycom.ibm.btt.server.flow.al.base.BaseOperSnippet

public class BaseOperSnippet
extends BaseSnippet

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

HOST_RECEIVE_FORMAT_NAME

public static final java.lang.String HOST_RECEIVE_FORMAT_NAME
HOST_RECEIVE_FORMAT_NAME

See Also:
Constant Field Values

HOST_SEND_FORMAT_NAME

public static final java.lang.String HOST_SEND_FORMAT_NAME
HOST_SEND_FORMAT_NAME

See Also:
Constant Field Values

CS_REPLY_FORMAT_NAME

public static final java.lang.String CS_REPLY_FORMAT_NAME
CS_REPLY_FORMAT_NAME

See Also:
Constant Field Values

CS_REQUEST_FORMAT_NAME

public static final java.lang.String CS_REQUEST_FORMAT_NAME
CS_REQUEST_FORMAT_NAME

See Also:
Constant Field Values
Constructor Detail

BaseOperSnippet

public BaseOperSnippet()
Method Detail

addElement

public DataElement addElement(DataElement aDataElement)
                       throws BTTBPException
Adds the data element aDataElement to the business process context.

Parameters:
aDataElement - The data element to be added.
Returns:
com.ibm.btt.base.DataElement The data element added.
Throws:
BTTBPException

chainTo

public void chainTo(Context aContext)
             throws BTTBPException
Chains the business process context to the context aContext.

Parameters:
aContext - The context.
Throws:
BTTBPException

clearKeyedCollection

public void clearKeyedCollection(boolean keepKCollStatus,
                                 boolean clearOnlyValues)
                          throws BTTBPException
Clears the keyed collection of the business process context.

Parameters:
keepKCollStatus - To keep the attributes of the keyed collection or not.
clearOnlyValues - To clear only the data element values or the data elements.
Throws:
BTTBPException

close

public void close()
           throws BTTBPException
Closes the operation.

Now it only unchains the business process context. It should be implemented by the subclasses to perform housekeeping before ending the operation.

Throws:
BTTBPException

execute

public int execute()
            throws BTTBPException
Executes the operation

Specified by:
execute in class BaseSnippet
Throws:
BTTBPException

getApplicationId

public java.lang.String getApplicationId()
                                  throws BTTBPException
Returns the business process application id.

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.

Returns:
java.lang.String The business process application Id.
Throws:
BTTBPException

getContextByType

public Context getContextByType(java.lang.String aContextType)
                         throws BTTBPException
Returns the context whose type is aContextType in the chain of contexts.

Parameters:
aContextType - The context type.
Returns:
com.ibm.btt.base.Context The context.
Throws:
BTTBPException

getContextName

public java.lang.String getContextName()
                                throws BTTBPException
Returns the name of the business process context.

Returns:
java.lang.String The name of the business process context
Throws:
BTTBPException

getHostReceiveFormat

public FormatElement getHostReceiveFormat()
Returns the format element named HOST_RECEIVE_FORMAT_NAME.

Returns:
com.ibm.btt.formatter.client.FormatElement The format.

getHostSendFormat

public FormatElement getHostSendFormat()
Returns the format element named HOST_SEND_FORMAT_NAME.

Returns:
com.ibm.btt.formatter.client.FormatElement The format.

getKeyedCollection

public KeyedCollection getKeyedCollection()
                                   throws BTTBPException
Returns the keyed collection of the business process context.

Returns:
com.ibm.btt.base.KeyedCollecion The keyed collection of the business process context.
Throws:
BTTBPException

getName

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

Returns:
java.lang String The operation name.
Throws:
BTTBPException

getParent

public Context getParent()
                  throws BTTBPException
Returns the parent of the business process context.

Returns:
com.ibm.btt.base.Context The parent of the business process context.
Throws:
BTTBPException

getSessionId

public java.lang.String getSessionId()
                              throws BTTBPException
Returns the business process session id.

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.

Returns:
java.lang.String The business process session Id.
Throws:
BTTBPException

getType

public java.lang.String getType()
                         throws BTTBPException
Returns the type of the business process context.

Returns:
java.lang.String The type of the business process context.
Throws:
BTTBPException

isCacheable

public boolean isCacheable()
Returns true if this operation object can be cached.

Returns:
boolean If this operation object can be cached.

isChained

public boolean isChained()
                  throws BTTBPException
Returns true if the business process context is chained to the hierarchy.

Returns:
boolean If the business process context is chained.
Throws:
BTTBPException

prune

public void prune()
           throws BTTBPException
Prunes the business process context from the hierarchy.

Throws:
BTTBPException

removeAt

public DataElement removeAt(java.lang.String aCompositeKey)
                     throws BTTBPException
Removes the data element identified by aCompositeKey from the business process context.

Parameters:
aCompositeKey - The key of the data element.
Returns:
com.ibm.btt.base.DataElement The data element.
Throws:
BTTBPException

setContextName

public void setContextName(java.lang.String aContextName)
                    throws BTTBPException
Sets the name of the business process context.

Parameters:
aContextName - The name of the business process context
Throws:
BTTBPException

setKeyedCollection

public void setKeyedCollection(KeyedCollection aKeyedCollection)
                        throws BTTBPException
Sets the keyed collection of the business process context.

Parameters:
aKeyedCollection - The keyed collection of the business process context
Throws:
BTTBPException

setType

public void setType(java.lang.String aContextType)
             throws BTTBPException
Sets the type of the business process context.

Parameters:
aContextType - The type of the business process context
Throws:
BTTBPException

toString

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

Returns:
java.lang.String The string.

toStrings

public Vector toStrings()
Returns a vector with the operation represented as strings.

Returns:
com.ibm.btt.base.Vector The vector.

unchain

public void unchain()
             throws BTTBPException
Unchains the business process context form the hierarchy.

Throws:
BTTBPException

getCSReplyFormat

public FormatElement getCSReplyFormat()
Returns the format element named CS_REPLY_FORMAT_NAME.

Returns:
com.ibm.btt.formatter.client.FormatElement The format.

getCSRequestFormat

public FormatElement getCSRequestFormat()
Returns the format element named CS_REQUEST_FORMAT_NAME.

Returns:
com.ibm.btt.formatter.client.FormatElement The format.

getOriginWorkstation

public 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.

Returns:
java.lang.String The origin workstation.

setOriginWorkstation

public void setOriginWorkstation(java.lang.String aString)
Sets the workstation terminal identifier (TID) belonging to the workstation that performed the request.

Parameters:
aString - The origin workstation.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005