IBM Branch Transformation Toolkit Javadoc

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

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

public class BaseOperStepSnippet
extends BaseSnippet

This class enables users to migrate the operation step in BTT4.x to the business process activity in BTT5.1.

Users should substitute this class for OperationStep as the base class. Following methods in com.ibm.dse.base.OperationStep are not supported:

public Hashtable getFormats();

public Operation getOperation();

public void setOperation(Operation anOperation);

public void setApplicationId(String appId).

A method named loadParams is provided to support the parameters in BTT4.x.


Field Summary
static java.lang.String PARAM_NAME_KEY
          PARAM_NAME_KEY
static int RC_ERROR
          RC_ERROR
static int RC_OK
          RC_OK
 
Constructor Summary
BaseOperStepSnippet()
           
 
Method Summary
 DataElement addElement(DataElement aDataElement)
          Adds the data element aDataElement to the business process context.
 int execute()
          Executes the operation step.
 java.lang.String getApplicationId()
          Returns the business process application id.
 KeyedCollection getKeyedCollection()
          Returns the keyed collection of the business process context.
 java.lang.String getName()
          Returns the operation step name.
 KeyedCollection getParams()
          Returns the operation step parameters.
 Context getParent()
          Returns the parent of the business process context.
 void loadParams(java.lang.String paramsInfoLocation)
          Loads the operation step parameters from the resource bundle.
 DataElement removeAt(java.lang.String aCompositeKey)
          Removes the data element identified by aCompositeKey from the business process context.
 void setName(java.lang.String aName)
          Sets the operation step name.
 void setParams(KeyedCollection kc)
          Sets the operation step parameters.
 
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, toString, wait, wait, wait
 

Field Detail

RC_OK

public static final int RC_OK
RC_OK

See Also:
Constant Field Values

RC_ERROR

public static final int RC_ERROR
RC_ERROR

See Also:
Constant Field Values

PARAM_NAME_KEY

public static final java.lang.String PARAM_NAME_KEY
PARAM_NAME_KEY

See Also:
Constant Field Values
Constructor Detail

BaseOperStepSnippet

public BaseOperStepSnippet()
Method Detail

loadParams

public void loadParams(java.lang.String paramsInfoLocation)
                throws BTTBPException
Loads the operation step parameters from the resource bundle.

If null is provided as the paramsInfoLocation, the properties file with the same name as the class will be used.

Parameters:
paramsInfoLocation - The location of the resource bundle.
Throws:
BTTBPException

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

execute

public int execute()
            throws BTTBPException
Executes the operation step.

Specified by:
execute in class BaseSnippet
Returns:
int The result of the execution.
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

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 step name.

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

getParams

public KeyedCollection getParams()
                          throws BTTBPException
Returns the operation step parameters.

Returns:
com.ibm.btt.base.KeyedCollection The operation step parameters.
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

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

setName

public void setName(java.lang.String aName)
             throws BTTBPException
Sets the operation step name.

Parameters:
aName - The operation step name.
Throws:
BTTBPException

setParams

public void setParams(KeyedCollection kc)
Sets the operation step parameters.

Parameters:
kc - The operation step parameters.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005