|
||||||||||
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.WcmNavigationDataProvider
com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider
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.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.base.WcmDpModule |
type |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
public static final java.lang.String TYPE
public static final int TYPE_DOCUMENT
public static final int TYPE_FOLDER
public static final int TYPE_OBJECT_STORE
public static final int TYPE_CLASSDESCRIPTION
public static final int TYPE_STORED_SEARCH
public static final int TYPE_SECURITY_POLICY
public static final int TYPE_PUBLISH_TEMPLATE
public static final int TYPE_VERSIONSERIES
public static final int TYPE_CUSTOMOBJECT
public static final int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
public static final int TYPE_WORKFLOWDEFINITION
public static final int TYPE_LINK
public static final int STATE_PROMOTE
public static final int STATE_DEMOTE
public static final int STATE_SET_EXCEPTION
public static final int STATE_CLEAR_EXCEPTION
public static final int STATE_RESET
public static final int TYPE_EMAILRECORD
public static final int TYPE_RECORDINFO
public static final int TYPE_MARKER
public static final int PRINCIPAL_SEARCH_TYPE_NONE
public static final int PRINCIPAL_SEARCH_TYPE_CUSTOM
public static final int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
public static final int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
public static final int PRINCIPAL_SEARCH_TYPE_CONTAINS
public static final int PRINCIPAL_SEARCH_TYPE_EXACT
public static final int PRINCIPAL_SEARCH_SORT_NONE
public static final int PRINCIPAL_SEARCH_SORT_ASCENDING
public static final int PRINCIPAL_SEARCH_SORT_DESCENDING
public static final int PRINCIPAL_SEARCH_ATTR_NONE
public static final int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
public static final int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
public static final java.lang.String RM_OBJECT_STORES_DOC_KEY
public static final java.lang.String PROPERTY_STATE_MODIFIED
public static final java.lang.String PROPERTY_STATE_NOT_VALIDATED
public static final java.lang.String TRUE
public static final java.lang.String FALSE
public static final int CONTENTTYPE_FOLDER
public static final int CONTENTTYPE_DOCUMENT
public static final int CONTENTTYPE_CUSTOMOBJECT
public static final int CONTENTTYPE_STORED_SEARCH
public static final java.lang.String[] RM_PROPERTIES
protected java.util.Map objectStoresMap
protected java.lang.String baseLocalPath
protected WcmAuthoringUtil xmlUtil
Constructor Detail |
public RecordsManageDataProvider() throws java.lang.Exception
java.lang.Exception
public RecordsManageDataProvider(java.lang.String name) throws java.lang.Exception
name
- Module name
java.lang.Exception
Method Detail |
public org.w3c.dom.Document getObjectStoresDoc(boolean refresh, java.lang.String filterClassId) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getObjectStoresDoc(boolean refresh) throws java.lang.Exception
getObjectStoresDoc
in class WcmNavigationDataProvider
refresh
- If true, XML is refreshed from server, otherwise it's retrieved from cache.
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getTopFoldersDoc(java.lang.String objectStoreID, java.lang.String[] properties, boolean refresh) throws java.lang.Exception
getTopFoldersDoc
in class WcmNavigationDataProvider
objectStoreID
- GUID of current browse object storeproperties
- Array of properties to return in setrefresh
- If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getTopFoldersSearchesDoc(java.lang.String objectStoreID, java.lang.String[] properties, boolean refresh) throws java.lang.Exception
getTopFoldersSearchesDoc
in class WcmNavigationDataProvider
objectStoreID
- GUID of current browse object storeproperties
- Array of properties to return in setrefresh
- If this object is true XML is refreshed from server, otherwise it's retrieved from cache.
java.lang.Exception
- If there are problems.public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int rmType, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getDocumentTitle(java.lang.String objectStoreID, java.lang.String classID, java.lang.String rmFolderId) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.classID
- GUID format of Class ID.rmFolderId
- Container (primary classification)
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getClassificationSchemeRootPath(java.lang.String objectStoreID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, java.lang.String[] props, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID, int objectType, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean isObjectStoreHasChap4Properties(java.lang.String objectStoreID) throws java.lang.Exception
java.lang.Exception
public boolean isObjectStoreBaseType(java.lang.String objectStoreID) throws java.lang.Exception
java.lang.Exception
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
java.lang.Exception
protected com.filenet.rm.api.RMFolder[] removeFirst(com.filenet.rm.api.RMFolder[] inArray)
protected java.lang.String getConnectorId(java.lang.String objectStoreID) throws java.lang.Exception
java.lang.Exception
protected java.lang.String getUrl(java.lang.String connectorID, java.lang.String[] documentIDs) throws java.lang.Exception
java.lang.Exception
protected java.lang.String getAuthenticatedUserShortName() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving the authenticated user.protected com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName, org.w3c.dom.NodeList propertiesNodeList) throws java.lang.Exception
objectStoreName
- Object Store Name for Object Valued Properties.propertiesNodeList
- Property XML node.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Values createMultiValues(org.w3c.dom.Node multiValues, int type) throws java.lang.Exception
multiValues
- Value XML node.type
- multiValues object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected void setValue(com.filenet.wcm.api.Value p, java.lang.String value, int type) throws java.lang.Exception
p
- Value object which will be set a new value.value
- Value in string format.type
- Data type; String, Integer...
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected void setValue(com.filenet.wcm.api.Property p, java.lang.Object value) throws java.lang.Exception
p
- Property object which will be set a new value.value
- Value object.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList) throws java.lang.Exception
permissionsNodeList
- Permissions XML node.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Permissions getPermissionsFromXML(org.w3c.dom.Document perms, java.lang.String collectionType) throws java.lang.Exception
perms
- XML object.collectionType
- Property.RESERVATION_PERMISSIONS or Property.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Permissions getPermissionsFromXML(java.lang.String key, java.lang.String collectionType) throws java.lang.Exception
key
- XML object key name.collectionType
- Property.RESERVATION_PERMISSIONS or Property.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Properties getPropertiesFromXML(java.lang.String key) throws java.lang.Exception
key
- XML object key name.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Properties getPropertiesFromXML(org.w3c.dom.Document props) throws java.lang.Exception
props
- XML object.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected boolean checkParam(java.lang.Object o) throws java.lang.Exception
o
- XML object key name.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected org.w3c.dom.Document getXMLDocument(java.lang.String xml, java.lang.String key) throws java.lang.Exception
xml
- XML string.key
- A value to be stored in property bag.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml, java.lang.String key) throws java.lang.Exception
xml
- XML string.key
- A value to be stored in property bag.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getEmptyXMLDoc()
getEmptyXMLDoc
in class WcmNavigationDataProvider
public void setFilePlanObjectStores(java.util.Map map) throws java.lang.Exception
map
- map of object store names
java.lang.Exception
protected com.filenet.rm.api.util.RMUtil getRMUtil()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |