|
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.BaseOperStepSnippet
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 |
public static final int RC_OK
public static final int RC_ERROR
public static final java.lang.String PARAM_NAME_KEY
Constructor Detail |
public BaseOperStepSnippet()
Method Detail |
public void loadParams(java.lang.String paramsInfoLocation) throws BTTBPException
If null is provided as the paramsInfoLocation, the properties file with the same name as the class will be used.
paramsInfoLocation
- The location of the resource bundle.
BTTBPException
public DataElement addElement(DataElement aDataElement) throws BTTBPException
aDataElement
- The data element to be added.
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 KeyedCollection getKeyedCollection() throws BTTBPException
BTTBPException
public java.lang.String getName() throws BTTBPException
BTTBPException
public KeyedCollection getParams() throws BTTBPException
BTTBPException
public Context getParent() throws BTTBPException
BTTBPException
public DataElement removeAt(java.lang.String aCompositeKey) throws BTTBPException
aCompositeKey
- The key of the data element.
BTTBPException
public void setName(java.lang.String aName) throws BTTBPException
aName
- The operation step name.
BTTBPException
public void setParams(KeyedCollection kc)
kc
- The operation step parameters.
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |