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

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.WcmNavigationDataProvider
All Implemented Interfaces:
WcmDpModuleInterface, WcmModuleInterface
Direct Known Subclasses:
RecordsManageDataProvider

public class WcmNavigationDataProvider
extends WcmDpModule

WcmNavigationDataProvider provides XML data to other classes in the project. In most cases data is derived from making calls to the Content Java API and returned as an object representing an XML string.


Field Summary
protected  int absoluteMaxResults
           
protected static java.lang.String ALL_CONTAINEES_DOC
           
protected static java.lang.String CLASS_CACHE_KEY
           
protected static java.lang.String CONTAINER_CONTENTS
           
protected static java.lang.String CONTAINER_SUBCONTAINERS
           
protected static java.lang.String CONTAINER_SUBFOLDERS
           
protected static java.lang.String CONTAINER_TYPE
           
protected static java.lang.String COUNT1_XPATH
           
protected static java.lang.String CUSTOM_OJBECT_XPATH
           
protected static java.lang.String DOCUMENT_XPATH
           
static int DOCUMENTS_DOC
           
protected static java.lang.String ELEM_WEB_SEARCH
           
static java.lang.String EMPTY_XML
          String represents empty XML response set
static int FILTER_BOTH
           
protected static java.lang.String FILTER_CLASS
           
protected static java.lang.String FILTER_CLAUSE_XPATH
           
protected static java.lang.String FILTER_FOLDERID_XPATH
           
protected static java.lang.String FILTER_INCLUDESUB_XPATH
           
protected static java.lang.String FILTER_OBJECT_STORE_NAME_XPATH
           
static int FILTER_SEARCH
           
static int FILTER_SEARCH_TEMPLATE
           
protected static java.lang.String FILTERED_OBJECT_STORES
           
protected  java.util.List filterObjectStoreList
           
protected static java.lang.String FOLDER_XPATH
           
static int FOLDERS_DOC
           
static int FOLDERS_SEARCHES_DOC
           
static int FOLDERS_SEARCHES_DOCUMENTS_DOC
           
protected static int[] nTypesCustomObjects
           
protected static int[] nTypesDocs
           
protected static int[] nTypesDocsCustomObjects
           
protected static int[] nTypesFolders
           
protected static int[] nTypesFoldersDocsSearches
           
protected static int[] nTypesFoldersDocsSearchesCustomObjects
           
protected static int[] nTypesFoldersSearches
           
protected static java.lang.String OBJECT_STORE_NAMES_KEY
           
protected static java.lang.String OBJECT_STORE_NAMES_XPATH
          Deprecated. dont use
protected static java.lang.String OBJECT_STORES_DOC_KEY
           
protected  java.lang.String sCustomObjectNameProp
           
protected  java.lang.String sDocumentNameProp
           
protected  java.lang.String sFolderNameProp
           
protected static java.lang.String[] sObjStoresPropDescs
           
protected static java.lang.String TOP_FOLDERS
           
protected static java.lang.String TOP_FOLDERS_DOC
           
static java.lang.String TYPE
          Defines the type of Data Provider
 
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
WcmNavigationDataProvider()
           
 
Method Summary
protected static java.lang.String[] addToArray(java.lang.String[] first, java.lang.String str)
           
 boolean checkAccessRights(java.lang.String objectStoreName)
           
 void clearCache()
          Deprecated. Clears all cached data
 void clearCache(java.lang.String objectStoreName, java.lang.String objectId, int mode, int objectType, java.lang.String[] parentIds)
          Clear cache according to the specified parameters.
 boolean docClassExists(java.lang.String sObjectStoreID, java.lang.String sClassGuid)
          This method verifies that the passed in doc class exists in the object store.
 org.w3c.dom.Document executeSearch(java.lang.String sql, int type)
          Executes SQL statement and returns results as a DOM Document.
 org.w3c.dom.Document filterSearch(org.w3c.dom.Document docSearches, int type)
          Exclude any folder its class id is not the same as classId.
protected  org.w3c.dom.Document getCacheValues(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bRefresh, int getType, boolean showCustomObjects)
           
protected  org.w3c.dom.Document getCacheValues2(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bRefresh, int getType, boolean showCustomObjects)
           
 java.lang.String getContainerContents(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, int[] nContentTypes, java.lang.String[] sProperties, boolean bRefresh)
          getContainerContents will return an XML string of documents that the sObjectID object has as children.
 org.w3c.dom.Document getContainerContentsDoc(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bNoBigCache, boolean bNoDocuments, boolean bRefresh, boolean showCustomObjects)
          Returns an Document of Documents contained in the sObjectId object.
protected  java.lang.String getContainerSubcontainers(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, int[] oTypes, boolean bRefresh)
           
 org.w3c.dom.Document getContainerSubcontainersAndContentsDoc(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bRefresh, boolean showCustomObjects)
          Returns an Document of subfolders or stored searches and documents.
 org.w3c.dom.Document getContainerSubcontainersDoc(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bRefresh, boolean showCustomObjects)
          Returns an Document of subfolders or stored searches.
 java.lang.String getContainerSubfolders(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bRefresh)
          getContainerSubcontainers will return an XML string of folders and stored searches that the sObjectID object has as children.
 org.w3c.dom.Document getContainerSubfoldersDoc(java.lang.String sObjectStoreID, java.lang.String sObjectID, int nObjectType, java.lang.String[] sProperties, boolean bNoBigCache, boolean bRefresh, boolean showCustomObjects)
          Returns an Document of subfolders.
 org.w3c.dom.Document getEmptyXMLDoc()
          Return a Document that contains an empty objectset.
 org.w3c.dom.Document getFolderContainees(org.w3c.dom.Document filterXML)
          Returns an Document of subfolders or stored searches and documents.
 org.w3c.dom.Document getFolderContainees(org.w3c.dom.Document filterXML, boolean refresh)
          Returns an Document of subfolders or stored searches and documents.
 org.w3c.dom.Document getFolderContainees(FilterData filterData)
          Returns an Document of subfolders or stored searches and documents.
 org.w3c.dom.Document getFolderContainees(FilterData filterData, boolean refresh)
          Returns an Document of subfolders or stored searches and documents.
 org.w3c.dom.Document getFolderContainees(FilterData filterData, int cacheTimeout)
          Returns an Document of subfolders or stored searches and documents.
 java.util.ArrayList getFolderHierarchyAsArrayList(java.lang.String objectStoreID, java.lang.String folderID)
          Walk the folder hierarchy from the specified folder up to the root folder.
 java.util.List getObjectStoreNames(boolean refresh)
          Returns a List with Object Store names available on the network
 java.lang.String getObjectStores(boolean refresh)
          Deprecated. use other form of method that returns Document object
 org.w3c.dom.Document getObjectStoresDoc(boolean bRefresh)
          Return an Document of object stores on the network.
 org.w3c.dom.Document getSearchContainees(java.lang.String objectStoreName, java.lang.String searchId, java.lang.String[] documentProps, java.lang.String[] customObjectProps, int getType, boolean refresh, boolean showCustomObjects)
           
 org.w3c.dom.Document getSearchContent(java.lang.String sObjectStore, java.lang.String sSearchID)
          Deprecated. use getSearchDefinition() method Returns a Document of TYPE_STORED_SEARCH content xml
 org.w3c.dom.Document getSearchDefinition(java.lang.String sObjectStoreID, java.lang.String sSearchID, boolean bRefresh)
          Returns a DOM Document object that contains the search definition.
 java.io.InputStream getSearchDefinitionInputStream(java.lang.String sObjectStoreID, java.lang.String sSearchID)
          This method returns an InputStream object containing the definition of the stored search.
 int getSearchingObjectType(java.lang.String sObjectStore, java.lang.String sSearchID)
          Returns a value of TYPE_STORED_SEARCH property on a stored search
 int getSearchMaxResults(java.lang.String sObjectStoreID, java.lang.String sSearchID, boolean bRefresh)
           
protected  java.lang.String getSearchXML(java.lang.String[] customProperties, java.lang.String[] documentProperties)
          Deprecated. use getSearchXML with maxResults
protected  java.lang.String getSearchXML(java.lang.String[] customProperties, java.lang.String[] documentProperties, int maxResults)
           
protected  java.lang.String getSelectPropertyXML(java.lang.String sPropertyName)
           
protected  java.lang.String getSelectPropertyXML(java.lang.String[] sProperties)
          For an array of selectProps, returns a string of
 java.lang.String getTopFolders(java.lang.String sObjectStoreID, java.lang.String[] sProperties, boolean bRefresh)
          Returns a String of the top level folders of a object store.
 org.w3c.dom.Document getTopFoldersDoc(java.lang.String sObjectStoreID, java.lang.String[] sProperties, boolean bRefresh)
          Returns an Document of the top level folders of a object store.
 org.w3c.dom.Document getTopFoldersDoc(java.lang.String sObjectStoreID, java.lang.String[] sProperties, boolean bRefresh, int maxFoldersResults)
          Returns an Document of the top level folders of a object store.
 org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String sObjectStoreID, java.lang.String[] sProperties, boolean bRefresh)
          Returns an Document of the top level folders of a object store.
 org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String sObjectStoreID, java.lang.String[] sProperties, boolean bRefresh, int maxFoldersResults)
          Returns an Document of the top level folders of a object store.
 boolean isContainerDeleted(java.lang.String Id)
          Checks the cache to see if the container has been deleteded.
 void setAbsoluteMaxResults(int absoluteMaxResults)
           
 void setFilterObjectStoreList(java.util.List newFilterObjectStoreList)
          setFilterObjectStoreList sets List of objectstores user has access to.
 void setSortParameters(java.lang.String sFolderNameProperty, java.lang.String sDocumentNameProperty, java.lang.String sCustomObjectNameProperty)
          setSortParameters sets two sort values to help in sorting of cached DOM documents.
 
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
Defines the type of Data Provider

See Also:
Constant Field Values

EMPTY_XML

public static final java.lang.String EMPTY_XML
String represents empty XML response set

See Also:
Constant Field Values

ALL_CONTAINEES_DOC

protected static final java.lang.String ALL_CONTAINEES_DOC
See Also:
Constant Field Values

OBJECT_STORES_DOC_KEY

protected static final java.lang.String OBJECT_STORES_DOC_KEY
See Also:
Constant Field Values

OBJECT_STORE_NAMES_KEY

protected static final java.lang.String OBJECT_STORE_NAMES_KEY
See Also:
Constant Field Values

FILTER_CLASS

protected static final java.lang.String FILTER_CLASS
See Also:
Constant Field Values

FILTERED_OBJECT_STORES

protected static final java.lang.String FILTERED_OBJECT_STORES
See Also:
Constant Field Values

TOP_FOLDERS_DOC

protected static final java.lang.String TOP_FOLDERS_DOC
See Also:
Constant Field Values

CONTAINER_CONTENTS

protected static final java.lang.String CONTAINER_CONTENTS
See Also:
Constant Field Values

CONTAINER_SUBCONTAINERS

protected static final java.lang.String CONTAINER_SUBCONTAINERS
See Also:
Constant Field Values

CONTAINER_SUBFOLDERS

protected static final java.lang.String CONTAINER_SUBFOLDERS
See Also:
Constant Field Values

TOP_FOLDERS

protected static final java.lang.String TOP_FOLDERS
See Also:
Constant Field Values

CLASS_CACHE_KEY

protected static final java.lang.String CLASS_CACHE_KEY
See Also:
Constant Field Values

CONTAINER_TYPE

protected static final java.lang.String CONTAINER_TYPE
See Also:
Constant Field Values

absoluteMaxResults

protected int absoluteMaxResults

FOLDERS_SEARCHES_DOC

public static final int FOLDERS_SEARCHES_DOC
See Also:
Constant Field Values

FOLDERS_DOC

public static final int FOLDERS_DOC
See Also:
Constant Field Values

DOCUMENTS_DOC

public static final int DOCUMENTS_DOC
See Also:
Constant Field Values

FOLDERS_SEARCHES_DOCUMENTS_DOC

public static final int FOLDERS_SEARCHES_DOCUMENTS_DOC
See Also:
Constant Field Values

COUNT1_XPATH

protected static final java.lang.String COUNT1_XPATH
See Also:
Constant Field Values

FOLDER_XPATH

protected static final java.lang.String FOLDER_XPATH
See Also:
Constant Field Values

CUSTOM_OJBECT_XPATH

protected static final java.lang.String CUSTOM_OJBECT_XPATH
See Also:
Constant Field Values

DOCUMENT_XPATH

protected static final java.lang.String DOCUMENT_XPATH
See Also:
Constant Field Values

OBJECT_STORE_NAMES_XPATH

protected static final java.lang.String OBJECT_STORE_NAMES_XPATH
Deprecated. dont use

See Also:
Constant Field Values

ELEM_WEB_SEARCH

protected static final java.lang.String ELEM_WEB_SEARCH
See Also:
Constant Field Values

FILTER_OBJECT_STORE_NAME_XPATH

protected static final java.lang.String FILTER_OBJECT_STORE_NAME_XPATH
See Also:
Constant Field Values

FILTER_FOLDERID_XPATH

protected static final java.lang.String FILTER_FOLDERID_XPATH
See Also:
Constant Field Values

FILTER_CLAUSE_XPATH

protected static final java.lang.String FILTER_CLAUSE_XPATH
See Also:
Constant Field Values

FILTER_INCLUDESUB_XPATH

protected static final java.lang.String FILTER_INCLUDESUB_XPATH
See Also:
Constant Field Values

sObjStoresPropDescs

protected static final java.lang.String[] sObjStoresPropDescs

nTypesFoldersDocsSearchesCustomObjects

protected static final int[] nTypesFoldersDocsSearchesCustomObjects

nTypesFoldersDocsSearches

protected static final int[] nTypesFoldersDocsSearches

nTypesFoldersSearches

protected static final int[] nTypesFoldersSearches

nTypesFolders

protected static final int[] nTypesFolders

nTypesDocs

protected static final int[] nTypesDocs

nTypesDocsCustomObjects

protected static final int[] nTypesDocsCustomObjects

nTypesCustomObjects

protected static final int[] nTypesCustomObjects

FILTER_SEARCH

public static final int FILTER_SEARCH
See Also:
Constant Field Values

FILTER_SEARCH_TEMPLATE

public static final int FILTER_SEARCH_TEMPLATE
See Also:
Constant Field Values

FILTER_BOTH

public static final int FILTER_BOTH
See Also:
Constant Field Values

sFolderNameProp

protected java.lang.String sFolderNameProp

sDocumentNameProp

protected java.lang.String sDocumentNameProp

sCustomObjectNameProp

protected java.lang.String sCustomObjectNameProp

filterObjectStoreList

protected java.util.List filterObjectStoreList
Constructor Detail

WcmNavigationDataProvider

public WcmNavigationDataProvider()
Method Detail

setAbsoluteMaxResults

public void setAbsoluteMaxResults(int absoluteMaxResults)

checkAccessRights

public boolean checkAccessRights(java.lang.String objectStoreName)
                          throws java.lang.Exception
Throws:
java.lang.Exception

getCacheValues

protected org.w3c.dom.Document getCacheValues(java.lang.String sObjectStoreID,
                                              java.lang.String sObjectID,
                                              int nObjectType,
                                              java.lang.String[] sProperties,
                                              boolean bRefresh,
                                              int getType,
                                              boolean showCustomObjects)
                                       throws java.lang.Exception
Throws:
java.lang.Exception

filterSearch

public org.w3c.dom.Document filterSearch(org.w3c.dom.Document docSearches,
                                         int type)
                                  throws java.lang.Exception
Exclude any folder its class id is not the same as classId.

Returns:
Filtered folders DOM object
Throws:
java.lang.Exception

getSearchMaxResults

public int getSearchMaxResults(java.lang.String sObjectStoreID,
                               java.lang.String sSearchID,
                               boolean bRefresh)
                        throws java.lang.Exception
Throws:
java.lang.Exception

getSearchXML

protected java.lang.String getSearchXML(java.lang.String[] customProperties,
                                        java.lang.String[] documentProperties)
                                 throws java.lang.Exception
Deprecated. use getSearchXML with maxResults

Parameters:
customProperties -
documentProperties -
Returns:
Throws:
java.lang.Exception

getSearchXML

protected java.lang.String getSearchXML(java.lang.String[] customProperties,
                                        java.lang.String[] documentProperties,
                                        int maxResults)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

getCacheValues2

protected org.w3c.dom.Document getCacheValues2(java.lang.String sObjectStoreID,
                                               java.lang.String sObjectID,
                                               int nObjectType,
                                               java.lang.String[] sProperties,
                                               boolean bRefresh,
                                               int getType,
                                               boolean showCustomObjects)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

getContainerSubcontainersAndContentsDoc

public org.w3c.dom.Document getContainerSubcontainersAndContentsDoc(java.lang.String sObjectStoreID,
                                                                    java.lang.String sObjectID,
                                                                    int nObjectType,
                                                                    java.lang.String[] sProperties,
                                                                    boolean bRefresh,
                                                                    boolean showCustomObjects)
                                                             throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get Subcontainers from
nObjectType - Object type - folder or stored search
sProperties - String array of property types to create PropertyDescription object
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
showCustomObjects - If this object is true custom objects will be returned in objectset.
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

docClassExists

public boolean docClassExists(java.lang.String sObjectStoreID,
                              java.lang.String sClassGuid)
                       throws java.lang.Exception
This method verifies that the passed in doc class exists in the object store. Used only in Integration mode.

Parameters:
sObjectStoreID - - Object Store name
sClassGuid - - GUID indentifier of the Doc Class
Returns:
Throws:
java.lang.Exception

getObjectStoresDoc

public org.w3c.dom.Document getObjectStoresDoc(boolean bRefresh)
                                        throws java.lang.Exception
Return an Document of object stores on the network.

Parameters:
bRefresh - If true, XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Object that represents an XML String
Throws:
java.lang.Exception - If there are problems.

getObjectStoreNames

public java.util.List getObjectStoreNames(boolean refresh)
                                   throws java.lang.Exception
Returns a List with Object Store names available on the network

Parameters:
refresh - a flag to refresh the results
Returns:
List of Strings containing Object Store names
Throws:
java.lang.Exception

getEmptyXMLDoc

public org.w3c.dom.Document getEmptyXMLDoc()
                                    throws java.lang.Exception
Return a Document that contains an empty objectset.

Returns:
Document Object that represents an empty set
Throws:
java.lang.Exception

getFolderHierarchyAsArrayList

public java.util.ArrayList getFolderHierarchyAsArrayList(java.lang.String objectStoreID,
                                                         java.lang.String folderID)
                                                  throws java.lang.Exception
Walk the folder hierarchy from the specified folder up to the root folder. Return as list of folders excluding the root folder.

Parameters:
objectStoreID - - String containing name of object store
folderID - - String containing specified folder
Returns:
an ArrayList of folders
Throws:
java.lang.Exception

getTopFoldersDoc

public org.w3c.dom.Document getTopFoldersDoc(java.lang.String sObjectStoreID,
                                             java.lang.String[] sProperties,
                                             boolean bRefresh)
                                      throws java.lang.Exception
Returns an Document of the top level folders of a object store.

Parameters:
sObjectStoreID - GUID of current browse object store
sProperties - Array of properties to return in set
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Object that represents an XML string
Throws:
java.lang.Exception - If there are problems.

getTopFoldersDoc

public org.w3c.dom.Document getTopFoldersDoc(java.lang.String sObjectStoreID,
                                             java.lang.String[] sProperties,
                                             boolean bRefresh,
                                             int maxFoldersResults)
                                      throws java.lang.Exception
Returns an Document of the top level folders of a object store.

Parameters:
sObjectStoreID - GUID of current browse object store
sProperties - Array of properties to return in set
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
maxFoldersResults - a maximum number of folders to be returned from the CE.
Returns:
Object that represents an XML string
Throws:
java.lang.Exception - If there are problems.

getTopFoldersSearchesDoc

public org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String sObjectStoreID,
                                                     java.lang.String[] sProperties,
                                                     boolean bRefresh)
                                              throws java.lang.Exception
Returns an Document of the top level folders of a object store.

Parameters:
sObjectStoreID - GUID of current browse object store
sProperties - Array of properties to return in set
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Document Object that represents an XML set
Throws:
java.lang.Exception - If there are problems.

getTopFoldersSearchesDoc

public org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String sObjectStoreID,
                                                     java.lang.String[] sProperties,
                                                     boolean bRefresh,
                                                     int maxFoldersResults)
                                              throws java.lang.Exception
Returns an Document of the top level folders of a object store.

Parameters:
sObjectStoreID - GUID of current browse object store
sProperties - Array of properties to return in set
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Document Object that represents an XML set
Throws:
java.lang.Exception - If there are problems.

getContainerSubcontainersDoc

public org.w3c.dom.Document getContainerSubcontainersDoc(java.lang.String sObjectStoreID,
                                                         java.lang.String sObjectID,
                                                         int nObjectType,
                                                         java.lang.String[] sProperties,
                                                         boolean bRefresh,
                                                         boolean showCustomObjects)
                                                  throws java.lang.Exception
Returns an Document of subfolders or stored searches. This will not return documents.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get Subcontainers from
nObjectType - Object type - folder or stored search
sProperties - String array of property types to create PropertyDescription object
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
showCustomObjects - If this object is true custom objects will be returned in objectset.
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getContainerSubfoldersDoc

public org.w3c.dom.Document getContainerSubfoldersDoc(java.lang.String sObjectStoreID,
                                                      java.lang.String sObjectID,
                                                      int nObjectType,
                                                      java.lang.String[] sProperties,
                                                      boolean bNoBigCache,
                                                      boolean bRefresh,
                                                      boolean showCustomObjects)
                                               throws java.lang.Exception
Returns an Document of subfolders. This method will not return documents or stored searches.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get subfolders from
nObjectType - Object Type for folder
sProperties - String array of property types to create PropertyDescription object
bNoBigCache - If this object is true, getCacheValues will not be used to get results.
bRefresh - If this object is true, XML is refreshed from server, otherwise it's retrieved from cache.
showCustomObjects - If this object is true custom objects will be returned in objectset.
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getContainerContentsDoc

public org.w3c.dom.Document getContainerContentsDoc(java.lang.String sObjectStoreID,
                                                    java.lang.String sObjectID,
                                                    int nObjectType,
                                                    java.lang.String[] sProperties,
                                                    boolean bNoBigCache,
                                                    boolean bNoDocuments,
                                                    boolean bRefresh,
                                                    boolean showCustomObjects)
                                             throws java.lang.Exception
Returns an Document of Documents contained in the sObjectId object.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get documents from
nObjectType - Object Type folder or stored search
sProperties - String array of property types to create PropertyDescription object
bNoBigCache - If this is true XML does not get FULL xml. Only needed docs returned
bNoDocuments - If this is true XML does not return any document objects.
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache. even if XML is cached for this object.
showCustomObjects - If this object is true custom objects will be returned in objectset.
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getContainerSubfolders

public java.lang.String getContainerSubfolders(java.lang.String sObjectStoreID,
                                               java.lang.String sObjectID,
                                               int nObjectType,
                                               java.lang.String[] sProperties,
                                               boolean bRefresh)
                                        throws java.lang.Exception
getContainerSubcontainers will return an XML string of folders and stored searches that the sObjectID object has as children. This will not return documents that the sObjectID object contains.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get subcontainers from
nObjectType - integer type of object (TYPE_FOLDER or TYPE_STORED_SEARCH)
sProperties - String array of property types to create PropertyDescription object
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Object that represents an XML String
Throws:
java.lang.Exception - If there are problems.

getContainerContents

public java.lang.String getContainerContents(java.lang.String sObjectStoreID,
                                             java.lang.String sObjectID,
                                             int nObjectType,
                                             int[] nContentTypes,
                                             java.lang.String[] sProperties,
                                             boolean bRefresh)
                                      throws java.lang.Exception
getContainerContents will return an XML string of documents that the sObjectID object has as children.

Parameters:
sObjectStoreID - GUID of current browse object store
sObjectID - GUID of current object to get Subcontainers from
nObjectType - integer type of Object (TYPE_FOLDER or TYPE_STORED_SEARCH)
nContentTypes - integer array of return object types
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
sProperties - String array of property types to create PropertyDescription object
Returns:
XML String
Throws:
java.lang.Exception - If there are problems.

clearCache

public void clearCache()
Deprecated. Clears all cached data


clearCache

public void clearCache(java.lang.String objectStoreName,
                       java.lang.String objectId,
                       int mode,
                       int objectType,
                       java.lang.String[] parentIds)
                throws java.lang.Exception
Clear cache according to the specified parameters. There are two possible mode values of CONTAINEE or CONTAINER defined in the CacheManager class. CONTAINER mode applies to an objectstore or folder that will have its containees cleared from cache. CONTAINEE mode applies to any object that has been added, changed or deleted. A lookup of parent folder IDs is done, and each found folder has its containees cleared.

Parameters:
objectStoreName - - The name of the objectstore.
objectId - - The object ID. If this is null, and in CONTAINER mode, the root folder of the specified objectstore is assumed.
mode - - CacheManager.CONTAINEE or CacheManager.CONTAINER.
objectType - - The object type as defined on the BaseObject class.
parentIds - - Optional. If not specified, a lookup is done to find the parent folder ID(s).
Throws:
java.lang.Exception

setFilterObjectStoreList

public void setFilterObjectStoreList(java.util.List newFilterObjectStoreList)
                              throws java.lang.Exception
setFilterObjectStoreList sets List of objectstores user has access to.

Parameters:
newFilterObjectStoreList - List of objectstores user has access to
Throws:
java.lang.Exception - If there are problems.

setSortParameters

public void setSortParameters(java.lang.String sFolderNameProperty,
                              java.lang.String sDocumentNameProperty,
                              java.lang.String sCustomObjectNameProperty)
                       throws java.lang.Exception
setSortParameters sets two sort values to help in sorting of cached DOM documents.

Parameters:
sFolderNameProperty - FolderNameProperty to sort on
sDocumentNameProperty - DocumentNameProperty to sort on
sCustomObjectNameProperty - CustomObjectNameProperty to sort on
Throws:
java.lang.Exception - If there are problems.

addToArray

protected static java.lang.String[] addToArray(java.lang.String[] first,
                                               java.lang.String str)

getTopFolders

public java.lang.String getTopFolders(java.lang.String sObjectStoreID,
                                      java.lang.String[] sProperties,
                                      boolean bRefresh)
                               throws java.lang.Exception
Returns a String of the top level folders of a object store.

Parameters:
sObjectStoreID - GUID of current browse object store
sProperties - String array of property types to create PropertyDescription object
bRefresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
Object that represents an XML string
Throws:
java.lang.Exception - If there are problems.

getContainerSubcontainers

protected java.lang.String getContainerSubcontainers(java.lang.String sObjectStoreID,
                                                     java.lang.String sObjectID,
                                                     int nObjectType,
                                                     java.lang.String[] sProperties,
                                                     int[] oTypes,
                                                     boolean bRefresh)
                                              throws java.lang.Exception
Throws:
java.lang.Exception

getObjectStores

public java.lang.String getObjectStores(boolean refresh)
                                 throws java.lang.Exception
Deprecated. use other form of method that returns Document object

Parameters:
refresh - If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
Returns:
string of XML set
Throws:
java.lang.Exception - If there are problems.

getSelectPropertyXML

protected java.lang.String getSelectPropertyXML(java.lang.String sPropertyName)

getSelectPropertyXML

protected java.lang.String getSelectPropertyXML(java.lang.String[] sProperties)
For an array of selectProps, returns a string of
Parameters:
sProperties - String array of property types to create PropertyDescription object
Returns:
string of XML set

getSearchDefinitionInputStream

public java.io.InputStream getSearchDefinitionInputStream(java.lang.String sObjectStoreID,
                                                          java.lang.String sSearchID)
                                                   throws java.lang.Exception
This method returns an InputStream object containing the definition of the stored search. No caching is done in this method.

Parameters:
sObjectStoreID - object store ID
sSearchID - Search ID
Returns:
InputStream containing the search definition in Unicode
Throws:
java.lang.Exception - If there were problems retrieving data

getSearchDefinition

public org.w3c.dom.Document getSearchDefinition(java.lang.String sObjectStoreID,
                                                java.lang.String sSearchID,
                                                boolean bRefresh)
                                         throws java.lang.Exception
Returns a DOM Document object that contains the search definition. All search definitions are cached.

Parameters:
sObjectStoreID - object store ID
sSearchID - Search ID
bRefresh - A flag to refresh the cache
Returns:
XML Document with the search definition
Throws:
java.lang.Exception - If there were problems retrieving data

getSearchingObjectType

public int getSearchingObjectType(java.lang.String sObjectStore,
                                  java.lang.String sSearchID)
                           throws java.lang.Exception
Returns a value of TYPE_STORED_SEARCH property on a stored search

Parameters:
sObjectStore - object store ID
sSearchID - Search ID
Throws:
java.lang.Exception

getSearchContent

public org.w3c.dom.Document getSearchContent(java.lang.String sObjectStore,
                                             java.lang.String sSearchID)
                                      throws java.lang.Exception
Deprecated. use getSearchDefinition() method Returns a Document of TYPE_STORED_SEARCH content xml

Parameters:
sObjectStore - object store ID
sSearchID - Search ID
Throws:
java.lang.Exception

executeSearch

public org.w3c.dom.Document executeSearch(java.lang.String sql,
                                          int type)
                                   throws java.lang.Exception
Executes SQL statement and returns results as a DOM Document. No caching is done by tihs method.

Parameters:
sql - SQL Statement
Returns:
XML Document with the results in ADO format
Throws:
java.lang.Exception - If there are problems executing the query

getSearchContainees

public org.w3c.dom.Document getSearchContainees(java.lang.String objectStoreName,
                                                java.lang.String searchId,
                                                java.lang.String[] documentProps,
                                                java.lang.String[] customObjectProps,
                                                int getType,
                                                boolean refresh,
                                                boolean showCustomObjects)
                                         throws java.lang.Exception
Throws:
java.lang.Exception

getFolderContainees

public org.w3c.dom.Document getFolderContainees(org.w3c.dom.Document filterXML,
                                                boolean refresh)
                                         throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
filterXML - XML to filter containees
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getFolderContainees

public org.w3c.dom.Document getFolderContainees(FilterData filterData,
                                                boolean refresh)
                                         throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
filterData - object to filter containees
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getFolderContainees

public org.w3c.dom.Document getFolderContainees(org.w3c.dom.Document filterXML)
                                         throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
filterXML - XML to filter containees
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getFolderContainees

public org.w3c.dom.Document getFolderContainees(FilterData filterData,
                                                int cacheTimeout)
                                         throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
filterData - object to filter containees
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

getFolderContainees

public org.w3c.dom.Document getFolderContainees(FilterData filterData)
                                         throws java.lang.Exception
Returns an Document of subfolders or stored searches and documents.

Parameters:
filterData - object to filter containees
Returns:
Document of contents
Throws:
java.lang.Exception - If there are problems.

isContainerDeleted

public boolean isContainerDeleted(java.lang.String Id)
Checks the cache to see if the container has been deleteded.

Parameters:
Id -
Returns:
true if the cache knows that the container has been deleted.


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