|
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.BaseActivity
This class is the base class for all the remote activities.
Methods to access the context, services and formats are provided.
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 | |
---|---|
BaseActivity()
|
Method Summary | |
---|---|
DataElement |
addElement(DataElement aDataElement)
Adds the data element aDataElement to the business process context. |
protected void |
assignService(java.lang.String aServiceName,
BTTServiceRequester aServiceRequester)
Assigns the service. |
abstract int |
execute()
|
java.lang.String |
getApplicationId()
Returns the business process application id. |
protected Context |
getContext()
Returns the business process context. |
protected java.lang.Object |
getDataFromWorkArea(java.lang.String name)
Returns the data stored in the business process work area. |
protected DataElement |
getElementAt(java.lang.String aCompositeKey)
Returns the data element identified by aCompositeKey. |
protected FormatElement |
getFormat(java.lang.String aFormatName)
Returns the format named aFormatName. |
KeyedCollection |
getKeyedCollection()
Returns the keyed collection of the business process context. |
java.lang.String |
getName()
Returns the activity name. |
KeyedCollection |
getParams()
Returns the activity parameters. |
Context |
getParent()
Returns the parent of the business process context. |
protected BTTServiceRequester |
getService(java.lang.String aServiceName)
Returns the service named aServiceName. |
protected BTTSystemData |
getSystemData()
Returns the system data stored in the business process work area. |
protected java.lang.Object |
getValueAt(java.lang.String aCompositeKey)
Returns the value of the data element identified by aCompositeKey. |
void |
loadParams(java.lang.String paramsInfoLocation)
Loads the operation step parameters from the resource bundle. |
protected void |
releaseService(BTTServiceRequester aServiceRequester)
Releases the service. |
DataElement |
removeAt(java.lang.String aCompositeKey)
Removes the data element identified by aCompositeKey from the business process context. |
void |
setContext(Context cha)
Set the business process context. |
void |
setName(java.lang.String aName)
Sets the activity name. |
void |
setParams(KeyedCollection kc)
Sets the activity parameters. |
protected void |
setValueAt(java.lang.String aCompositeKey,
java.lang.Object aDataValue)
Sets the value of the data element identified by aCompositeKey. |
protected void |
unassignService(java.lang.String aServiceName)
Unassigns the service. |
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 BaseActivity()
Method Detail |
public void setContext(Context cha)
protected Context getContext() throws BTTBPException
BTTBPException
protected java.lang.Object getValueAt(java.lang.String aCompositeKey) throws BTTBPException
aCompositeKey
- The key of the data element.
BTTBPException
protected void setValueAt(java.lang.String aCompositeKey, java.lang.Object aDataValue) throws BTTBPException
aCompositeKey
- The key of the data element.aDataValue
- The value of the data element.
BTTBPException
protected DataElement getElementAt(java.lang.String aCompositeKey) throws BTTBPException
aCompositeKey
- The key of the data element.
BTTBPException
protected BTTServiceRequester getService(java.lang.String aServiceName) throws BTTBPException
aServiceName
- The name of the service.
BTTBPException
protected void releaseService(BTTServiceRequester aServiceRequester) throws BTTBPException
aServiceRequester
- The service.
BTTBPException
protected void assignService(java.lang.String aServiceName, BTTServiceRequester aServiceRequester) throws BTTBPException
aServiceName
- The service name.aServiceRequester
- The service.
BTTBPException
protected void unassignService(java.lang.String aServiceName) throws BTTBPException
aServiceName
- The service name.
BTTBPException
protected FormatElement getFormat(java.lang.String aFormatName)
aFormatName
- The name of the format.
protected java.lang.Object getDataFromWorkArea(java.lang.String name) throws BTTBPException
name
- The name of the data.
BTTBPException
protected BTTSystemData getSystemData() throws BTTBPException
BTTBPException
public abstract int execute() throws BTTBPException
BTTBPException
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 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 |