|
||||||||||
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.WcmSearchDataProvider
WcmSearchDataProvider provides XML data to other classes in the project. In most cases data is derived from making calls to the JavaAPI and returned as a XML Document object. Some methods implement internal caching.
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 | |
WcmSearchDataProvider()
|
Method Summary | |
static boolean |
checkForChoiceLists(org.w3c.dom.Document searchDefinition)
Deprecated. use getChoiceList() method |
static boolean |
checkForUserListProperties(org.w3c.dom.Document searchDefinition)
Deprecated. not needed |
org.w3c.dom.Document |
executeSearch(java.lang.String sSQL)
Executes SQL statement and returns results as a DOM Document. |
org.w3c.dom.Document |
getAllObjectStores(boolean refresh)
Deprecated. use WcmNavigationDataProvider.getObjectStoresDoc() method |
org.w3c.dom.Document |
getAllSearchTemplates(java.lang.String objectStoreName,
java.lang.String nameProperty,
int searchingObjectType,
boolean refresh)
Deprecated. Returns a list of all search templates found in the object store. Results are cached by the data provider. |
org.w3c.dom.Document |
getChoiceList(org.w3c.dom.Document searchUIDefinition)
Returns a DOM Document object containing choice lists for applicable "where" properties in the specified stored search. |
org.w3c.dom.Document |
getChoiceList(org.w3c.dom.Document searchUIDefinition,
org.w3c.dom.Document searchDefinition,
org.w3c.dom.Document searchResponseXML)
Returns a DOM Document object containing choice lists for applicable "where" properties in the specified stored search. |
org.w3c.dom.Document |
getChoiceList(java.lang.String objectStoreName,
java.lang.String searchID)
Deprecated. use the other getChoiceList method |
com.filenet.wcm.api.ChoiceList |
getChoiceList(java.lang.String objectStoreID,
java.lang.String cvlValueID,
int depth)
Return a property choice list by CVL value ID. |
com.filenet.wcm.api.ChoiceList |
getChoiceList(java.lang.String objectStoreName,
java.lang.String className,
java.lang.String propName)
Deprecated. Returns a ChoiceList object containing choice list for a class and property. |
org.w3c.dom.Document |
getFilterDataResults(org.w3c.dom.Document filterDataXML)
Returns an org.w3c.dom.Document of objects |
org.w3c.dom.Document |
getFilterDataResults(FilterData filterData)
Returns an org.w3c.dom.Document of objects |
java.util.List |
getMarkings(java.lang.String objectStoreName,
java.lang.String symName)
Returns a list of String[] containing 2 values. |
org.w3c.dom.Document |
getSearchDefinition(java.lang.String objectStoreName,
java.lang.String searchID)
|
org.w3c.dom.Document |
getSearchDefinition(java.lang.String objectStoreName,
java.lang.String searchID,
boolean refresh)
Returns a DOM Document object that contains the search definition. |
org.w3c.dom.Document |
getSearchDefinition(java.lang.String objectStoreName,
java.lang.String searchID,
boolean UIContentOnly,
boolean refresh)
|
java.io.InputStream |
getSearchDefinitionInputStream(java.lang.String sObjectStore,
java.lang.String sSearchID)
This method returns an InputStream object containing the definition of the stored search. |
static org.w3c.dom.Document |
getSearchRequest(java.util.Set selectProperties,
java.util.Map propertyItems,
java.util.Map verityItems,
java.util.Set excludedClasses,
int maxRecords)
Deprecated. use SearchExecuteData class to generate search request XML. This method will return null in this version. It will be removed later. |
org.w3c.dom.Document |
getSearchResults(java.lang.String sObjectStore,
java.lang.String sSearchID,
org.w3c.dom.Document oSearchResponseXML)
Deprecated. Executes a stored search, and returns the results as a DOM Document. No caching is done by this method. Same as getSearchResults(String,String,String), but takes a DOM document instead of String for response XML |
org.w3c.dom.Document |
getSearchResults(java.lang.String objectStoreName,
java.lang.String searchID,
java.lang.String searchResponseXML)
Executes a stored search, and returns the results as a DOM Document. |
java.lang.String |
getSearchResultsXML(java.lang.String objectStoreName,
java.lang.String searchID,
org.w3c.dom.Document searchResponseXML)
Executes a stored search, and returns the results as an XML String. |
void |
initialize()
Called by WcmController when the module is registered, and has access to the data store. |
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, 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, 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 WcmSearchDataProvider()
Method Detail |
public void initialize() throws java.lang.Exception
WcmModuleInterface
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
public org.w3c.dom.Document getSearchDefinition(java.lang.String objectStoreName, java.lang.String searchID, boolean refresh) throws java.lang.Exception
objectStoreName
- Object Store name or IDsearchID
- Search ID
java.lang.Exception
- If there are problems retrieving datapublic org.w3c.dom.Document getSearchDefinition(java.lang.String objectStoreName, java.lang.String searchID) throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Document getSearchDefinition(java.lang.String objectStoreName, java.lang.String searchID, boolean UIContentOnly, boolean refresh) throws java.lang.Exception
java.lang.Exception
public java.util.List getMarkings(java.lang.String objectStoreName, java.lang.String symName)
objectStoreName
- symName
- for a property description
public org.w3c.dom.Document getChoiceList(org.w3c.dom.Document searchUIDefinition) throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving datapublic org.w3c.dom.Document getChoiceList(org.w3c.dom.Document searchUIDefinition, org.w3c.dom.Document searchDefinition, org.w3c.dom.Document searchResponseXML) throws java.lang.Exception
searchUIDefinition
- The XML content from the getUIContent retrieval.searchDefinition
- The XML content from the store search getContent retrieval. The merging of choice list item will be pulling the subblasses items from this XML
inorder to get all subclasses including hidden items.searchResponseXML
- The search execute data XML.
java.lang.Exception
- If there are problems retrieving datapublic com.filenet.wcm.api.ChoiceList getChoiceList(java.lang.String objectStoreID, java.lang.String cvlValueID, int depth) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.cvlValueID
- GUID format of CVL value ID.depth
- depth of CVL values. -1 value gets all.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public com.filenet.wcm.api.ChoiceList getChoiceList(java.lang.String objectStoreName, java.lang.String className, java.lang.String propName) throws java.lang.Exception
objectStoreName
- Object Store name or IDclassName
- classpropName
- class
java.lang.Exception
- If there are problems retrieving datapublic java.io.InputStream getSearchDefinitionInputStream(java.lang.String sObjectStore, java.lang.String sSearchID) throws java.lang.Exception
sObjectStore
- Object Store name or IDsSearchID
- Search ID
java.lang.Exception
- If there are problems retrieving datapublic org.w3c.dom.Document getSearchResults(java.lang.String objectStoreName, java.lang.String searchID, java.lang.String searchResponseXML) throws java.lang.Exception
objectStoreName
- Object Store name or IDsearchID
- Search IDsearchResponseXML
- Response XML
java.lang.Exception
- If there are problems retrieving datapublic org.w3c.dom.Document executeSearch(java.lang.String sSQL) throws java.lang.Exception
sSQL
- SQL Statement
java.lang.Exception
- If there are problems executing the querypublic org.w3c.dom.Document getFilterDataResults(org.w3c.dom.Document filterDataXML) throws java.lang.Exception
filterDataXML
- XML to filter items
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getFilterDataResults(FilterData filterData) throws java.lang.Exception
filterData
- XML to filter items
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getSearchResults(java.lang.String sObjectStore, java.lang.String sSearchID, org.w3c.dom.Document oSearchResponseXML) throws java.lang.Exception
sObjectStore
- Object Store name or IDsSearchID
- Search IDoSearchResponseXML
- Response XML as DOM Document
java.lang.Exception
- If there are problems retrieving datapublic java.lang.String getSearchResultsXML(java.lang.String objectStoreName, java.lang.String searchID, org.w3c.dom.Document searchResponseXML) throws java.lang.Exception
objectStoreName
- Object Store name or IDsearchID
- Search IDsearchResponseXML
- Response XML as DOM Document
java.lang.Exception
- If there are problems retrieving datapublic org.w3c.dom.Document getAllSearchTemplates(java.lang.String objectStoreName, java.lang.String nameProperty, int searchingObjectType, boolean refresh) throws java.lang.Exception
objectStoreName
- Object Store name or IDrefresh
- A flag to refresh the cache.nameProperty
- name property for documentssearchingObjectType
- integer to indicate the objects that will be
returned by the search template. Default is 0, which means searches for
all objects will be shown. Other values are: BaseObject.TYPE_DOCUMENT, BaseObject.TYPE_FOLDER,
BaseObject.TYPE_CUSTOM_OBJECT;
java.lang.Exception
- If there are problems retrieving datapublic static org.w3c.dom.Document getSearchRequest(java.util.Set selectProperties, java.util.Map propertyItems, java.util.Map verityItems, java.util.Set excludedClasses, int maxRecords) throws java.lang.Exception
java.lang.Exception
public static boolean checkForChoiceLists(org.w3c.dom.Document searchDefinition)
public static boolean checkForUserListProperties(org.w3c.dom.Document searchDefinition)
public org.w3c.dom.Document getAllObjectStores(boolean refresh) throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Document getChoiceList(java.lang.String objectStoreName, java.lang.String searchID) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |