Collaboration API Documentation

com.filenet.bso.api.util
Interface BsoDataModel

All Known Subinterfaces:
BsoWriteableDataModel

public interface BsoDataModel

The BsoDataModel interface supports immutable, generic, attribute-based data model classes.

The primary use of BsoDataModel objects in the Case Management Java API is the implementation of an immutable representation of XML content. The data model SAX handler object (BsoDataModelSaxHandler) parses the XML and generates a tree of BsoDataModel objects that provide object-based access to the XML content.

See Also:
BsoDataModelFactory, BsoDataModelSaxHandler

Method Summary
 java.util.Iterator getAttributeNames()
          Returns an iterator over a collection of attribute names.
 java.lang.Object getAttributeValue(java.lang.String attributeName)
          Returns the value of a given attribute.
 java.lang.Object getAttributeValueIfAny(java.lang.String attributeName)
          Returns the value of a given attribute.
 java.util.Iterator getAttributeValues()
          Returns an iterator over a collection of attribute values.
 java.lang.String getName()
          Returns the name assigned to this BsoDataModel instance.
 

Method Detail

getAttributeNames

public java.util.Iterator getAttributeNames()
Returns an iterator over a collection of attribute names.

Returns:
A collection of attribute names.

getAttributeValues

public java.util.Iterator getAttributeValues()
Returns an iterator over a collection of attribute values.

Returns:
A collection of attribute values.

getName

public java.lang.String getName()
Returns the name assigned to this BsoDataModel instance.

Returns:
A String containing the data model name.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName)
                                   throws BsoMissingAttributeException
Returns the value of a given attribute. If a value has not been assigned to the attribute, this method returns null and throws a BsoMissingAttributeException. (Contrast this behavior with that of the getAttributeValueIfAny method.)

Returns:
A Java Object representing the attribute value. Returns null if a value has not been assigned to the attribute.

Throws:
BsoMissingAttributeException - Thrown if the specified attribute is not in the data model.

getAttributeValueIfAny

public java.lang.Object getAttributeValueIfAny(java.lang.String attributeName)
Returns the value of a given attribute. If the value has not been assigned to the attribute, this method returns null but does not throw an exception. (Contrast this behavior with that of the getAttributeValue method.)

This method will return null if the specified attribute is not in the data model, but will not throw an exception.

Returns:
A Java Object representing the attribute value. If a value has not been assigned to the attribute, returns null.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.