|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Local interface for Enterprise Bean: CHAInstance
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
void |
addElement(java.io.Serializable anElement)
Adds an element to the Context |
void |
clearKeyedCollection()
Clears the context (current level only) by destroying the current keyed collection associated and replacing it with a new one. |
void |
clearKeyedCollection(boolean keepKCollStatus,
boolean clearOnlyValues)
This method clears both the typed and non-typed elements in the context keyed collection. |
Vector |
fields()
Returns all the data fields, which are addressable from this context. |
void |
forChainTo(java.lang.String parentInstanceID)
Chains this context to the context named specified by parentInstanceID. |
void |
forUnchain()
Removes this context and all its children from the context tree. |
java.lang.String |
getAncestorByName(java.lang.String aContextName)
Searches the context tree for an ancestor Context named aContextName and returns the first matching context. |
byte[] |
getContext()
Get accessor for persistent attribute: context |
java.lang.String |
getContextByType(java.lang.String aTypeName)
Returns the instanceID of the first context that matches its type to aTypeName. |
java.io.Serializable |
getElementAt(java.lang.String aCompositeKey,
boolean isReadOnly)
Returns the element of its keyedCollection,or keyedCollections of the upper contexts which is located at aCompositeKey path. |
javax.ejb.EntityContext |
getEntityContext()
getEntityContext |
java.lang.String |
getInstanceID()
Get accessor for persistent attribute: instanceID |
boolean |
getIsRoot()
Get accessor for persistent attribute: isRoot |
KeyedCollection |
getKeyedCollection()
Returns the keyedCollection attribute. |
java.lang.String |
getLevel()
We can define an attribute --level-- in dsectxt.xml file to indicate level of the context. |
java.lang.String |
getName()
Get accessor for persistent attribute: name |
java.lang.String |
getParentID()
Get accessor for persistent attribute: parentID |
Context |
getRealContext()
Returns the _context. |
java.lang.String |
getTypeName()
Get accessor for persistent attribute: typeName |
boolean |
isAddToDynamicKColl()
Returns the value of the addToDynamicKColl property. |
boolean |
isChained()
return true/false based on the existence of a parent ID |
boolean |
isReadOnly()
If the definition of this context in dsetxt.xml has the attribute readonly="true", this method will return true, otherwise, false is returned. |
DataElement |
removeAt(java.lang.String aCompositeKey)
Removes aCompositeKey element of its keyedCollection. |
DataElement |
removeAtAnyLevel(java.lang.String aCompositeKey)
Removes an element of its keyedCollection, or the keyedCollections in the upper contexts, located in the aCompositeKey path. |
void |
setAddToDynamicKColl(boolean newValue)
Sets the value of the addToDynamicKColl property. |
void |
setContext(byte[] newContext)
Set accessor for persistent attribute: context |
void |
setInstanceID(java.lang.String newInstanceID)
Set accessor for persistent attribute: instanceID |
void |
setIsRoot(boolean newIsRoot)
Set accessor for persistent attribute: isRoot |
void |
setKCollDynamic(boolean aValue)
Set the value to the attribute dynamic for the keyedCollection in this context. |
void |
setKeyedCollection(java.io.Serializable akeyedCollection)
set the context's KeyedCollection. |
void |
setName(java.lang.String newName)
Set accessor for persistent attribute: name |
void |
setParentID(java.lang.String newParentID)
Set accessor for persistent attribute: parentID |
void |
setRealContext(Context context)
Sets the _context. |
void |
setTypeName(java.lang.String newTypeName)
Set accessor for persistent attribute: typeName |
int |
setValueAt(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 aKey,
java.io.Serializable aValue)
Adds a value to the Context |
Vector |
toStrings()
Returns a visual representation of this context. |
int |
trySetElementAt(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. |
Methods inherited from interface javax.ejb.EJBLocalObject |
---|
getEJBLocalHome, getPrimaryKey, isIdentical, remove |
Field Detail |
public static final java.lang.String COPYRIGHT
Method Detail |
public void setName(java.lang.String newName)
public void setParentID(java.lang.String newParentID)
public void setContext(byte[] newContext)
public void setInstanceID(java.lang.String newInstanceID)
public void setKeyedCollection(java.io.Serializable akeyedCollection) throws CHAException
CHAException
public void setValueAt(java.lang.String aKey, java.io.Serializable aValue) throws CHAException
CHAException
public void addElement(java.io.Serializable anElement) throws CHAException
CHAException
public void clearKeyedCollection() throws CHAException
CHAException
public void clearKeyedCollection(boolean keepKCollStatus, boolean clearOnlyValues) throws CHAException
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)
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
CHAException
public byte[] getContext()
public javax.ejb.EntityContext getEntityContext()
public java.lang.String getInstanceID()
public java.lang.String getName()
public java.lang.String getParentID()
public boolean isChained() throws CHAException
CHAException
public Context getRealContext()
public void setRealContext(Context context)
public KeyedCollection getKeyedCollection() throws CHAException
CHAException
public Vector fields() throws CHAException
CHAException
public java.lang.String getAncestorByName(java.lang.String aContextName) throws CHAException
aContextName
- java.lang.String
CHAException
public java.lang.String getContextByType(java.lang.String aTypeName) throws CHAException
CHAException
public DataElement removeAt(java.lang.String aCompositeKey) throws CHAException
CHAException
public DataElement removeAtAnyLevel(java.lang.String aCompositeKey) throws CHAException
CHAException
public int trySetElementAt(java.lang.String aCompositeKey, java.io.Serializable aValue) throws CHAException
CHAException
public int setValueAt(SortedTable aSortedTable)
aSortedTable
-
public boolean isReadOnly() throws CHAException
CHAException
public java.io.Serializable getElementAt(java.lang.String aCompositeKey, boolean isReadOnly) throws CHAException
CHAException
public boolean isAddToDynamicKColl() throws CHAException
CHAException
public void setAddToDynamicKColl(boolean newValue) throws CHAException
newValue
- boolean The new value of the property.
CHAException
public void setKCollDynamic(boolean aValue) throws CHAException
aValue
-
CHAException
public Vector toStrings()
public java.lang.String getTypeName()
public void setTypeName(java.lang.String newTypeName)
public boolean getIsRoot()
public void setIsRoot(boolean newIsRoot)
public java.lang.String getLevel() throws CHAException
CHAException
public void forChainTo(java.lang.String parentInstanceID) throws CHAException
CHAException
public void forUnchain() throws CHAException
CHAException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |