com.filenet.wcm.toolkit.server.dp
Class CompoundDocumentDataProvider

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.WcmDpModule
              extended bycom.filenet.wcm.toolkit.server.dp.CompoundDocumentDataProvider
All Implemented Interfaces:
WcmDpModuleInterface, WcmModuleInterface

public class CompoundDocumentDataProvider
extends WcmDpModule

CompoundDocumentDataProvider provides methods to get compound document relationship objects.


Field Summary
static java.lang.String EMPTY_XML
          Empty XML String
static org.w3c.dom.Document EMPTY_XML_DOCUMENT
          Empty XML Document
static java.lang.String TYPE
          Full class name
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule
cache
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
CompoundDocumentDataProvider()
           
 
Method Summary
 void convertToCompoundDocument(java.lang.String objectStoreName, java.lang.String objectId)
          Converts a document into a compound document.
 void convertToStandardDocument(java.lang.String objectStoreName, java.lang.String objectId)
          Converts a compound document back to a standard document.
 com.filenet.api.collection.IndependentObjectSet executeObjectQuery(java.lang.String objectStoreName, com.filenet.api.query.SearchSQL searchSQL, java.lang.Integer pageSize)
          Queries the server and returns the result in an independent engine object collection
 com.filenet.api.collection.RepositoryRowSet executeRowQuery(java.lang.String objectStoreName, com.filenet.api.query.SearchSQL searchSQL, java.lang.Integer pageSize)
          Queries the server and returns the result in a repository row set collection.
 com.filenet.api.collection.ComponentRelationshipSet getChildComponentRelationships(java.lang.String objectStoreName, java.lang.String parentId, int pageSize)
          Gets the component relationship items for the specified compound document.
 com.filenet.api.meta.ClassDescription getClassDescription(java.lang.String objectStoreName, java.lang.String classId, com.filenet.api.property.PropertyFilter pf, boolean refresh)
          Returns the ClassDescription object
 java.util.Map getClassDescriptions(java.lang.String objectStoreName, java.lang.String[] classIds, com.filenet.api.property.PropertyFilter pf)
          Returns a map of class descriptions.
 com.filenet.api.core.ComponentRelationship getComponentRelationship(java.lang.String objectStoreName, java.lang.String objectId)
          Returns the component relationship object.
 com.filenet.api.core.Document getDocument(java.lang.String objectStoreName, java.lang.String documentID, boolean refresh)
          Returns the specified document.
 com.filenet.api.core.ComponentRelationship getNewComponentRelationship(java.lang.String objectStoreName, java.lang.String parentId, java.lang.String classId)
          Returns a new component relationship object.
 com.filenet.api.core.ObjectStore getObjectStore(java.lang.String objectStoreName)
          Returns the ObjectStore object
 java.util.Set getParentClassIds(java.lang.String objectStoreName, java.lang.String classId, boolean refresh)
          Returns the parent class id set.
 com.filenet.api.core.UpdatingBatch getUpdatingBatchObject(boolean refresh)
          Returns an UpdateBatch object that allows batch updating.
 boolean hasChildRelationships(java.lang.String objectStoreName, java.lang.String objectId)
          Returns true if the selected compound document has children.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule
type
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

TYPE

public static final java.lang.String TYPE
Full class name

See Also:
Constant Field Values

EMPTY_XML

public static final java.lang.String EMPTY_XML
Empty XML String

See Also:
Constant Field Values

EMPTY_XML_DOCUMENT

public static org.w3c.dom.Document EMPTY_XML_DOCUMENT
Empty XML Document

Constructor Detail

CompoundDocumentDataProvider

public CompoundDocumentDataProvider()
Method Detail

convertToCompoundDocument

public void convertToCompoundDocument(java.lang.String objectStoreName,
                                      java.lang.String objectId)
                               throws java.lang.Exception
Converts a document into a compound document.

Parameters:
objectStoreName - The object store name or id.
objectId - The document id.
Throws:
java.lang.Exception - All exceptions

convertToStandardDocument

public void convertToStandardDocument(java.lang.String objectStoreName,
                                      java.lang.String objectId)
                               throws java.lang.Exception
Converts a compound document back to a standard document.

Parameters:
objectStoreName - The object store name or id.
objectId - The document id.
Throws:
java.lang.Exception - All exceptions

hasChildRelationships

public boolean hasChildRelationships(java.lang.String objectStoreName,
                                     java.lang.String objectId)
                              throws java.lang.Exception
Returns true if the selected compound document has children.

Parameters:
objectStoreName - The object store name or id.
objectId - The docment id.
Returns:
boolean True if the selected compound document has children.
Throws:
java.lang.Exception - All Exceptions

executeRowQuery

public com.filenet.api.collection.RepositoryRowSet executeRowQuery(java.lang.String objectStoreName,
                                                                   com.filenet.api.query.SearchSQL searchSQL,
                                                                   java.lang.Integer pageSize)
                                                            throws java.lang.Exception
Queries the server and returns the result in a repository row set collection.

Parameters:
objectStoreName - The object store name or id.
searchSQL - The SearchSQL object that contains the SQL statement.
pageSize - The query page size.
Returns:
RepositoryRowCollection The query result in a repository row collection.
Throws:
java.lang.Exception - All Exceptions

executeObjectQuery

public com.filenet.api.collection.IndependentObjectSet executeObjectQuery(java.lang.String objectStoreName,
                                                                          com.filenet.api.query.SearchSQL searchSQL,
                                                                          java.lang.Integer pageSize)
                                                                   throws java.lang.Exception
Queries the server and returns the result in an independent engine object collection

Parameters:
objectStoreName - The object store name or id.
searchSQL - The SearchSQL object that contains the SQL statement.
pageSize - The query page size.
Returns:
EngineObjectCollection The query result in an engine object collection.
Throws:
java.lang.Exception - All Exceptions

getChildComponentRelationships

public com.filenet.api.collection.ComponentRelationshipSet getChildComponentRelationships(java.lang.String objectStoreName,
                                                                                          java.lang.String parentId,
                                                                                          int pageSize)
                                                                                   throws java.lang.Exception
Gets the component relationship items for the specified compound document.

Parameters:
objectStoreName - The object store name or id.
parentId - The document id.
pageSize - The maxminum number of returned items.
Returns:
ComponentRelationshipSet The set of component relationship objects.
Throws:
java.lang.Exception - All Exceptions

getComponentRelationship

public com.filenet.api.core.ComponentRelationship getComponentRelationship(java.lang.String objectStoreName,
                                                                           java.lang.String objectId)
                                                                    throws java.lang.Exception
Returns the component relationship object.

Parameters:
objectStoreName - The object store name or id.
objectId - The component relationship id.
Returns:
ComponentRelationshipSet The set of component relationship objects.
Throws:
java.lang.Exception - All Exceptions

getNewComponentRelationship

public com.filenet.api.core.ComponentRelationship getNewComponentRelationship(java.lang.String objectStoreName,
                                                                              java.lang.String parentId,
                                                                              java.lang.String classId)
                                                                       throws java.lang.Exception
Returns a new component relationship object. The new object is not saved to the server until the object save method is called.

Parameters:
objectStoreName - The object store name or id.
parentId - The document id.
classId - The component relationship class id.
Returns:
ComponentRelationshipSet The set of component relationship objects.
Throws:
java.lang.Exception - All Exceptions

getDocument

public com.filenet.api.core.Document getDocument(java.lang.String objectStoreName,
                                                 java.lang.String documentID,
                                                 boolean refresh)
                                          throws java.lang.Exception
Returns the specified document.

Parameters:
objectStoreName - The objectstore name or id.
documentID - The document id.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document The API Document object
Throws:
java.lang.Exception - If there are problems retrieving the document.

getUpdatingBatchObject

public com.filenet.api.core.UpdatingBatch getUpdatingBatchObject(boolean refresh)
                                                          throws java.lang.Exception
Returns an UpdateBatch object that allows batch updating.

Parameters:
refresh - When set to true, data will get refresh with server data after batch update.
Throws:
java.lang.Exception - All exceptions

getObjectStore

public com.filenet.api.core.ObjectStore getObjectStore(java.lang.String objectStoreName)
                                                throws java.lang.Exception
Returns the ObjectStore object

Parameters:
objectStoreName - The objectstore name or id.
Returns:
ObjectStore The API ObjectStore object
Throws:
java.lang.Exception - If there are problems retrieving the document.

getParentClassIds

public java.util.Set getParentClassIds(java.lang.String objectStoreName,
                                       java.lang.String classId,
                                       boolean refresh)
                                throws java.lang.Exception
Returns the parent class id set.

Parameters:
objectStoreName - The objectstore name or id.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
String[] The set of parent class ids.
Throws:
java.lang.Exception - If there are problems retrieving the document.

getClassDescriptions

public java.util.Map getClassDescriptions(java.lang.String objectStoreName,
                                          java.lang.String[] classIds,
                                          com.filenet.api.property.PropertyFilter pf)
                                   throws java.lang.Exception
Returns a map of class descriptions.

Parameters:
objectStoreName - The objectstore name
classIds - The class ids.
Returns:
Map A map of the API ClassDescription objects keyed by class id.
Throws:
java.lang.Exception - If there are problems retrieving the document.

getClassDescription

public com.filenet.api.meta.ClassDescription getClassDescription(java.lang.String objectStoreName,
                                                                 java.lang.String classId,
                                                                 com.filenet.api.property.PropertyFilter pf,
                                                                 boolean refresh)
                                                          throws java.lang.Exception
Returns the ClassDescription object

Parameters:
objectStoreName - The objectstore name
classId - The class id.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
ClassDescription The API ClassDescription object
Throws:
java.lang.Exception - If there are problems retrieving the document.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.