IBM Branch Transformation Toolkit Javadoc

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

java.lang.Object
  extended bycom.ibm.btt.server.flow.al.base.BaseSnippet
Direct Known Subclasses:
BaseLogonSnippet, BaseOperSnippet, BaseOperStepSnippet

public abstract class BaseSnippet
extends java.lang.Object

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

BaseSnippet

public BaseSnippet()
Method Detail

setContext

public void setContext(Context cha)
Set the business process context.


getContext

protected Context getContext()
                      throws BTTBPException
Returns the business process context.

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

getValueAt

protected java.lang.Object getValueAt(java.lang.String aCompositeKey)
                               throws BTTBPException
Returns the value of the data element identified by aCompositeKey.

Parameters:
aCompositeKey - The key of the data element.
Returns:
java.lang.Object The value of the data element.
Throws:
BTTBPException

setValueAt

protected void setValueAt(java.lang.String aCompositeKey,
                          java.lang.Object aDataValue)
                   throws BTTBPException
Sets the value of the data element identified by aCompositeKey.

Parameters:
aCompositeKey - The key of the data element.
aDataValue - The value of the data element.
Throws:
BTTBPException

getElementAt

protected DataElement getElementAt(java.lang.String aCompositeKey)
                            throws BTTBPException
Returns the data element identified by aCompositeKey.

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

getService

protected BTTServiceRequester getService(java.lang.String aServiceName)
                                  throws BTTBPException
Returns the service named aServiceName.

Parameters:
aServiceName - The name of the service.
Returns:
com.ibm.btt.base.services.BTTServiceRequester The service.
Throws:
BTTBPException

releaseService

protected void releaseService(BTTServiceRequester aServiceRequester)
                       throws BTTBPException
Releases the service.

Parameters:
aServiceRequester - The service.
Throws:
BTTBPException

assignService

protected void assignService(java.lang.String aServiceName,
                             BTTServiceRequester aServiceRequester)
                      throws BTTBPException
Assigns the service.

Parameters:
aServiceName - The service name.
aServiceRequester - The service.
Throws:
BTTBPException

unassignService

protected void unassignService(java.lang.String aServiceName)
                        throws BTTBPException
Unassigns the service.

Parameters:
aServiceName - The service name.
Throws:
BTTBPException

getFormat

protected FormatElement getFormat(java.lang.String aFormatName)
Returns the format named aFormatName.

Parameters:
aFormatName - The name of the format.
Returns:
com.ibm.btt.formatter.client.FormatElement The format.

getDataFromWorkArea

protected java.lang.Object getDataFromWorkArea(java.lang.String name)
                                        throws BTTBPException
Returns the data stored in the business process work area.

Parameters:
name - The name of the data.
Returns:
java.lang.Object The data.
Throws:
BTTBPException

getSystemData

protected BTTSystemData getSystemData()
                               throws BTTBPException
Returns the system data stored in the business process work area.

Returns:
com.ibm.btt.base.BTTSystemData The system data.
Throws:
BTTBPException

execute

public abstract int execute()
                     throws BTTBPException
Throws:
BTTBPException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005