|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.eindex.objects.ObjectNode
The ObjectNode class performs the following functions:
Constructor Summary | |
ObjectNode()
Creates a new instance of the ObjectNode class. |
|
ObjectNode(java.lang.String tag,
java.util.ArrayList names,
java.util.ArrayList types)
Creates a new instance of the ObjectNode class by its object tag, field names, and field types. |
|
ObjectNode(java.lang.String tag,
java.util.ArrayList names,
java.util.ArrayList types,
java.util.ArrayList values)
Creates a new instance of the ObjectNode class by its object tag, field names, field types, and field values. |
Method Summary | |
void |
addChild(ObjectNode child)
Adds a new child object to the object node. |
void |
addChildHard(ObjectNode child)
Adds a new child object to the object node without checking for duplicates before adding the new object. |
void |
addChildNoFlagSet(ObjectNode child)
Adds a new child object to the object node. |
void |
addChildren(java.util.ArrayList children)
Adds a list of child objects to the object node. |
void |
addChildToTypeArrayList(ObjectNode child)
Adds a child object to a list of child objects based on the object type of the child object to add. |
void |
clearField(java.lang.String name)
Sets a field to null and the modifies the "changed" flag to true. |
ObjectNode |
copy()
Creates a complete copy of the object node. |
void |
deleteChild(ObjectNode node)
Marks a child object for deletion, identifying the child object by the specified object node. |
void |
deleteChild(java.lang.String type,
SuperKey key)
Marks a child object for deletion, identifying the child object by its object tag and key field settings. |
boolean |
equals(ObjectNode node)
Checks whether a child object is equal to the child object passed in as a parameter. |
java.util.ArrayList |
getAllChildrenFromHashMap()
Returns a list of child objects from the hash table. |
ObjectNode |
getChild(java.lang.String type,
ObjectKey key)
Retrieves a child ObjectNode by its object tag and its unique object key value. |
ObjectKey |
getChildKey(java.lang.String type)
Retrieves the unique key field setting for the child object identified by the specified object tag. |
java.util.ArrayList |
getChildrenForType(java.lang.String type,
boolean create)
Returns a list of child objects based on the object type. |
SuperKey |
getChildSuperKey(java.lang.String type)
Retrieves the unique key setting for the child object identified by the specified object tag. |
ObjectField |
getField(java.lang.String fieldname)
Retrieves an ObjectField object by its field name. |
boolean |
getFlag(java.lang.String name,
int mask)
Checks whether a field's bit mask is enabled or disabled. |
java.lang.String |
getObjectId()
Retrieves the unique ID for the object. |
ObjectNode |
getParent()
Retrieves the parent object node. |
java.lang.Object |
getValue(java.lang.String name)
Retrieves the value of a field given the field's name. |
ObjectField |
getValueObject(java.lang.String name)
Retrieves a field object (ObjectField) given the field's name. |
boolean |
hasFieldReadAccess(java.lang.String name)
Checks whether the given field has read access. |
boolean |
hasFieldUpdateAccess(java.lang.String name)
Checks whether the given field has update access. |
int |
hashCode()
Returns the hash code of the object node. |
boolean |
hasObjectAddAccess()
Checks whether the object has add access. |
boolean |
hasObjectDeleteAccess()
Checks whether the object has delete access. |
boolean |
hasObjectReadAccess()
Checks whether the object has read access. |
boolean |
hasObjectUpdateAccess()
Checks whether the object has update access. |
boolean |
isAdded()
Checks whether the object node has been added to the object. |
boolean |
isChanged(java.lang.String name)
Checks whether the value of a field changed in the current transaction. |
boolean |
isKeyChanged()
Checks whether key fields in the object node have changed. |
boolean |
isKeyType(java.lang.String name)
Checks whether the given field is a unique key field. |
boolean |
isKeyValid(ObjectKey key)
Checks whether the given key object is valid. |
boolean |
isNew()
Checks whether the object node is new or already exists in the database. |
boolean |
isNull(java.lang.String name)
Checks whether the given field contains a null value. |
boolean |
isNullable(java.lang.String name)
Checks whether the value of the given field can be null. |
boolean |
isRemoved()
Checks whether an object node is marked for deletion. |
boolean |
isSearched(java.lang.String name)
Checks whether a field is used for searches. |
boolean |
isUpdated()
Checks whether an object node has been updated during a transaction. |
boolean |
isVisible(java.lang.String name)
Checks whether a field is visible on the Enterprise Data Manager (EDM). |
java.util.ArrayList |
pGetChildren()
Retrieves a list of all child nodes in the object node. |
java.util.ArrayList |
pGetChildren(java.lang.String type)
Retrieves a list of all child nodes of the specified child type. |
java.util.ArrayList |
pGetChildTags()
Retrieves a list of the names of the different types of child objects defined in the object node. |
java.util.ArrayList |
pGetFieldNames()
Retrieves a list of all field names in the object node. |
ObjectField[] |
pGetFields()
Retrieves an array list of all ObjectField objects in the object node. |
java.util.ArrayList |
pGetFieldUpdateLogs()
Retrieves a list of transaction log entries for the object node. |
java.util.ArrayList |
pGetFieldValues()
Retrieves a list of field values for the fields defined in the object node. |
java.lang.String |
pGetFlagString()
Returns a string representation of the object node, but does not include field details. |
ObjectKey |
pGetKey()
Retrieves the unique key setting for the object node. |
SuperKey |
pGetSuperKey()
Retrieves the unique key field setting for the object node. |
java.lang.String |
pGetTag()
Retrieves the tag of the ObjectNode object. |
java.lang.String |
pGetType()
Retrieves the type of the ObjectNode object. |
int |
pGetType(java.lang.String name)
Retrieves a field's data type given the field's name. |
void |
removeChild(ObjectNode node)
Removes a child object from the ObjectNode. |
void |
removeChild(java.lang.String type,
ObjectKey objKey)
Removes a child object from the ObjectNode using the child object tag and object key setting to determine which child object to remove. |
void |
removeChildren()
Removes all child objects from the ObjectNode. |
void |
removeChildren(java.lang.String type)
Removes all child objects of a specific type from the ObjectNode. |
void |
reset()
Resets all access flags for the object node, but does not reset the flags for any of the child objects in the object node. |
void |
resetAll()
Resets all access flags for the object node, including the flags for the child objects in the object node. |
void |
setAddFlag(boolean flag)
Sets the value of the add flag, indicating whether the ObjectNode object is newly added. |
void |
setChanged(java.lang.String name,
boolean flag)
Sets the value of the field change flag, indicating whether the specified field was changed in the ObjectNode object. |
void |
setFieldReadAccess(java.lang.String name,
boolean flag)
Sets the value of a field's read access flag. |
void |
setFieldUpdateAccess(java.lang.String name,
boolean flag)
Sets the value of a field's update access flag. |
void |
setFieldUpdateLogs(java.util.ArrayList logs)
Sets a list of transaction log entries. |
void |
setFlag(java.lang.String name,
int mask,
boolean flag)
Sets a field's bit mask, which indicates whether to update, add, or remove a field. |
void |
setKey(ObjectKey key)
Sets the value of the object node's key field. |
void |
setKeyChangeFlag(boolean flag)
Sets the value of the key change flag, indicating whether key fields were changed in the ObjectNode object. |
void |
setKeyType(java.lang.String name,
boolean flag)
Sets a flag indicating whether a field is a key type field or not. |
void |
setNull(java.lang.String name,
boolean flag)
Specifies whether to set a field's value to null. |
void |
setNullable(java.lang.String name,
boolean flag)
Specifies whether a field can contain a null value. |
void |
setObjectAddAccess(boolean flag)
Sets the value of the add access flag for the object node, indicating whether the object has add access. |
void |
setObjectDeleteAccess(boolean flag)
Sets the value of the delete access flag for the object node, indicating whether the object has delete access. |
void |
setObjectReadAccess(boolean flag)
Sets the value of the read access flag for the object node, indicating whether the object has read access. |
void |
setObjectUpdateAccess(boolean flag)
Sets the value of the update access flag for the object node, indicating whether the object has update access. |
void |
setParent(ObjectNode parent)
Sets the parent object for the object node. |
void |
setRemoveFlag(boolean flag)
Specifies whether the object node is marked for deletion. |
void |
setSearched(java.lang.String name,
boolean flag)
Specifies whether the given field is used for searches. |
void |
setUpdateFlag(boolean flag)
Specifies whether the given object node was updated. |
void |
setValue(java.lang.String name,
java.lang.Object value)
Sets the value of a field, using the field name to identify the field. |
void |
setVisible(java.lang.String name,
boolean flag)
Specifies whether a field is visible on the EDM, using the field name to identify the field. |
ObjectNode |
structCopy()
Creates a structural copy of the object node. |
java.lang.String |
toString()
Returns a string representation of the object node. |
void |
unChange()
Resets the changes made to an object, returning the object to its previous status. |
void |
update(ObjectNode node,
boolean addNewChild,
boolean delMissingChild)
Updates an existing object node with the input object node similar to the updateIfChanged method described above. |
void |
updateChild(ObjectNode child)
Updates an existing child object in the object node. |
void |
updateIfChanged(ObjectNode node,
boolean addNewChild,
boolean delMissingChild)
Updates an existing object node with the input object node, comparing the two nodes first to see if anything is changed. |
void |
updateIfNotEqual(ObjectNode node,
boolean addNewChild,
boolean delMissingChild)
Updates an existing object node with the input object node similar to the updateIfChanged method described above, but does not update field values that are equal between the two nodes. |
void |
updateIfNotNull(ObjectNode node,
boolean addNewChild,
boolean delMissingChild)
Updates an existing object node with the input object node similar to the updateIfChanged method described above, but does not update existing field values with null values. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ObjectNode()
public ObjectNode(java.lang.String tag, java.util.ArrayList names, java.util.ArrayList types) throws ObjectException
tag
- A string containing the object tag.names
- A list of names of the fields contained in the object node.types
- A list of the types of fields contained in the object node.
ObjectException
- Thrown if an error occurs while creating
the instance.public ObjectNode(java.lang.String tag, java.util.ArrayList names, java.util.ArrayList types, java.util.ArrayList values) throws ObjectException
tag
- A string containing the object tag.names
- A list of names of the fields contained in the object node.types
- A list of the types of fields contained in the object node.values
- A list of the values of the fields contained in the object
node.
ObjectException
- Thrown if an error occurs while creating
the instance.Method Detail |
public void addChild(ObjectNode child) throws ObjectException
child
- The child object to add.
void
- None.
ObjectException
- Thrown if an error occurs while adding the
child object.public void addChildHard(ObjectNode child) throws ObjectException
child
- The child object to add.
void
- None.
ObjectException
- Thrown if an error occurs while adding the
child object.public void addChildNoFlagSet(ObjectNode child) throws ObjectException
child
- The child object to add.
void
- None.
ObjectException
- Thrown if an error occurs while adding the
child object.public void addChildren(java.util.ArrayList children) throws ObjectException
children
- A list of child objects to add.
void
- None.
ObjectException
- Thrown if an error occurs while adding the
child objects.public void addChildToTypeArrayList(ObjectNode child)
child
- The child object to add to the list.
void
- None.
public void clearField(java.lang.String name) throws ObjectException
name
- The name of the field being modified.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the field value or modifying the flag.public ObjectNode copy() throws ObjectException
ObjectNode
- A copy of the specified object node.
ObjectException
- Thrown if an error occurs while copying
the object node.public void deleteChild(ObjectNode node) throws ObjectException
node
- An ObjectNode object containing the child object to delete.
void
- None.
ObjectException
- Thrown if an error occurs while marking the
object for deletion.public void deleteChild(java.lang.String type, SuperKey key) throws ObjectException
type
- The type of child object to mark for deletion.key
- The key field of the child object.
void
- None.
ObjectException
- Thrown if an error occurs while marking the
object for deletion.public boolean equals(ObjectNode node) throws ObjectException
node
- An ObjectNode object containing the child object to compare against.
boolean
- An indicator of whether the two child objects are equal. Boolean
true indicates the objects are equal; false indicates they are not.
ObjectException
- Thrown if an error occurs while copying
the object node.public java.util.ArrayList getAllChildrenFromHashMap()
ArrayList
- A list of child objects.
public ObjectNode getChild(java.lang.String type, ObjectKey key) throws ObjectException
type
- A string containing the object tag.key
- The value of the unique key field.
ObjectNode
- A child object of the specified type with the specified
unique key field.
ObjectException
- Thrown if an error occurs while retrieving the
child object.public ObjectKey getChildKey(java.lang.String type) throws ObjectException
type
- A string containing the object tag.
ObjectKey
- The setting of the unique key field for the specified
child object.
ObjectException
- Thrown if an error occurs while retrieving the
key setting.public java.util.ArrayList getChildrenForType(java.lang.String type, boolean create)
type
- The type of child object to return.create
- A Boolean indicator of whether to create a new hash
table for the child objects before returning the child object list.
Specify true to create the hash table; otherwise specify
false.
ArrayList
- A list of child objects.
public SuperKey getChildSuperKey(java.lang.String type) throws ObjectException
type
- A string containing the object tag.
SuperKey
- The setting of the unique key field or, if no unique key
field exists, the unique master index ID of the specified child object.
ObjectException
- Thrown if an error occurs while retrieving the
key setting.public ObjectField getField(java.lang.String fieldname) throws ObjectException
fieldname
- The name of the field whose ObjectField object you want
to retrieve.
ObjectField
- The field object corresponding to the given field
name.
ObjectException
- Thrown if an error occurs while retrieving the
ObjectField object.public boolean getFlag(java.lang.String name, int mask) throws ObjectException
name
- The name of the field to check.mask
- The bit mask of the field.
boolean
- An indicator of whether the bit mask is enabled or
disabled. True indicates the bit mask is enabled; false
indicates it is disabled.
ObjectException
- Thrown if an error occurs while checking the
bit mask status.public java.lang.String getObjectId() throws ObjectException
String
- The unique ID of the object.
ObjectException
- Thrown if an error occurs while retrieving
the ID.public ObjectNode getParent()
ObjectNode
- The parent object node of the given object.
public java.lang.Object getValue(java.lang.String name) throws ObjectException
name
- The name of the field to retrieve.
Object
- The value of the given field.
ObjectException
- Thrown if an error occurs while retrieving the
field value.public ObjectField getValueObject(java.lang.String name) throws ObjectException
name
- The name of the field.
ObjectField
- A field object with the given field name.
ObjectException
- Thrown if an error occurs while retrieving the
field object.public boolean hasFieldReadAccess(java.lang.String name) throws ObjectException
name
- The name of the field.
boolean
- An indicator of whether the field has read access.
True indicates the field has read access; false
indicates it does not.
ObjectException
- Thrown if an error occurs while retrieving the
read access status of the field.public boolean hasFieldUpdateAccess(java.lang.String name) throws ObjectException
name
- The name of the field.
boolean
- An indicator of whether the field has update access.
True indicates the field has update access; false
indicates it does not.
ObjectException
- Thrown if an error occurs while retrieving the
update access status of the field.public int hashCode()
int
- The hash code of the object node.
public boolean hasObjectAddAccess()
boolean
- An indicator of whether the object has add access.
True indicates the object has add access; false
indicates it does not.
public boolean hasObjectDeleteAccess()
boolean
- An indicator of whether the object has delete access.
True indicates the object has delete access; false
indicates it does not.
public boolean hasObjectReadAccess()
boolean
- An indicator of whether the object has read access.
True indicates the object has read access; false
indicates it does not.
public boolean hasObjectUpdateAccess()
boolean
- An indicator of whether the object has update access.
True indicates the object has update access; false
indicates it does not.
public boolean isAdded()
boolean
- An indicator of whether the object node is new.
True indicates the node is new; false indicates it is not
new.
public boolean isChanged(java.lang.String name) throws ObjectException
name
- The name of the field.
boolean
- An indicator of whether the field value changed.
True indicates the field value changed; false
indicates it did not change.
ObjectException
- Thrown if an error occurs while checking whether
the value of the field changed.public boolean isKeyChanged()
boolean
- An indicator of whether key fields in the object node have
changed. True indicates key fields have changed; false
indicates they have not changed.
public boolean isKeyType(java.lang.String name) throws ObjectException
name
- The name of the field.
boolean
- An indicator of whether the field is a unique key field.
True indicates the field is a unique key field; false
indicates it is not.
ObjectException
- Thrown if an error occurs while retrieving the
unique key access status of the field.public boolean isKeyValid(ObjectKey key)
key
- The object key (ObjectKey) to check.
boolean
- An indicator of whether the key is valid.
True indicates the key is valid; false
indicates it is not.
ObjectException
- Thrown if an error occurs while checking
the key.public boolean isNew()
Boolean
- An indicator of whether the object node is new.
Boolean true indicates the object is new; false indicates
the object already exists.
public boolean isNull(java.lang.String name) throws ObjectException
name
- The name of the field to check.
boolean
- An indicator of whether the field value is null.
True indicates the value of the field is null; false
indicates it is not.
ObjectException
- Thrown if an error occurs while checking the
value of the field.public boolean isNullable(java.lang.String name) throws ObjectException
name
- The name of the field.
boolean
- An indicator of whether the value of field can be null.
True indicates the field value can be null; false
indicates it cannot.
ObjectException
- Thrown if an error occurs while checking
the field.public boolean isRemoved()
boolean
- An indicator of whether the field is marked for deletion.
True indicates the field is marked for deletion; false
indicates it is not.
ObjectException
- Thrown if an error occurs while retrieving the
status of the field.public boolean isSearched(java.lang.String name) throws ObjectException
name
- The name of the field to check.
boolean
- An indicator of whether the field is used for searches.
True indicates the field is used; false
indicates it is not.
ObjectException
- Thrown if an error occurs while checking
the field.public boolean isUpdated()
boolean
- An indicator of whether the object node was updated.
True indicates the object was updated; false
indicates it was not.
ObjectException
- Thrown if an error occurs while checking
the object.public boolean isVisible(java.lang.String name) throws ObjectException
name
- The name of the field to check.
boolean
- An indicator of whether the field is visible on the EDM.
True indicates the field is visible; false
indicates it is not.
ObjectException
- Thrown if an error occurs while checking
the field.public java.util.ArrayList pGetChildren()
ArrayList
- A list of child object nodes.
public java.util.ArrayList pGetChildren(java.lang.String type)
type
- A string containing an object tag.
ArrayList
- A list of child object nodes.
public java.util.ArrayList pGetChildTags()
ArrayList
- A list of child object tags.
public java.util.ArrayList pGetFieldNames()
ArrayList
- A list of field names.
public ObjectField[] pGetFields()
ObjectField[]
- A list of field objects.
public java.util.ArrayList pGetFieldUpdateLogs()
ArrayList
- A list of transaction log entries.
public java.util.ArrayList pGetFieldValues()
ArrayList
- A list of transaction log entries.
public java.lang.String pGetFlagString()
String
- A string representation of the object node.
public ObjectKey pGetKey() throws ObjectException
ObjectKey
- The names, types, and values of the object's unique key
fields.
ObjectException
- Thrown if an error occurs while retrieving the
key setting.public SuperKey pGetSuperKey() throws ObjectException
ObjectKey
- The names, types, and values of the object's unique key
fields.
ObjectException
- Thrown if an error occurs while retrieving the
key setting.public java.lang.String pGetTag()
String
- The tag for the given object.
public java.lang.String pGetType()
String
- The object type for the given object.
public int pGetType(java.lang.String name) throws ObjectException
name
- The name of the field to check.
int
- An integer representing the field type.
ObjectException
- Thrown if an error occurs while retrieving the
field type.public void removeChild(ObjectNode node)
node
- The child object to remove.
void
- None.
public void removeChild(java.lang.String type, ObjectKey objKey) throws ObjectException
type
- The child object tag.objKey
- The child object's object key setting.
void
- None.
ObjectException
- Thrown if an error occurs while removing
the child object.public void removeChildren()
void
- None.
public void removeChildren(java.lang.String type)
type
- The type of child object to remove.
void
- None.
public void reset()
void
- None.
public void resetAll()
void
- None.
public void setAddFlag(boolean flag)
flag
- A Boolean flag indicating whether the object node is newly
added. True indicates the object node is newly added; false
indicates it is not.
void
- None.
public void setChanged(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field whose change flag is being set.flag
- A Boolean flag indicating whether the field was updated in
the object node. True indicates the field was updated; false
indicates it was not.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the flag.public void setFieldReadAccess(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which the access flag is being set.flag
- A boolean flag indicating whether the field has read
access. True indicates the field has read access; false
indicates it does not.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the read access flag.public void setFieldUpdateAccess(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which the update flag is being set.flag
- A boolean flag indicating whether the field has update
access. True indicates the field has update access; false
indicates it does not.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the update access flag.public void setFieldUpdateLogs(java.util.ArrayList logs)
logs
- An array list of transaction log entries.
void
- None.
public void setFlag(java.lang.String name, int mask, boolean flag) throws ObjectException
name
- The name of the field whose bit mask is being set.mask
- The bit mask indicator for the field.flag
- A boolean flag that indicates...
void
- None.
ObjectException
- Thrown if an error occurs while setting
the flag.public void setKey(ObjectKey key) throws ObjectException
key
- The value to set in the key field.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the flag.public void setKeyChangeFlag(boolean flag)
flag
- A Boolean flag indicating whether key fields were updated in
the object node. True indicates key fields were updated; false
indicates they were not.
void
- None.
public void setKeyType(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which key type flag is being setflag
- A boolean flag indicating whether the field is a key type
field. True indicates the field is a key type field; false
indicates it is not.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the key type.public void setNull(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which a null value is being set.flag
- A boolean flag indicating whether the field value is null.
Specify true to set a null value in the field; specify false
if you do not want to set a null value in the field.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the null value indicator.public void setNullable(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which a null flag is being set.flag
- A boolean flag indicating whether the field can contain a null
value. Specify true if the field can be null; specify false
if it cannot.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the null flag.public void setObjectAddAccess(boolean flag)
flag
- A Boolean flag indicating whether the object node has add
access. True indicates the object node has add access; false
indicates it does not.
void
- None.
public void setObjectDeleteAccess(boolean flag)
flag
- A Boolean flag indicating whether the object node has delete
access. True indicates the object node has delete access; false
indicates it does not.
void
- None.
public void setObjectReadAccess(boolean flag)
flag
- A Boolean flag indicating whether the object node has read
access. True indicates the object node has read access; false
indicates it does not.
void
- None.
public void setObjectUpdateAccess(boolean flag)
flag
- A Boolean flag indicating whether the object node has update
access. True indicates the object node has update access;
false indicates it does not.
void
- None.
public void setParent(ObjectNode parent)
parent
- The name of the parent object.
void
- None.
public void setRemoveFlag(boolean flag)
flag
- A boolean indicator of whether to mark the object node
for deletion. Specify true to mark the object node for
deletion; otherwise, specify false.
void
- None.
public void setSearched(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field for which the search flag is being set.flag
- A boolean indicator of whether the field is used for
searches. Specify true if the field is used for searches;
specify false if it is not.
void
- None.
ObjectException
- Thrown if an error occurs while setting
the search flag.public void setUpdateFlag(boolean flag)
flag
- A boolean indicator of whether the object node was
updated. Specify true if the object node was updated;
specify false if it was not.
void
- None.
public void setValue(java.lang.String name, java.lang.Object value) throws ObjectException
name
- The name of the field being updated.value
- The new value for the given field.
void
- None.
ObjectException
- Thrown if an error occurs while changing the
value of the field.public void setVisible(java.lang.String name, boolean flag) throws ObjectException
name
- The name of the field.flag
- A boolean indicator of whether the field is visible
on the EDM. Specify true if the field is visible; specify
false if it is not visible.
void
- None.
ObjectException
- Thrown if an error occurs while specifying
the visibility flag.public ObjectNode structCopy() throws ObjectException
ObjectNode
- A structural copy of the specified object node.
ObjectException
- Thrown if an error occurs while copying
the object node.public java.lang.String toString()
String
- A string representation of the object node.
public void unChange() throws ObjectException
void
- None.
ObjectException
- Thrown if an error occurs while reversing
the changes to the object.public void update(ObjectNode node, boolean addNewChild, boolean delMissingChild) throws ObjectException
node
- The object node that will update the existing object node.addNewChild
- A flag that indicates whether to add a new
child object from the input object node to the existing object node.
Boolean true indicates to add the new child object; false
indicates the child object should not be added.delMissingChild
- A flag that indicates whether to remove a child
object from the existing object node if it does not exist in the input
object node. Boolean true indicates to remove the missing child
object; false indicates the child object should not be removed.
void
- None.
ObjectException
- Thrown if an error occurs while updating
the object node.public void updateChild(ObjectNode child) throws ObjectException
child
- The child object to update or add.
void
- None.
ObjectException
- Thrown if an error occurs while updating the
child object.public void updateIfChanged(ObjectNode node, boolean addNewChild, boolean delMissingChild) throws ObjectException
node
- The object node that will update the existing object node.addNewChild
- A flag that indicates whether to add a new
child object from the input object node to the existing object node.
Boolean true indicates to add the new child object; false
indicates the child object should not be added.delMissingChild
- A flag that indicates whether to remove a child
object from the existing object node if it does not exist in the input
object node. Boolean true indicates to remove the missing child
object; false indicates the child object should not be removed.
void
- None.
ObjectException
- Thrown if an error occurs while updating
the object node.public void updateIfNotEqual(ObjectNode node, boolean addNewChild, boolean delMissingChild) throws ObjectException
node
- The object node that will update the existing object node.addNewChild
- A flag that indicates whether to add a new
child object from the input object node to the existing object node.
Boolean true indicates to add the new child object; false
indicates the child object should not be added.delMissingChild
- A flag that indicates whether to remove a child
object from the existing object node if it does not exist in the input
object node. Boolean true indicates to remove the missing child
object; false indicates the child object should not be removed.
void
- None.
ObjectException
- Thrown if an error occurs while updating
the object node.public void updateIfNotNull(ObjectNode node, boolean addNewChild, boolean delMissingChild) throws ObjectException
node
- The object node that will update the existing object node.addNewChild
- A flag that indicates whether to add a new
child object from the input object node to the existing object node.
Boolean true indicates to add the new child object; false
indicates the child object should not be added.delMissingChild
- A flag that indicates whether to remove a child
object from the existing object node if it does not exist in the input
object node. Boolean true indicates to remove the missing child
object; false indicates the child object should not be removed.
void
- None.
ObjectException
- Thrown if an error occurs while updating
the object node.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2007 by Sun Microsystems, Inc. All Rights Reserved.