IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.cha.ejb
Interface CHASessionLocal

All Superinterfaces:
javax.ejb.EJBLocalObject

public interface CHASessionLocal
extends javax.ejb.EJBLocalObject

Local interface for Enterprise Bean: CHASession


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addChild(java.lang.String childInstanceID, java.lang.String instanceID)
           
 void chainTo(java.lang.String instanceID, java.lang.String parentInstanceID)
          Chains this context to the context named specified by parentInstanceID.
 boolean containsChild(java.lang.String instanceID, java.lang.String aContextName)
          Returns true if this context has a child with the name aContextName.
 java.util.Collection getByName(java.lang.String aName)
          Returns a collection of CHAInstance objects sharing a common name
 java.util.Collection getByType(java.lang.String aType)
          Returns a collection of CHAInstance objects sharing a common type name
 Vector getChildren(java.lang.String instanceID)
           
 Vector getChildrenAtAnyLevel(java.lang.String currentInstanceID)
          Get the children of a remote context at any level from the context tree.
 java.lang.String getContextNamed(java.lang.String contextName)
          Searches the context tree from the root context for a context named aContextName in the session specified by parameter sessionID and returns the first matching context.
 java.lang.String getNextContextHorizontal(java.lang.String currentInstanceID)
          The method used to iterate over the context tree.
 java.lang.String getNextContextVertical(java.lang.String parentInstanceID, java.lang.String childInstanceID)
          The method used to iterate over the context tree.
 java.lang.String getRoot()
          Returns the root context of the context tree.
 javax.ejb.SessionContext getSessionContext()
          getSessionContext
 DataElement getTypePackages()
          Get the packages info for type data from CHA server side dse.ini
 Hashtable getTypeTagClassTable()
          Get the tag class table for type data from CHA server side dse.ini
 DataElement getTypeTagClassTableDefinition()
          Get definition for tag class table in server side dse.ini file
 Vector getTypeTags()
           
 boolean isThisContext(java.lang.String aContextName)
          Returns true if there is at least one context in the context tree that has a name that matches aContextName.
 java.lang.String newContext(java.lang.String contextName, java.lang.String typeName, Context parentContext, KeyedCollection aKeyedCollection, java.lang.String location)
          Creates a new CHAInstance Entity based on a context name, and the following optional params: type name parent CHAInstance remote interface The name specified in the context name must exist in the external XML definiton files.
 java.lang.String newContext(java.lang.String contextName, java.lang.String typeName, Context parentContext, java.lang.String location)
          Creates a new CHAInstance Entity based on a context name, and the following optional params: type name parent CHAInstance remote interface The name specified in the context name must exist in the external XML definiton files.
 Context newDynamicContext(java.lang.String contextName, java.lang.String location)
          Creates a new dynamic Local context with a supplied name.
 int occurrencesNamed(java.lang.String aContextName)
          Returns the number of contexts in the context tree that have names that match aContextName.
 void prune(java.lang.String currentInstanceID)
          Removes this context and its children from the context tree.
 void removeCHAInstance(java.lang.String instanceID)
          Method removeCHAInstance.
 void removeChild(java.lang.String childInstanceID)
           
 void removeInstance(java.lang.String currentInstanceID)
          Removes this context and its children from the context tree.
 void setSessionContext(javax.ejb.SessionContext ctx)
          setSessionContext
 void unchain(java.lang.String instanceID)
           
 
Methods inherited from interface javax.ejb.EJBLocalObject
getEJBLocalHome, getPrimaryKey, isIdentical, remove
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getByName

public java.util.Collection getByName(java.lang.String aName)
                               throws CHAException
Returns a collection of CHAInstance objects sharing a common name

Throws:
CHAException

getByType

public java.util.Collection getByType(java.lang.String aType)
                               throws CHAException
Returns a collection of CHAInstance objects sharing a common type name

Throws:
CHAException

getRoot

public java.lang.String getRoot()
                         throws CHAException
Returns the root context of the context tree.

Throws:
CHAException

getSessionContext

public javax.ejb.SessionContext getSessionContext()
getSessionContext


isThisContext

public boolean isThisContext(java.lang.String aContextName)
                      throws CHAException
Returns true if there is at least one context in the context tree that has a name that matches aContextName.

Throws:
CHAException

occurrencesNamed

public int occurrencesNamed(java.lang.String aContextName)
Returns the number of contexts in the context tree that have names that match aContextName.


setSessionContext

public void setSessionContext(javax.ejb.SessionContext ctx)
setSessionContext


removeCHAInstance

public void removeCHAInstance(java.lang.String instanceID)
                       throws CHAException
Method removeCHAInstance.

Parameters:
instanceID -
Throws:
CHAException

getContextNamed

public java.lang.String getContextNamed(java.lang.String contextName)
                                 throws CHAException
Searches the context tree from the root context for a context named aContextName in the session specified by parameter sessionID and returns the first matching context. if sessionID is null, this distributed context is shared by all the sesison.

Throws:
CHAException

getNextContextHorizontal

public java.lang.String getNextContextHorizontal(java.lang.String currentInstanceID)
                                          throws CHAException
The method used to iterate over the context tree.

Returns:
String instanceID
Throws:
CHAException

getNextContextVertical

public java.lang.String getNextContextVertical(java.lang.String parentInstanceID,
                                               java.lang.String childInstanceID)
                                        throws CHAException
The method used to iterate over the context tree.

Throws:
CHAException

newContext

public java.lang.String newContext(java.lang.String contextName,
                                   java.lang.String typeName,
                                   Context parentContext,
                                   KeyedCollection aKeyedCollection,
                                   java.lang.String location)
                            throws CHAException
Creates a new CHAInstance Entity based on a context name, and the following optional params: type name parent CHAInstance remote interface The name specified in the context name must exist in the external XML definiton files.

Throws:
CHAException

newContext

public java.lang.String newContext(java.lang.String contextName,
                                   java.lang.String typeName,
                                   Context parentContext,
                                   java.lang.String location)
                            throws CHAException
Creates a new CHAInstance Entity based on a context name, and the following optional params: type name parent CHAInstance remote interface The name specified in the context name must exist in the external XML definiton files.

Throws:
CHAException

newDynamicContext

public Context newDynamicContext(java.lang.String contextName,
                                 java.lang.String location)
                          throws CHAException
Creates a new dynamic Local context with a supplied name. The Context is created based on external definitions If the supplied name is given, it is created from the server-side external definitions. If no name is given, it will return null.

Throws:
CHAException

prune

public void prune(java.lang.String currentInstanceID)
           throws CHAException
Removes this context and its children from the context tree.

Throws:
CHAException

getChildrenAtAnyLevel

public Vector getChildrenAtAnyLevel(java.lang.String currentInstanceID)
                             throws CHAException
Get the children of a remote context at any level from the context tree.

Throws:
CHAException

removeInstance

public void removeInstance(java.lang.String currentInstanceID)
                    throws CHAException
Removes this context and its children from the context tree.

Throws:
CHAException

containsChild

public boolean containsChild(java.lang.String instanceID,
                             java.lang.String aContextName)
                      throws CHAException
Returns true if this context has a child with the name aContextName. It returns false otherwise.

Throws:
CHAException

addChild

public void addChild(java.lang.String childInstanceID,
                     java.lang.String instanceID)
              throws CHAException
Parameters:
childInstanceID -
Throws:
CHAException

getChildren

public Vector getChildren(java.lang.String instanceID)
                   throws CHAException
Throws:
CHAException

removeChild

public void removeChild(java.lang.String childInstanceID)
                 throws CHAException
Throws:
CHAException

chainTo

public void chainTo(java.lang.String instanceID,
                    java.lang.String parentInstanceID)
             throws CHAException
Chains this context to the context named specified by parentInstanceID. This method throws an CHAException if this context does not exist.

Throws:
CHAException

unchain

public void unchain(java.lang.String instanceID)
             throws CHAException
Throws:
CHAException

getTypeTags

public Vector getTypeTags()

getTypePackages

public DataElement getTypePackages()
Get the packages info for type data from CHA server side dse.ini


getTypeTagClassTable

public Hashtable getTypeTagClassTable()
Get the tag class table for type data from CHA server side dse.ini


getTypeTagClassTableDefinition

public DataElement getTypeTagClassTableDefinition()
Get definition for tag class table in server side dse.ini file


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005