|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.WcmDpModule
com.filenet.wcm.toolkit.server.dp.CompoundDocumentDataProvider
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 |
public static final java.lang.String TYPE
public static final java.lang.String EMPTY_XML
public static org.w3c.dom.Document EMPTY_XML_DOCUMENT
Constructor Detail |
public CompoundDocumentDataProvider()
Method Detail |
public void convertToCompoundDocument(java.lang.String objectStoreName, java.lang.String objectId) throws java.lang.Exception
objectStoreName
- The object store name or id.objectId
- The document id.
java.lang.Exception
- All exceptionspublic void convertToStandardDocument(java.lang.String objectStoreName, java.lang.String objectId) throws java.lang.Exception
objectStoreName
- The object store name or id.objectId
- The document id.
java.lang.Exception
- All exceptionspublic boolean hasChildRelationships(java.lang.String objectStoreName, java.lang.String objectId) throws java.lang.Exception
objectStoreName
- The object store name or id.objectId
- The docment id.
java.lang.Exception
- All Exceptionspublic com.filenet.api.collection.RepositoryRowSet executeRowQuery(java.lang.String objectStoreName, com.filenet.api.query.SearchSQL searchSQL, java.lang.Integer pageSize) throws java.lang.Exception
objectStoreName
- The object store name or id.searchSQL
- The SearchSQL object that contains the SQL statement.pageSize
- The query page size.
java.lang.Exception
- All Exceptionspublic com.filenet.api.collection.IndependentObjectSet executeObjectQuery(java.lang.String objectStoreName, com.filenet.api.query.SearchSQL searchSQL, java.lang.Integer pageSize) throws java.lang.Exception
objectStoreName
- The object store name or id.searchSQL
- The SearchSQL object that contains the SQL statement.pageSize
- The query page size.
java.lang.Exception
- All Exceptionspublic com.filenet.api.collection.ComponentRelationshipSet getChildComponentRelationships(java.lang.String objectStoreName, java.lang.String parentId, int pageSize) throws java.lang.Exception
objectStoreName
- The object store name or id.parentId
- The document id.pageSize
- The maxminum number of returned items.
java.lang.Exception
- All Exceptionspublic com.filenet.api.core.ComponentRelationship getComponentRelationship(java.lang.String objectStoreName, java.lang.String objectId) throws java.lang.Exception
objectStoreName
- The object store name or id.objectId
- The component relationship id.
java.lang.Exception
- All Exceptionspublic com.filenet.api.core.ComponentRelationship getNewComponentRelationship(java.lang.String objectStoreName, java.lang.String parentId, java.lang.String classId) throws java.lang.Exception
objectStoreName
- The object store name or id.parentId
- The document id.classId
- The component relationship class id.
java.lang.Exception
- All Exceptionspublic com.filenet.api.core.Document getDocument(java.lang.String objectStoreName, java.lang.String documentID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving the document.public com.filenet.api.core.UpdatingBatch getUpdatingBatchObject(boolean refresh) throws java.lang.Exception
refresh
- When set to true, data will get refresh with server data after batch update.
java.lang.Exception
- All exceptionspublic com.filenet.api.core.ObjectStore getObjectStore(java.lang.String objectStoreName) throws java.lang.Exception
objectStoreName
- The objectstore name or id.
java.lang.Exception
- If there are problems retrieving the document.public java.util.Set getParentClassIds(java.lang.String objectStoreName, java.lang.String classId, boolean refresh) throws java.lang.Exception
objectStoreName
- The objectstore name or id.refresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving the document.public java.util.Map getClassDescriptions(java.lang.String objectStoreName, java.lang.String[] classIds, com.filenet.api.property.PropertyFilter pf) throws java.lang.Exception
objectStoreName
- The objectstore nameclassIds
- The class ids.
java.lang.Exception
- If there are problems retrieving the document.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
objectStoreName
- The objectstore nameclassId
- The class id.refresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving the document.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |