|
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
This class is the base class for all the snippets.
Methods to access the context, services and formats are provided.
Constructor Summary | |
---|---|
BaseSnippet()
|
Method Summary | |
---|---|
protected void |
assignService(java.lang.String aServiceName,
BTTServiceRequester aServiceRequester)
Assigns the service. |
abstract int |
execute()
|
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. |
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. |
protected void |
releaseService(BTTServiceRequester aServiceRequester)
Releases the service. |
void |
setContext(Context cha)
Set the business process context. |
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 |
Constructor Detail |
public BaseSnippet()
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
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |