Collaboration API Documentation

Package com.filenet.bso.api.util

This package contains various utility classes, interfaces, and exception classes.

See:
          Description

Interface Summary
BsoConfigManager Classes that implement the BsoConfigManager interface provide access to configuration data.
BsoContentBinder Classes that implement the BsoContentBinder interface encapsulate support for marshaling and unmarshaling of XML content to and from Java objects.
BsoDataModel The BsoDataModel interface supports immutable, generic, attribute-based data model classes.
BsoDataModelSaxHandler The BsoDataModelSaxHandler interface is implemented by objects that parse XML content and generate a tree of BsoDataModel objects.
BsoElement Interface of common fields and methods in all upper-level elements of the content.
BsoElements The BsoElements interface aids in manipulating the upper-level elements of the content (manifest information).
BsoLinkableObject  
BsoPersistentBaseObject  
BsoPersistentDataContainer Classes that implement the BsoPersistentDataContainer interface provide functionality similar to the java.util.Properties Java class, but the property data is persisted to the FileNet Content Engine.
BsoPropertyMap The BsoPropertyMap interface provides a simple map object in which both property keys and values are limited to string values.
BsoUID BsoUID objects are used to generate universally unique identifiers.
BsoWorkflow Classes that implement the BsoWorkflow interface represent FileNet eProcess workflows.
BsoWriteableDataModel Classes that implement the BsoWriteableDataModel interface provide write access to BsoDataModel objects.
BsoXMLGenerator Classes that implement the BsoXMLGenerator interface are used by the Case Management Java API to generate XML.
BsoXMLMarshal Classes implement the BsoXMLMarshal interface to support marshaling Java classes into XML content.
 

Class Summary
BooleanRef This class is used so a boolean value can be returned in a parameter that is passed as an argument.
BsoAnnotation This class is basically a duplicate from com.filenet.wcm.apps.server.util.annotations.WcmAnnotation except that we added the getNewAnnotation(String id) method.
BsoBaseUtil The BsoBaseUtil class provides a collection of static helper methods for the Content Java API.
BsoByteArrayWithCharset Class to convert a byte array into a string with appropriate "guessing" used to deduce the proper charset if one is not known when an instance is constructed.
BsoDataModelFactory The BsoDataModelFactory class creates BsoDataModel objects.
BsoDateUtil This class provides date conversion methods.
BsoEProcessUtil The BsoEProcessUtil class provides a set of static helper methods for the Process Java API.
BsoGenericSAXHandler The BsoGenericSAXHandlerclass marshals XML content into Java classes.
BsoLinkableUtil  
BsoLog Utility class that wraps a log4j Logger instance with static methods.
BsoObjectUtil The BsoObjectUtil class provides a set of static helper methods for creating Java objects via reflection.
BsoParameter The BsoParameter class provides a set of static helper methods that perform parameter validation.
BsoPCH Provides static utility methods for reporting various statistics into FileNET Performance Clearinghouse (PCH)/ P8 System Manager.
BsoPersistentDataContainerFactory The BsoPersistentDataContainerFactory creates instances of the BsoPersistentDataContainerImpl class that implements the BsoPersistentDataContainer interface.
BsoSAXHelper  
BsoSearch This class encapsulates ad hoc Content Engine queries and returns the results as raw XML or Document Object Model (DOM) for the search.
BsoSearchResultRow An instance of this class represents a row of some search results.
BsoSearchResultsClassData An instance of this class provides information about a class represented in some search results.
BsoSearchResultsXMLReader This class parses Search Results XML, in the format returned from a Search.execute() call, and returns the data as BsoSearchResultRow objects.
BsoUtilFactory The BsoUtilFactory object creates the Case Management Java API utility objects: BsoUID and BsoPropertyMap.
BsoXMLBinder The BsoXMLBinder class manages unmarshaling XML content into Java classes, and marshaling Java classes into XML content.
BsoXMLSerializer  
BsoXMLUnmarshal The BsoXMLUnmarshal class supports the unmarshaling of XML content into Java classes.
BsoXMLUtil Utility class for working with XML and DOM.
BsoXMLWriter The BsoXMLWriter class provides helper methods to produce well-formed XML output.
BsoXPathDef The BsoXPathDef class provides information used by the BsoGenericSAXHandler class to generate Java classes from XML elements.
Encrypt  
 

Exception Summary
BsoAuthenticationFailedException Thrown when user authentication fails.
BsoDuplicateFolderNameException This checked exception is thrown when an attempt is made to create a case file with a non-unique folder name.
BsoException The base class for Case Management Java API checked exceptions.
BsoInsufficientPermissionException Unchecked exception thrown when a user attempts to access an object which either does not exist or for which they do not have the security rights.
BsoMissingAttributeException Thrown when an attempt is made to retrieve an attribute value whose attribute key is not present in the object.
BsoMissingPropertyException Thrown when a read or write operation is attempted on a property that is not a valid property of the object.
BsoPublishingInProgressException Checked exception thrown when attempting to start a publishing operation on a document where a publishing operation is already in-progress.
BsoPublishingTerminatedException Checked exception thrown when a publishing operation has been terminated.
BsoRuntimeException Base class for Case Management Java API unchecked runtime exceptions.
BsoSecurityException Base class for Case Management Java API unchecked runtime exceptions.
BsoUpdateFailedException Thrown when an attempt is made to update one of the upper-level elements of the persistent content with stale, out-of-date data.
BsoXMLParsingException Thrown when an error occurs during parsing of XML content.
ClbOpMissingEmailException The Collaboration (workflow) Operations checked exception for when a user's email address is undefined.
CollaborationOperationException The base class for Collaboration (workflow) Operations checked exceptions.
 

Package com.filenet.bso.api.util Description

This package contains various utility classes, interfaces, and exception classes.


Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.