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

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
                  extended bycom.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider
All Implemented Interfaces:
WcmDpModuleInterface, WcmModuleInterface

public class RecordsManageDataProvider
extends WcmNavigationDataProvider


Field Summary
protected  java.lang.String baseLocalPath
           
static int CONTENTTYPE_CUSTOMOBJECT
           
static int CONTENTTYPE_DOCUMENT
           
static int CONTENTTYPE_FOLDER
           
static int CONTENTTYPE_STORED_SEARCH
           
static java.lang.String FALSE
           
protected  java.util.Map objectStoresMap
           
static int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
          Defines the user or group search attribute type display name.
static int PRINCIPAL_SEARCH_ATTR_NONE
          Defines the user or group search attribute type none.
static int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
          Defines the user or group search attribute type short name.
static int PRINCIPAL_SEARCH_SORT_ASCENDING
          Defines the user or group sort type ascending.
static int PRINCIPAL_SEARCH_SORT_DESCENDING
          Defines the user or group sort type descending.
static int PRINCIPAL_SEARCH_SORT_NONE
          Defines the user or group sort type none.
static int PRINCIPAL_SEARCH_TYPE_CONTAINS
          Defines the user or group search type contains.
static int PRINCIPAL_SEARCH_TYPE_CUSTOM
          Defines the user or group search type custom.
static int PRINCIPAL_SEARCH_TYPE_EXACT
          Defines the user or group search type exact.
static int PRINCIPAL_SEARCH_TYPE_NONE
          Defines the user or group search type none.
static int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
          Defines the user or group search type prefix match.
static int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
          Defines the user or group search type suffix match.
static java.lang.String PROPERTY_STATE_MODIFIED
          Property state values 1 means the property has been modified 2 means the property has been modified but not yet validated - this value is currently used only on date properties.
static java.lang.String PROPERTY_STATE_NOT_VALIDATED
           
static java.lang.String RM_OBJECT_STORES_DOC_KEY
           
static java.lang.String[] RM_PROPERTIES
           
static int STATE_CLEAR_EXCEPTION
          Value of 4194304; clear document lifecycle exception state.
static int STATE_DEMOTE
          Value of 2097152; demote document lifecycle to previous state.
static int STATE_PROMOTE
          Value of 1048576; promote document lifecycle to next state.
static int STATE_RESET
          Value of 5242880; reset a new version of the document to the initial state.
static int STATE_SET_EXCEPTION
          Value of 3145728; set document lifecycle exception state (when a document is in an exception state, the document can neither be promoted nor demoted.)
static java.lang.String TRUE
           
static java.lang.String TYPE
          Records Manager Data Provider type.
static int TYPE_CLASSDESCRIPTION
          Integer representing a ClassDescription object.
static int TYPE_CUSTOMOBJECT
          Integer representing a CustomObject object type.
static int TYPE_DOCUMENT
          Integer representing a Document object type.
static int TYPE_EMAILRECORD
          Value of 302; a email record type.
static int TYPE_FOLDER
          Integer representing a Folder object.
static int TYPE_LINK
          Integer representing a Link type.
static int TYPE_MARKER
          Value of 303; a marker record type.
static int TYPE_OBJECT_STORE
          Integer representing a objectStore object.
static int TYPE_PUBLISH_TEMPLATE
          Integer representing a PublishTemplate object.
static int TYPE_RECORDINFO
          Value of 300; This is the root class of Records Manager classes.
static int TYPE_SECURITY_POLICY
          Integer representing a SecurityPolicy object.
static int TYPE_STORED_SEARCH
          Integer representing a StoredSearch object.
static int TYPE_VERSIONSERIES
          Integer representing a VersionSeries object.
static int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
          Integer representing a Workflow Subscription type.
static int TYPE_WORKFLOWDEFINITION
          Integer representing a Workflow Definition type.
protected  WcmAuthoringUtil xmlUtil
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider
absoluteMaxResults, ALL_CONTAINEES_DOC, CLASS_CACHE_KEY, CONTAINER_CONTENTS, CONTAINER_SUBCONTAINERS, CONTAINER_SUBFOLDERS, CONTAINER_TYPE, COUNT1_XPATH, CUSTOM_OJBECT_XPATH, DOCUMENT_XPATH, DOCUMENTS_DOC, ELEM_WEB_SEARCH, EMPTY_XML, FILTER_BOTH, FILTER_CLASS, FILTER_CLAUSE_XPATH, FILTER_FOLDERID_XPATH, FILTER_INCLUDESUB_XPATH, FILTER_OBJECT_STORE_NAME_XPATH, FILTER_SEARCH, FILTER_SEARCH_TEMPLATE, FILTERED_OBJECT_STORES, filterObjectStoreList, FOLDER_XPATH, FOLDERS_DOC, FOLDERS_SEARCHES_DOC, FOLDERS_SEARCHES_DOCUMENTS_DOC, nTypesCustomObjects, nTypesDocs, nTypesDocsCustomObjects, nTypesFolders, nTypesFoldersDocsSearches, nTypesFoldersDocsSearchesCustomObjects, nTypesFoldersSearches, OBJECT_STORE_NAMES_KEY, OBJECT_STORE_NAMES_XPATH, OBJECT_STORES_DOC_KEY, sCustomObjectNameProp, sDocumentNameProp, sFolderNameProp, sObjStoresPropDescs, TOP_FOLDERS, TOP_FOLDERS_DOC
 
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
RecordsManageDataProvider()
          WcmAuthoringDataProvider Constructor
RecordsManageDataProvider(java.lang.String name)
          RecordsManageDataProvider Constructor
 
Method Summary
protected  boolean checkParam(java.lang.Object o)
          Make sure object is not null and has some value.
protected  com.filenet.wcm.api.Values createMultiValues(org.w3c.dom.Node multiValues, int type)
          Create a JavaAPI's Values from XML node list.
protected  com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList)
          Create a JavaAPI's Permissions from XML node list Each node must have children nodes of GRANTEENAME, GRANTETYPE, ACCESSTYPE, ACCESS with or without STATE If State is specified and its value is WcmSecurityUtil.REMOVED then we don't send back those node to signal it has been removed from permission list.
protected  com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName, org.w3c.dom.NodeList propertiesNodeList)
          Create a JavaAPI's Properties from XML node list Each node must have children nodes of SYMNAME, STATE, and VALUE/VALUES We only pick node that has state marked as modify to avoid problem of sending back read only property.
 com.filenet.rm.api.RecordInfo DeclareAsRecord(java.lang.String objectStoreID, java.lang.String[] docIDs, java.lang.String filePlanObjectStoreID, java.lang.String[] folderIDs, org.w3c.dom.Document properties, org.w3c.dom.Document permissions, java.lang.String recordInfoClassID, boolean autoName)
           
protected  java.lang.String getAuthenticatedUserShortName()
          Return the authenticated user short name
 java.lang.String getClassificationSchemeRootPath(java.lang.String objectStoreID)
          Return the classificaiton root path from rmos
 org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, boolean refresh)
          Return the specified class's property description collection.
 org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, java.lang.String[] props, boolean refresh)
          Return the specified class's property description collection.
protected  java.lang.String getConnectorId(java.lang.String objectStoreID)
           
 java.lang.String getDocumentTitle(java.lang.String objectStoreID, java.lang.String classID, java.lang.String rmFolderId)
          Return the document title after applied container defined pattern to it.
 org.w3c.dom.Document getEmptyXMLDoc()
          Return a Document that contains an empty objectset.
 org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int rmType, boolean refresh)
          Return specified object type's classes from object store.
 org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID, int objectType, boolean refresh)
          Return the specified object store's object type property description collection.
 org.w3c.dom.Document getObjectStoresDoc(boolean refresh)
          Return an org.w3c.dom.Document of object stores on the network.
 org.w3c.dom.Document getObjectStoresDoc(boolean refresh, java.lang.String filterClassId)
          Return an org.w3c.dom.Document of object stores on the network.
protected  com.filenet.wcm.api.Permissions getPermissionsFromXML(org.w3c.dom.Document perms, java.lang.String collectionType)
          Pack permission nodes into JavaAPI absorbable Permissions collection.
protected  com.filenet.wcm.api.Permissions getPermissionsFromXML(java.lang.String key, java.lang.String collectionType)
          Pack permission nodes into JavaAPI absorbable Permissions collection.
protected  com.filenet.wcm.api.Properties getPropertiesFromXML(org.w3c.dom.Document props)
          Pack property nodes into JavaAPI absorbable Properties collection.
protected  com.filenet.wcm.api.Properties getPropertiesFromXML(java.lang.String key)
          Pack property nodes into JavaAPI absorbable Properties collection.
protected  com.filenet.rm.api.util.RMUtil getRMUtil()
          Deprecated. - use RMUtil static method instead
 org.w3c.dom.Document getTopFoldersDoc(java.lang.String objectStoreID, java.lang.String[] properties, boolean refresh)
          Returns an org.w3c.dom.Document of the top level folders of a object store.
 org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String objectStoreID, java.lang.String[] properties, boolean refresh)
          Returns an org.w3c.dom.Document of the top level folders of a object store.
protected  java.lang.String getUrl(java.lang.String connectorID, java.lang.String[] documentIDs)
           
protected  org.w3c.dom.Document getXMLDocument(java.lang.String xml, java.lang.String key)
          Pack XML string into a Document object and cache it into module property bag to speed up future data retrival time.
protected  org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml, java.lang.String key)
          Pack XML string into a Document object and cache it into class property bag to speed up future data retrival time.
 boolean isObjectStoreBaseType(java.lang.String objectStoreID)
           
 boolean isObjectStoreHasChap4Properties(java.lang.String objectStoreID)
           
protected  com.filenet.rm.api.RMFolder[] removeFirst(com.filenet.rm.api.RMFolder[] inArray)
           
 void setFilePlanObjectStores(java.util.Map map)
          This map contains object store name which support file plan
protected  void setValue(com.filenet.wcm.api.Property p, java.lang.Object value)
          Set a value based by object data type in Property object.
protected  void setValue(com.filenet.wcm.api.Property p, java.lang.String value, int type, java.lang.String objectStoreName, int objectType)
          Set a value based by data type in property object.
protected  void setValue(com.filenet.wcm.api.Value p, java.lang.String value, int type)
          Set a value based by data type in Value object.
 
Methods inherited from class com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider
addToArray, checkAccessRights, clearCache, clearCache, docClassExists, executeSearch, filterSearch, getCacheValues, getCacheValues2, getContainerContents, getContainerContentsDoc, getContainerSubcontainers, getContainerSubcontainersAndContentsDoc, getContainerSubcontainersDoc, getContainerSubfolders, getContainerSubfoldersDoc, getFolderContainees, getFolderContainees, getFolderContainees, getFolderContainees, getFolderContainees, getFolderHierarchyAsArrayList, getObjectStoreNames, getObjectStores, getSearchContainees, getSearchContent, getSearchDefinition, getSearchDefinitionInputStream, getSearchingObjectType, getSearchMaxResults, getSearchXML, getSearchXML, getSelectPropertyXML, getSelectPropertyXML, getTopFolders, getTopFoldersDoc, getTopFoldersSearchesDoc, isContainerDeleted, setAbsoluteMaxResults, setFilterObjectStoreList, setSortParameters
 
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
Records Manager Data Provider type.

See Also:
Constant Field Values

TYPE_DOCUMENT

public static final int TYPE_DOCUMENT
Integer representing a Document object type. Value is 1.

See Also:
Constant Field Values

TYPE_FOLDER

public static final int TYPE_FOLDER
Integer representing a Folder object. Value is 2.

See Also:
Constant Field Values

TYPE_OBJECT_STORE

public static final int TYPE_OBJECT_STORE
Integer representing a objectStore object. Value is 4.

See Also:
Constant Field Values

TYPE_CLASSDESCRIPTION

public static final int TYPE_CLASSDESCRIPTION
Integer representing a ClassDescription object. Value is 25.

See Also:
Constant Field Values

TYPE_STORED_SEARCH

public static final int TYPE_STORED_SEARCH
Integer representing a StoredSearch object. Value is -100.

See Also:
Constant Field Values

TYPE_SECURITY_POLICY

public static final int TYPE_SECURITY_POLICY
Integer representing a SecurityPolicy object. Value is 1170.

See Also:
Constant Field Values

TYPE_PUBLISH_TEMPLATE

public static final int TYPE_PUBLISH_TEMPLATE
Integer representing a PublishTemplate object. Value is -101.

See Also:
Constant Field Values

TYPE_VERSIONSERIES

public static final int TYPE_VERSIONSERIES
Integer representing a VersionSeries object. Value is 1140.

See Also:
Constant Field Values

TYPE_CUSTOMOBJECT

public static final int TYPE_CUSTOMOBJECT
Integer representing a CustomObject object type. Value is 15.

See Also:
Constant Field Values

TYPE_WORKFLOW_CLASS_SUBSCRIPTION

public static final int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
Integer representing a Workflow Subscription type. Value is 1166.

See Also:
Constant Field Values

TYPE_WORKFLOWDEFINITION

public static final int TYPE_WORKFLOWDEFINITION
Integer representing a Workflow Definition type. Value is 1160.

See Also:
Constant Field Values

TYPE_LINK

public static final int TYPE_LINK
Integer representing a Link type. Value is 1156.

See Also:
Constant Field Values

STATE_PROMOTE

public static final int STATE_PROMOTE
Value of 1048576; promote document lifecycle to next state.

See Also:
Constant Field Values

STATE_DEMOTE

public static final int STATE_DEMOTE
Value of 2097152; demote document lifecycle to previous state.

See Also:
Constant Field Values

STATE_SET_EXCEPTION

public static final int STATE_SET_EXCEPTION
Value of 3145728; set document lifecycle exception state (when a document is in an exception state, the document can neither be promoted nor demoted.)

See Also:
Constant Field Values

STATE_CLEAR_EXCEPTION

public static final int STATE_CLEAR_EXCEPTION
Value of 4194304; clear document lifecycle exception state.

See Also:
Constant Field Values

STATE_RESET

public static final int STATE_RESET
Value of 5242880; reset a new version of the document to the initial state.

See Also:
Constant Field Values

TYPE_EMAILRECORD

public static final int TYPE_EMAILRECORD
Value of 302; a email record type.

See Also:
Constant Field Values

TYPE_RECORDINFO

public static final int TYPE_RECORDINFO
Value of 300; This is the root class of Records Manager classes.

See Also:
Constant Field Values

TYPE_MARKER

public static final int TYPE_MARKER
Value of 303; a marker record type.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_NONE

public static final int PRINCIPAL_SEARCH_TYPE_NONE
Defines the user or group search type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_CUSTOM

public static final int PRINCIPAL_SEARCH_TYPE_CUSTOM
Defines the user or group search type custom.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH

public static final int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
Defines the user or group search type prefix match.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH

public static final int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
Defines the user or group search type suffix match.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_CONTAINS

public static final int PRINCIPAL_SEARCH_TYPE_CONTAINS
Defines the user or group search type contains.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_EXACT

public static final int PRINCIPAL_SEARCH_TYPE_EXACT
Defines the user or group search type exact.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_NONE

public static final int PRINCIPAL_SEARCH_SORT_NONE
Defines the user or group sort type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_ASCENDING

public static final int PRINCIPAL_SEARCH_SORT_ASCENDING
Defines the user or group sort type ascending.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_DESCENDING

public static final int PRINCIPAL_SEARCH_SORT_DESCENDING
Defines the user or group sort type descending.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_NONE

public static final int PRINCIPAL_SEARCH_ATTR_NONE
Defines the user or group search attribute type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_SHORT_NAME

public static final int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
Defines the user or group search attribute type short name.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME

public static final int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
Defines the user or group search attribute type display name.

See Also:
Constant Field Values

RM_OBJECT_STORES_DOC_KEY

public static final java.lang.String RM_OBJECT_STORES_DOC_KEY
See Also:
Constant Field Values

PROPERTY_STATE_MODIFIED

public static final java.lang.String PROPERTY_STATE_MODIFIED
Property state values 1 means the property has been modified 2 means the property has been modified but not yet validated - this value is currently used only on date properties. Once validated, it is changed to a 1 or modified state.

See Also:
Constant Field Values

PROPERTY_STATE_NOT_VALIDATED

public static final java.lang.String PROPERTY_STATE_NOT_VALIDATED
See Also:
Constant Field Values

TRUE

public static final java.lang.String TRUE
See Also:
Constant Field Values

FALSE

public static final java.lang.String FALSE
See Also:
Constant Field Values

CONTENTTYPE_FOLDER

public static final int CONTENTTYPE_FOLDER
See Also:
Constant Field Values

CONTENTTYPE_DOCUMENT

public static final int CONTENTTYPE_DOCUMENT
See Also:
Constant Field Values

CONTENTTYPE_CUSTOMOBJECT

public static final int CONTENTTYPE_CUSTOMOBJECT
See Also:
Constant Field Values

CONTENTTYPE_STORED_SEARCH

public static final int CONTENTTYPE_STORED_SEARCH
See Also:
Constant Field Values

RM_PROPERTIES

public static final java.lang.String[] RM_PROPERTIES

objectStoresMap

protected java.util.Map objectStoresMap

baseLocalPath

protected java.lang.String baseLocalPath

xmlUtil

protected WcmAuthoringUtil xmlUtil
Constructor Detail

RecordsManageDataProvider

public RecordsManageDataProvider()
                          throws java.lang.Exception
WcmAuthoringDataProvider Constructor

Throws:
java.lang.Exception

RecordsManageDataProvider

public RecordsManageDataProvider(java.lang.String name)
                          throws java.lang.Exception
RecordsManageDataProvider Constructor

Parameters:
name - Module name
Throws:
java.lang.Exception
Method Detail

getObjectStoresDoc

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

Parameters:
refresh - If true, XML is refreshed from server, otherwise it's retrieved from cache.
filterClassId - a class description GUID. Only objectstores containing this class guid will be included.
Returns:
Object that represents an XML String
Throws:
java.lang.Exception - If there are problems.

getObjectStoresDoc

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

Overrides:
getObjectStoresDoc in class WcmNavigationDataProvider
Parameters:
refresh - 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.

getTopFoldersDoc

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

Overrides:
getTopFoldersDoc in class WcmNavigationDataProvider
Parameters:
objectStoreID - GUID of current browse object store
properties - Array of properties to return in set
refresh - 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.

getTopFoldersSearchesDoc

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

Overrides:
getTopFoldersSearchesDoc in class WcmNavigationDataProvider
Parameters:
objectStoreID - GUID of current browse object store
properties - Array of properties to return in set
refresh - 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.

getObjectStoreClasses

public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID,
                                                  int rmType,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return specified object type's classes from object store. Cached data will be stored in module property bag identified by DOC_CLASSES + objectStoreID + objectType.

Parameters:
objectStoreID - GUID format of Object Store ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getClassProperties

public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID,
                                               java.lang.String classID,
                                               boolean refresh)
                                        throws java.lang.Exception
Return the specified class's property description collection. If the properties have choices, the property descriptions will contain the first level of choice values. Cached data will be stored in module property bag identified by CLASS_PROPS + objectStoreID + classID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classID - GUID format of Class ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getDocumentTitle

public java.lang.String getDocumentTitle(java.lang.String objectStoreID,
                                         java.lang.String classID,
                                         java.lang.String rmFolderId)
                                  throws java.lang.Exception
Return the document title after applied container defined pattern to it.

Parameters:
objectStoreID - GUID format of Object Store ID.
classID - GUID format of Class ID.
rmFolderId - Container (primary classification)
Returns:
Class's property description XML
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getClassificationSchemeRootPath

public java.lang.String getClassificationSchemeRootPath(java.lang.String objectStoreID)
                                                 throws java.lang.Exception
Return the classificaiton root path from rmos

Parameters:
objectStoreID - GUID format of Object Store ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getClassProperties

public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID,
                                               java.lang.String classID,
                                               java.lang.String[] props,
                                               boolean refresh)
                                        throws java.lang.Exception
Return the specified class's property description collection. If the properties have choices, the property descriptions will contain the first level of choice values. Cached data will be stored in module property bag identified by CLASS_PROPS + objectStoreID + classID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classID - GUID format of Class ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getObjectStorePropertyDescriptions

public org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID,
                                                               int objectType,
                                                               boolean refresh)
                                                        throws java.lang.Exception
Return the specified object store's object type property description collection. If the properties have choices, the property descriptions will contain the first level of choice values. Cached data will be stored in module property bag identified by CLASS_PROPS + objectStoreID + objectType.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectType - Type of class descriptions to return, for example, document, folder or stored search.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

isObjectStoreHasChap4Properties

public boolean isObjectStoreHasChap4Properties(java.lang.String objectStoreID)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

isObjectStoreBaseType

public boolean isObjectStoreBaseType(java.lang.String objectStoreID)
                              throws java.lang.Exception
Throws:
java.lang.Exception

DeclareAsRecord

public com.filenet.rm.api.RecordInfo DeclareAsRecord(java.lang.String objectStoreID,
                                                     java.lang.String[] docIDs,
                                                     java.lang.String filePlanObjectStoreID,
                                                     java.lang.String[] folderIDs,
                                                     org.w3c.dom.Document properties,
                                                     org.w3c.dom.Document permissions,
                                                     java.lang.String recordInfoClassID,
                                                     boolean autoName)
                                              throws java.lang.Exception
Throws:
java.lang.Exception

removeFirst

protected com.filenet.rm.api.RMFolder[] removeFirst(com.filenet.rm.api.RMFolder[] inArray)

getConnectorId

protected java.lang.String getConnectorId(java.lang.String objectStoreID)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

getUrl

protected java.lang.String getUrl(java.lang.String connectorID,
                                  java.lang.String[] documentIDs)
                           throws java.lang.Exception
Throws:
java.lang.Exception

getAuthenticatedUserShortName

protected java.lang.String getAuthenticatedUserShortName()
                                                  throws java.lang.Exception
Return the authenticated user short name

Returns:
String The authenticated user short name
Throws:
java.lang.Exception - If there are problems retrieving the authenticated user.

createProperties

protected com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName,
                                                          org.w3c.dom.NodeList propertiesNodeList)
                                                   throws java.lang.Exception
Create a JavaAPI's Properties from XML node list Each node must have children nodes of SYMNAME, STATE, and VALUE/VALUES We only pick node that has state marked as modify to avoid problem of sending back read only property.

Parameters:
objectStoreName - Object Store Name for Object Valued Properties.
propertiesNodeList - Property XML node.
Returns:
Properties JavaAPI's Properties collection. Null means operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

createMultiValues

protected com.filenet.wcm.api.Values createMultiValues(org.w3c.dom.Node multiValues,
                                                       int type)
                                                throws java.lang.Exception
Create a JavaAPI's Values from XML node list.

Parameters:
multiValues - Value XML node.
type - multiValues object type.
Returns:
Values JavaAPI's Values collection.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setValue

protected void setValue(com.filenet.wcm.api.Property p,
                        java.lang.String value,
                        int type,
                        java.lang.String objectStoreName,
                        int objectType)
                 throws java.lang.Exception
Set a value based by data type in property object.

Parameters:
p - Property object which will be set a new value.
value - Value in string format.
type - Data type; String, Integer...
objectStoreName - Object Store Name where the object resides.
objectType - Object type to retrieve for object property.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setValue

protected void setValue(com.filenet.wcm.api.Value p,
                        java.lang.String value,
                        int type)
                 throws java.lang.Exception
Set a value based by data type in Value object.

Parameters:
p - Value object which will be set a new value.
value - Value in string format.
type - Data type; String, Integer...
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setValue

protected void setValue(com.filenet.wcm.api.Property p,
                        java.lang.Object value)
                 throws java.lang.Exception
Set a value based by object data type in Property object.

Parameters:
p - Property object which will be set a new value.
value - Value object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

createPermissions

protected com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList)
                                                     throws java.lang.Exception
Create a JavaAPI's Permissions from XML node list Each node must have children nodes of GRANTEENAME, GRANTETYPE, ACCESSTYPE, ACCESS with or without STATE If State is specified and its value is WcmSecurityUtil.REMOVED then we don't send back those node to signal it has been removed from permission list. Without those node from begin achieve same goal.

Parameters:
permissionsNodeList - Permissions XML node.
Returns:
Permissions JavaAPI's Permissions collection. Null means operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPermissionsFromXML

protected com.filenet.wcm.api.Permissions getPermissionsFromXML(org.w3c.dom.Document perms,
                                                                java.lang.String collectionType)
                                                         throws java.lang.Exception
Pack permission nodes into JavaAPI absorbable Permissions collection. The input parameter of key let us know whether a XML object already exist in Module property bag. If not then a empty Permissions will be created to return back. JavaAPI don't like null Permissions.

Parameters:
perms - XML object.
collectionType - Property.RESERVATION_PERMISSIONS or Property.
Returns:
Permissions JavaAPI's Permissions collection.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPermissionsFromXML

protected com.filenet.wcm.api.Permissions getPermissionsFromXML(java.lang.String key,
                                                                java.lang.String collectionType)
                                                         throws java.lang.Exception
Pack permission nodes into JavaAPI absorbable Permissions collection. The input parameter of key let us know whether a XML object already exist in Module property bag. If not then a empty Permissions will be created to return back. JavaAPI don't like null Permissions.

Parameters:
key - XML object key name.
collectionType - Property.RESERVATION_PERMISSIONS or Property.
Returns:
Permissions JavaAPI's Permissions collection.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPropertiesFromXML

protected com.filenet.wcm.api.Properties getPropertiesFromXML(java.lang.String key)
                                                       throws java.lang.Exception
Pack property nodes into JavaAPI absorbable Properties collection. The input parameter of key let us know whether a XML object already exist in Class property bag. If not then a error will be thrown.

Parameters:
key - XML object key name.
Returns:
Properties JavaAPI's Properties collection.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPropertiesFromXML

protected com.filenet.wcm.api.Properties getPropertiesFromXML(org.w3c.dom.Document props)
                                                       throws java.lang.Exception
Pack property nodes into JavaAPI absorbable Properties collection. The input parameter of key let us know whether a XML object already exist in Class property bag. If not then a error will be thrown.

Parameters:
props - XML object.
Returns:
Properties JavaAPI's Properties collection.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

checkParam

protected boolean checkParam(java.lang.Object o)
                      throws java.lang.Exception
Make sure object is not null and has some value. For now it only works with String type.

Parameters:
o - XML object key name.
Returns:
boolean Return true if object is a string and not null.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getXMLDocument

protected org.w3c.dom.Document getXMLDocument(java.lang.String xml,
                                              java.lang.String key)
                                       throws java.lang.Exception
Pack XML string into a Document object and cache it into module property bag to speed up future data retrival time.

Parameters:
xml - XML string.
key - A value to be stored in property bag.
Returns:
boolean XML Document object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getXMLDocumentByClass

protected org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml,
                                                     java.lang.String key)
                                              throws java.lang.Exception
Pack XML string into a Document object and cache it into class property bag to speed up future data retrival time. This will cache across popup window boundaries if you know you are forcing refresh outside of WcmAuthoringDataProvider correctly. Requires using getClassProperty in calling methods. Use with care.

Parameters:
xml - XML string.
key - A value to be stored in property bag.
Returns:
boolean XML Document object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getEmptyXMLDoc

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

Overrides:
getEmptyXMLDoc in class WcmNavigationDataProvider
Returns:
Document Object that represents an empty set

setFilePlanObjectStores

public void setFilePlanObjectStores(java.util.Map map)
                             throws java.lang.Exception
This map contains object store name which support file plan

Parameters:
map - map of object store names
Throws:
java.lang.Exception

getRMUtil

protected com.filenet.rm.api.util.RMUtil getRMUtil()
Deprecated. - use RMUtil static method instead

return RmUtil object

Returns:
RMUtil


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