|
IBM Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CHASession
Remote 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 |
addElement(java.lang.String instanceID,
java.io.Serializable anElement)
Adds an element to the Context |
void |
chainTo(java.lang.String instanceID,
java.lang.String parentInstanceID)
Chains this context to the context named specified by parentInstanceID. |
void |
clearKeyedCollection(java.lang.String instanceID)
Clears the context (current level only) by destroying the current keyed collection associated and replacing it with a new one. |
void |
clearKeyedCollection(java.lang.String instanceID,
boolean keepKCollStatus,
boolean clearOnlyValues)
This method clears both the typed and non-typed elements in the context keyed collection. |
void |
commit(java.lang.String instanceID)
|
boolean |
containsChild(java.lang.String instanceID,
java.lang.String aContextName)
Returns true if this context has a child with the name aContextName. |
Vector |
fields(java.lang.String instanceID)
Returns all the data fields, which are addressable from this context. |
java.lang.String |
getAncestorByName(java.lang.String instanceID,
java.lang.String aContextName)
Searches the context tree for an ancestor Context named aContextName and returns the first matching context. |
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 |
getContextByType(java.lang.String instanceID,
java.lang.String aTypeName)
Returns the instanceID of the first context that matches its type to aTypeName. |
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. if sessionID is null, this distributed context is shared by all the sesison. |
Vector |
getContextTable()
Get the context table which is a hashtable. |
java.io.Serializable |
getElementAt(java.lang.String instanceID,
java.lang.String aCompositeKey,
boolean isReadOnly)
Returns the element of its keyedCollection,or keyedCollections of the upper contexts which is located at aCompositeKey path. |
KeyedCollection |
getKeyedCollection(java.lang.String instanceID)
Returns the keyedCollection attribute. |
java.lang.String |
getLevel(java.lang.String instanceID)
We can define an attribute --level-- in dsectxt.xml file to indicate level of the context. |
java.lang.String |
getName(java.lang.String instanceID)
|
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 |
getParentID(java.lang.String childInstanceID)
|
java.lang.String |
getParentName(java.lang.String instanceID)
|
java.lang.String |
getRoot()
Returns the instanceID of root context of the context tree. |
javax.ejb.SessionContext |
getSessionContext()
getSessionContext |
java.lang.String |
getTagName(java.lang.String instanceID)
Returns a String used by the externalizer. |
java.lang.String |
getTypeName(java.lang.String instanceID)
|
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 |
isAddToDynamicKColl(java.lang.String instanceID)
Returns the value of the addToDynamicKColl property. |
boolean |
isChained(java.lang.String instanceID)
return true/false based on the existence of a parent ID |
boolean |
isDirty(java.lang.String instanceID)
|
boolean |
isReadOnly(java.lang.String instanceID)
If the definition of this context in dsetxt.xml has the attribute readonly="true", this method will return true, otherwise, false is returned. |
boolean |
isRoot(java.lang.String instanceID)
|
void |
mapContents(java.lang.String formatName,
Context inputContext,
Context outputContext)
Maps two contexts, map the content of inputContext into outputContext. |
java.lang.String |
newContext(java.lang.String contextName,
java.lang.String typeName,
Context parentContext)
Creates a new CHAInstanceMemoryFactory Entity based on a context name, and the following optional params: type name parent CHAInstanceMemoryFactory 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,
KeyedCollection aKeyedCollection)
Creates a new CHAInstanceMemoryFactory Entity based on a context name, and the following optional params: type name parent CHAInstanceMemoryFactory remote interface The name specified in the context name must exist in the external XML definiton files. |
Context |
newDynamicContext(java.lang.String contextName)
Creates a new dynamic Local context with a supplied name. |
java.lang.String |
newRemoteContext(java.lang.String contextName,
java.lang.String typeName,
Context parentContext,
KeyedCollection aKeyedCollection)
Create a remote Context with settings from facade side |
void |
prune(java.lang.String currentInstanceID)
Removes this context and its children from the context tree. |
void |
pruneFromMemory(java.lang.String currentInstanceID)
Removes this context and its children from the context tree. |
DataElement |
removeAt(java.lang.String instanceID,
java.lang.String aCompositeKey)
Removes aCompositeKey element of its keyedCollection. |
DataElement |
removeAtAnyLevel(java.lang.String instanceID,
java.lang.String aCompositeKey)
Removes an element of its keyedCollection, or the keyedCollections in the upper contexts, located in the aCompositeKey path. |
void |
removeChild(java.lang.String childInstanceID)
|
void |
removeInstance(java.lang.String currentInstanceID)
Removes this context and its children from the context tree. |
void |
setAddToDynamicKColl(java.lang.String instanceID,
boolean newValue)
Sets the value of the addToDynamicKColl property. |
void |
setDirty(java.lang.String instanceID,
boolean dirty)
|
void |
setKCollDynamic(java.lang.String instanceID,
boolean aValue)
Set the value to the attribute dynamic for the keyedCollection in this context. |
void |
setKeyedCollection(java.lang.String instanceID,
java.io.Serializable akeyedCollection)
set the context's KeyedCollection. |
void |
setName(java.lang.String instanceID,
java.lang.String aContextName)
|
void |
setParentID(java.lang.String childInstanceID,
java.lang.String parentInstanceID)
Establish the child-parent relationship |
void |
setRoot(java.lang.String instanceID)
|
void |
setSessionContext(javax.ejb.SessionContext ctx)
setSessionContext |
void |
setTypeName(java.lang.String instanceID,
java.lang.String aContextType)
|
int |
setValueAt(java.lang.String instanceID,
SortedTable aSortedTable)
The function is similiar to setValueAt(String, Object) except that set pairs of keys and values stored in aSortedTable via one method. |
void |
setValueAt(java.lang.String instanceID,
java.lang.String aKey,
java.io.Serializable aValue)
|
Vector |
toStrings(java.lang.String instanceID)
Returns a visual representation of this context. |
int |
trySetElementAt(java.lang.String instanceID,
java.lang.String aCompositeKey,
java.io.Serializable aValue)
Set the value of the element of its keyedCollection, or keyedCollections of the upper contexts which is located at aCompositeKey path. |
void |
unchain(java.lang.String instanceID)
|
DataElement |
unformat(java.lang.String formatName,
java.lang.String aString,
java.lang.String instanceID)
|
DataElement |
unformatHashtable(java.lang.String formatName,
Hashtable aHashtable,
java.lang.String instanceID)
|
void |
unformatIndexedCollection(java.lang.String formatName,
Vector aVectorOfHashtables,
java.lang.String instanceID)
|
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
javax.ejb.SessionContext getSessionContext() throws java.rmi.RemoteException
java.rmi.RemoteException
void setSessionContext(javax.ejb.SessionContext ctx) throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String getContextNamed(java.lang.String contextName) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getNextContextHorizontal(java.lang.String currentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getNextContextVertical(java.lang.String parentInstanceID, java.lang.String childInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void prune(java.lang.String currentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector getChildrenAtAnyLevel(java.lang.String currentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void removeInstance(java.lang.String currentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean containsChild(java.lang.String instanceID, java.lang.String aContextName) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void addChild(java.lang.String childInstanceID, java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
childInstanceID
-
CHARemoteProcessException
java.rmi.RemoteException
void removeChild(java.lang.String childInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void chainTo(java.lang.String instanceID, java.lang.String parentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void unchain(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector getTypeTags() throws java.rmi.RemoteException
java.rmi.RemoteException
DataElement getTypePackages() throws java.rmi.RemoteException
java.rmi.RemoteException
Hashtable getTypeTagClassTable() throws java.rmi.RemoteException
java.rmi.RemoteException
DataElement getTypeTagClassTableDefinition() throws java.rmi.RemoteException
java.rmi.RemoteException
void setAddToDynamicKColl(java.lang.String instanceID, boolean newValue) throws CHARemoteProcessException, java.rmi.RemoteException
newValue
- boolean The new value of the property.
CHARemoteProcessException
java.rmi.RemoteException
void setKCollDynamic(java.lang.String instanceID, boolean aValue) throws CHARemoteProcessException, java.rmi.RemoteException
aValue
-
CHARemoteProcessException
java.rmi.RemoteException
void setKeyedCollection(java.lang.String instanceID, java.io.Serializable akeyedCollection) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void setParentID(java.lang.String childInstanceID, java.lang.String parentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
int setValueAt(java.lang.String instanceID, SortedTable aSortedTable) throws java.rmi.RemoteException
aSortedTable
-
java.rmi.RemoteException
void setValueAt(java.lang.String instanceID, java.lang.String aKey, java.io.Serializable aValue) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector toStrings(java.lang.String instanceID) throws java.rmi.RemoteException
java.rmi.RemoteException
int trySetElementAt(java.lang.String instanceID, java.lang.String aCompositeKey, java.io.Serializable aValue) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
DataElement removeAt(java.lang.String instanceID, java.lang.String aCompositeKey) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
DataElement removeAtAnyLevel(java.lang.String instanceID, java.lang.String aCompositeKey) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean isAddToDynamicKColl(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean isChained(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean isReadOnly(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean isRoot(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
instanceID
-
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getTagName(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getTypeName(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
instanceID
-
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getParentID(java.lang.String childInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
childInstanceID
-
CHARemoteProcessException
java.rmi.RemoteException
java.io.Serializable getElementAt(java.lang.String instanceID, java.lang.String aCompositeKey, boolean isReadOnly) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
KeyedCollection getKeyedCollection(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getLevel(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getContextByType(java.lang.String instanceID, java.lang.String aTypeName) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector fields(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getAncestorByName(java.lang.String instanceID, java.lang.String aContextName) throws CHARemoteProcessException, java.rmi.RemoteException
aContextName
- java.lang.String
CHARemoteProcessException
java.rmi.RemoteException
void addElement(java.lang.String instanceID, java.io.Serializable anElement) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void clearKeyedCollection(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector getChildren(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getRoot() throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void clearKeyedCollection(java.lang.String instanceID, boolean keepKCollStatus, boolean clearOnlyValues) throws CHARemoteProcessException, java.rmi.RemoteException, java.io.IOException
keepKCollStatus
- boolean (false - clear also the context kColl attributes; true -
keep the context kColl attributes and clear only the kColl data
elements)clearOnlyValues
- boolean (false - clear all attributes of the context kColl data
elements; true - clear only kColl data elements values)
java.io.IOException
- -
If keepKCollStatus or clearOnlyValues are false and the keyed
collection has not been defined in the generic data file or in
the generic types file
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getName(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void setName(java.lang.String instanceID, java.lang.String aContextName) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void setTypeName(java.lang.String instanceID, java.lang.String aContextType) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
boolean isDirty(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
instanceID
-
CHARemoteProcessException
CHARemoteProcessException
java.rmi.RemoteException
void setDirty(java.lang.String instanceID, boolean dirty) throws CHARemoteProcessException, java.rmi.RemoteException
instanceID
- dirty
-
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String newRemoteContext(java.lang.String contextName, java.lang.String typeName, Context parentContext, KeyedCollection aKeyedCollection) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String newContext(java.lang.String contextName, java.lang.String typeName, Context parentContext, KeyedCollection aKeyedCollection) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String newContext(java.lang.String contextName, java.lang.String typeName, Context parentContext) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Context newDynamicContext(java.lang.String contextName) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void setRoot(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
string
-
CHARemoteProcessException
java.rmi.RemoteException
void commit(java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
instanceID
-
CHARemoteProcessException
java.rmi.RemoteException
DataElement unformat(java.lang.String formatName, java.lang.String aString, java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
formatName
- aString
- aContext
-
DSEInvalidRequestException
DSEInvalidArgumentException
CHARemoteProcessException
java.rmi.RemoteException
DataElement unformatHashtable(java.lang.String formatName, Hashtable aHashtable, java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
void unformatIndexedCollection(java.lang.String formatName, Vector aVectorOfHashtables, java.lang.String instanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
Vector getContextTable() throws java.rmi.RemoteException
java.rmi.RemoteException
void mapContents(java.lang.String formatName, Context inputContext, Context outputContext) throws CHARemoteProcessException, java.rmi.RemoteException
inputContext
- outputContext
- formatName
-
DSEInvalidRequestException
CHARemoteProcessException
java.rmi.RemoteException
java.lang.String getParentName(java.lang.String instanceID) throws CHARemoteProcessException, DSEInvalidRequestException, java.rmi.RemoteException
CHARemoteProcessException
DSEInvalidRequestException
java.rmi.RemoteException
void pruneFromMemory(java.lang.String currentInstanceID) throws CHARemoteProcessException, java.rmi.RemoteException
CHARemoteProcessException
java.rmi.RemoteException
|
IBM Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |