com.filenet.rm.api.util

Class RMUtil

  1. java.lang.Object
  2. extended bycom.filenet.rm.api.util.RMUtil

  1. public class RMUtil
  2. extends java.lang.Object
The RMUtil class is a common utility class. This class provides utility methods that enable you to perform various tasks such as launching Workflow, retrieving class IDs, interacting with XML and DOM, and retrieving the existing connector implementation objects from Content Engine (CE).

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
CEMP_PREFIX
Determines the cemp prefix string
  1. static
  2. int
DISPOSAL
The int value represents the Disposition Workflow associated to be launched.
  1. static
  2. int
MAX_SUBJECT_INCLUDED_ENTITIES
  1. static
  2. int
MAX_SUBJECT_LENGTH
  1. static
  2. int
SCREENING
The int value represents the Vital workflow associated with the entities to be launched.
  1. static
  2. int
VITAL
The int value represents the Vital workflow associated with the entities to be launched.

Constructor Summary

Constructor and Description
RMUtil()
This is the default public constructor of the RMUtil class that initializes a newly created RMUtil.

Method Summary

Modifier and Type Method and Description
  1. static
  2. java.lang.String
_addNode(java.lang.String asURI,java.util.Map aoMap)
Adds mulitiple nodes to the XML String passed as a parameter.
  1. static
  2. java.lang.String
_addNode(java.lang.String asURI,java.lang.String asKeyName,java.lang.String asValue)
Add Nodes to the XML String passed as parameter.
  1. static
  2. java.lang.String
_addPropertiestoSearchXml(java.lang.String asSearchXml,java.lang.String[] asSymbolicName,java.lang.String lsClass)
Adds the symbolic name of the Properties to the search XML depending upon the value of lsclass.
  1. static
  2. void
_addRMLog(RMObjectStore aoRMObjectStore,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoPermissions)
Creates an RMLog object as an instance of RMCustomObject.
  1. static
  2. java.util.Date
_addToDate(java.util.Date aoBaseDate,int aiYear,int aiMonth,int aiDay)
Adds the year, month, and day passed as integers to the Date and returns the Modified Date.
  1. static
  2. void
_auditEvent(RMObject aoRMObject,java.lang.String asReason,java.lang.String asActionType,java.lang.String asDescription,java.lang.String asLastReviewedBy,int aiEventStatus)
Audits the event based upon the value of Action type.
  1. static
  2. RMBulkOperationResults
_batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
Performs the batch close operation for collection of BaseObjects passed as parameter.
  1. static
  2. RMBulkOperationResults
_batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,RMRecordContainer aoRecordContainer)
  1. static
  2. RMBulkOperationResults
_batchInactivate(boolean abIsInactive,RMObjectStore aoRMOS,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForInactivate)
Performs the batch inactivate operation for collection of BaseObjects passed as parameter.
  1. static
  2. RMBulkOperationResults
_batchReopen(boolean abReOpen,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
Reopens all the baseobject collection instances of ClosableObject (RecordCategory , RecordFolder or Volume).
  1. static
  2. com.filenet.wcm.api.BatchResultItems
_bulkUpdateEntities(com.filenet.wcm.api.Session aoSession,com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,com.filenet.wcm.api.Properties aoProperties,boolean abAsTransaction,boolean abDiscardResults,boolean abStopOnException)
Updates the entities in a batch of 10 entities.
  1. protected static
  2. boolean
_checkForBoolean(java.lang.Object aoValue,int aoOperator,java.lang.String asCompareValue)
Compares the object passed in the aoValue parameter with the corresponding value string passed as the asCompareValue parameter based on the aoOperator parameter.
  1. protected static
  2. boolean
_checkForDate(java.util.Date aoValue,int aoOperator,java.lang.String aoCompareValue)
Compares the Date object passed as the aoValue parameter with the corresponding String value passed as the aoCompareValue parameter based on the aoOperator parameter.
  1. protected static
  2. boolean
_checkForInteger(java.lang.Integer aoValue,int aoOperator,java.lang.String asCompareValue)
Compares the int value of the Integer object passed in the input parameter with the corresponding value contained in the String passed as parameter based on the operator parameter.
  1. protected static
  2. boolean
_checkForObject(java.lang.Object aoValue,int aoOperator,java.lang.String asCompareValue)
Compares the object passed in the aoValue parameter with the corresponding value string passed as the asCompareValue parameter based on the aoOperator parameter.
  1. protected static
  2. boolean
_checkForString(java.lang.String aoValue,int aoOperator,java.lang.String aoCompareValue)
Compares the String object passed as the aoValue parameter with the corresponding String value passed as the aoCompareValue parameter based on the aoOperator parameter.
  1. static
  2. boolean
_checkPattern(java.lang.String asBaseName,java.lang.String asPattern)
Validates whether a string name that is passed in the asBaseName parameter is valid as per the pattern specified by the asPattern paramter.
  1. static
  2. boolean
_containsValue(int[] aiArrValue,int aiValue)
  1. static
  2. org.w3c.dom.Document
_createXMLdoc(org.xml.sax.InputSource aoSource)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
_createXMLDoc(java.io.InputStream aoInputStream)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
_createXMLDoc(java.io.Reader aoReader)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
_createXMLDoc(java.lang.String asString)
Returns an XML document object.
  1. static
  2. boolean
_doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
Checks whether the given object store contains more then one file plan.
  1. static
  2. java.lang.String
_generateDocumentURI(RMObjectStore aoRMObjectStore,java.lang.String asURI)
Returns a String Document URI obtained by modifying the URI (XML String) passed by a user while record declaration.
  1. static
  2. DispositionAllocatableObject
_getActingDisposalSchedule(RMObject aoRMObject)
Returns the entity with which a disposal schedule is associated or cut-off data is inherited.
  1. static
  2. java.util.Vector
_getAllDateProperties(RMObjectStore aoRMObjectStore)
Retrieves the symbolic names of all the date-type properties of the Folder and Document classes.
  1. static
  2. com.filenet.wcm.api.ClassDescriptions
_getClassDescriptions(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns the collection of the ClassDescription of all the RM types which are passed in the int array as a parameter.
  1. static
  2. java.lang.String
_getClassDescriptionsXML(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns a String in XML that represents the class descriptions for Content Engine classes and their subclasses.
  1. static
  2. java.lang.String[]
_getClassIDs(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns a String array of the ClassIds of all the RM entities whose RM type is passed in the int array as a parameter.
  1. static
  2. java.util.Collection
_getCollection(java.lang.String[] asArrString)
Returns a collection of String objects for a String array
  1. static
  2. java.lang.String
_getConnectorQueryString(java.lang.String asRepositoryType,java.lang.String asRepositoryName,java.lang.String asServerName)
Returns a query string to retrieve the connector registration object.
  1. static
  2. com.filenet.wcm.api.CustomObject
_getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
Returns a ConnectorRegistration CustomObject retrieved from an RM object store based on the String query passed as parameter
  1. static
  2. int
_getCountFromResultSet(java.lang.String asResultSet)
Returns the count of all the z_row elements passed in the ResultSet XML string.
  1. static
  2. int
_getCountFromSingleObjectType(java.lang.String asResultSet)
This method returns the count tag value from the ResultSet.
  1. static
  2. java.util.Date
_getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
Calculates the current phase executution date for an entity
  1. static
  2. DocumentStore
_getDocumentStore(java.lang.Object aoObject)
Returns an instance of DocumentStore for the object store, which is passed as a parameter.
  1. static
  2. java.lang.String[]
_getFieldFromResultSet(java.lang.String asResultSet,java.lang.String asFieldName)
Returns the FieldName attribute of all the z_row elements passed in the ResultSet XML string.
  1. static
  2. java.lang.String
_getFilePlanID(RMFolder aoFolder)
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
  1. static
  2. RMObjectStores
_getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an RMObjectStores collection.
  1. static
  2. java.lang.String
_getLimitedResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiMaxRecords)
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store and retricts the result set as per the input parameter aiMaxRecords.
  1. static
  2. com.filenet.wcm.api.BaseObjects
_getMerged(java.util.ArrayList aoIDCheck,com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
Filters those documents from the aoToBeReplacedRecord BaseObjects collection that are not contained in the aoIDCheck collection.
  1. static
  2. java.util.ArrayList
_getMergedROSOR(java.util.ArrayList aoRecordID1,java.util.ArrayList aoRecordID2)
Returns a union of the record IDs as specified in the input parameters.
  1. static
  2. java.lang.String
_getMergedXML(java.lang.String aoReaderXMLIDCheck,java.lang.String aoReaderXMLToBeReplaced,java.lang.String aoXSLFile)
Invokes the XSLT transformation on the XML DOM document represented by the aoReaderXMLIDCheck string.
  1. static
  2. org.w3c.dom.Document
_getNewDocument()
Returns an empty Document object that is obtained from the Document Builder factory
  1. static
  2. java.lang.String
_getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns a String that contains an XML representation of the object stores The XML representation includes only those object stores that are valid FPOS.
  1. static
  2. java.lang.String
_getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores,java.lang.String[] asArrProps)
Returns a string that contains an XML representation of the object stores (and their properties, specified as symbolic names).
  1. static
  2. com.filenet.wcm.api.PropertyDescriptions
_getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes by filtering out property descriptions based on type.
  1. static
  2. java.lang.String
_getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
Returns a String in XML that represents property descriptions for the specified classes, by filtering out hidden property descriptions based on type.
  1. static
  2. java.lang.String
_getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType,RMRecordContainer aoContainer)
Returns a XML string of the property descriptions filtered out by the type of property descriptions The xml string also includes the Record Pattern associated with the aoContainer.
  1. static
  2. com.filenet.wcm.api.BaseObjects
_getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store.
  1. static
  2. com.filenet.wcm.api.BaseObjects
_getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResult)
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store and retricts the ResultSet as per the input parameter aiMaxResult.
  1. static
  2. java.io.Reader
_getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType)
Returns a Reader object.
  1. static
  2. com.filenet.wcm.api.ObjectStores
_getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an ObjectStores collection.
  1. static
  2. java.lang.String
_getRecordURI(RMObjectStore aoRMObjectStore,java.lang.String asRecordId)
Returns a URI string for the record
  1. static
  2. com.filenet.wcm.api.CustomObject
_getRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asRegistraionID)
Returns an RM custom object of type ConnectorRegistration that is retrieved from an RM object store using the ID of this custom object.
  1. static
  2. java.lang.String
_getRegistrationID(RMObjectStore aoRMObjectStore,java.lang.String asRepositoryType,java.lang.String asServerName,java.lang.String asRepositoryName,boolean abCreate)
Returns the GUID of a connector registration object.
  1. static
  2. java.lang.String
_getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuery)
Returns a string in XML that represents the results of a query in an object store.
  1. static
  2. java.lang.String
_getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns the String XML result set obtained by executing the query passed as parameter asQuerySQL for an object store.
  1. static
  2. java.lang.String
_getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
Returns a String XML result set obtained by executing a the query passed as parameter asQuerySQL for an object store and retricts the ResultSet as per the input parameter aiMaxResults.
  1. static
  2. java.lang.String
_getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store.
  1. static
  2. java.lang.String
_getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store.
  1. static
  2. java.lang.String
_getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store and retricts the result set as per the input parameter aiMaxResults.
  1. static
  2. RMObjectStore
_getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Returns an instance of RMObjectStore for an object store.
  1. static
  2. java.lang.String
_getUserId(RMObjectStore rmObjStore)
Returns the "ShortName" property for the user currently associated with the Buzz Session that is associated with the given RMObjectStore instance.
  1. static
  2. java.lang.String
_getUserIdWithDomain(RMObjectStore aoRMObjectStore)
Returns a String specifying the complete domain name of a User who is logged on to the current instance of an object store.
  1. static
  2. boolean
_isAnyParentClosed(RMFolder aoRMFolder)
Determines if any parent of the RMFolder is closed.
  1. static
  2. boolean
_isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid File Plan Object Store.
  1. static
  2. boolean
_isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid Records Object Store.
  1. static
  2. void
_launchWorkFlow(RMObjectStore aoRMObjectStore,java.util.Map aoMap,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
Launches the workflow associated with the entities.
  1. static
  2. void
_launchWorkFlow(RMObjectStore aoRMObjectStore,java.lang.String[] asGuidArray,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
Launches the workflow associated with the entities.
  1. static
  2. RecordInfo
_locateRecord(java.lang.String asURI)
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
  1. static
  2. java.util.Map
_populateMap(org.w3c.dom.Document aoDocument)
Returns a Map object for the aoDocument, which is an XML String with nodes as key, and the corresponding values as key-value pair.
  1. static
  2. java.util.Map
_populateMap(java.lang.String asURL)
Returns a Map object for the asURL, which is an XML String with nodes as key, and the corresponding values as key-value pair.
  1. static
  2. java.lang.String
_removeNode(java.lang.String asURI,java.lang.String asKeyName)
Removes the node from the XML String passed as a parameter whose name is specified by the key name.
  1. static
  2. boolean
_useInSubFolder(RMObjectStore aoObjectStore,java.lang.String aoFolderPath)
  1. static
  2. boolean
_validateDate(java.lang.String asDate,java.lang.String asFormat)
Returns true or false if the Date passed as String is as per the format passed as parameter
  1. static
  2. void
_validateDestination(RMRecordContainer aoDestination,RecordInfo loRecord)
  1. static
  2. void
_validateDisposition(DisposableObject aoDisposableObject)
Validates whether the entity passed as input parameter can be disposed or not.
  1. static
  2. java.lang.String
_writeXML(org.w3c.dom.Node aoNode)
Returns an XML string representing the node passed as parameter.
  1. java.lang.String
addNode(java.lang.String asURI,java.util.Map aoMap)
Deprecated. Use _addNode(String asURI, Map aoMap) instead of this method.
  1. java.lang.String
addNode(java.lang.String asURI,java.lang.String asKeyName,java.lang.String asValue)
Deprecated. Use _addNode(String asURI, String asKeyName, String asValue) instead of this method.
  1. java.lang.String
addPropertiestoSearchXml(java.lang.String asSearchXml,java.lang.String[] asSymbolicName,java.lang.String lsClass)
  1. void
addRMLog(RMObjectStore aoRMObjectStore,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoPermissions)
  1. java.util.Date
addToDate(java.util.Date aoBaseDate,int aiYear,int aiMonth,int aiDay)
Deprecated. Use _addToDate(Date aoBaseDate, int aiYear, int aiMonth, int aiDay) instead of this method.
  1. void
auditEvent(RMObject aoRMObject,java.lang.String asReason,java.lang.String asActionType,java.lang.String asDescription,java.lang.String asLastReviewedBy,int aiEventStatus)
  1. RMBulkOperationResults
batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
Deprecated. Use _batchClose(BaseObjects aoBaseObjects, String asReasonForClose) instead of this method.
  1. RMBulkOperationResults
batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,RMRecordContainer aoRecordContainer)
  1. RMBulkOperationResults
batchInactivate(boolean abIsInactive,RMObjectStore aoRMOS,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForInactivate)
  1. RMBulkOperationResults
batchReopen(boolean abReOpen,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
  1. com.filenet.wcm.api.BatchResultItems
bulkUpdateEntities(com.filenet.wcm.api.Session aoSession,com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,com.filenet.wcm.api.Properties aoProperties,boolean abAsTransaction,boolean abDiscardResults,boolean abStopOnException)
  1. protected
  2. boolean
checkForBoolean(java.lang.Object aoValue,int aoOperator,java.lang.String asCompareValue)
  1. protected
  2. boolean
checkForDate(java.util.Date aoValue,int aoOperator,java.lang.String aoCompareValue)
  1. protected
  2. boolean
checkForInteger(java.lang.Integer aoValue,int aoOperator,java.lang.String asCompareValue)
  1. protected
  2. boolean
checkForObject(java.lang.Object aoValue,int aoOperator,java.lang.String asCompareValue)
  1. protected
  2. boolean
checkForString(java.lang.String aoValue,int aoOperator,java.lang.String aoCompareValue)
  1. static
  2. java.lang.String
checkNull(java.lang.String asString)
Validates if passed String is null.
  1. boolean
checkPattern(java.lang.String asBaseName,java.lang.String asPattern)
Deprecated. Use _checkPattern(String asBaseName, String asPattern) instead of this method.
  1. boolean
containsValue(int[] aiArrValue,int aiValue)
  1. org.w3c.dom.Document
createXMLdoc(org.xml.sax.InputSource aoSource)
Deprecated. Use _createXMLdoc(InputSource aoSource) instead of this method.
  1. org.w3c.dom.Document
createXMLDoc(java.io.InputStream aoInputStream)
Deprecated. Use _createXMLDoc(InputStream aoInputStream) instead of this method.
  1. org.w3c.dom.Document
createXMLDoc(java.io.Reader aoReader)
Deprecated. Use _createXMLDoc(Reader aoReader) instead of this method.
  1. org.w3c.dom.Document
createXMLDoc(java.lang.String asString)
Deprecated. Use _createXMLDoc(String asString) instead of this method.
  1. static
  2. java.lang.String
DecodeFormattedString(java.lang.String asStringValue)
Decode the passed String by replacing strings like &,<,> with filter operators.
  1. boolean
doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
Deprecated. Use _doMultipleFilePlanExist(RMObjectStore aoRMObjectStore) instead of this method.
  1. java.lang.String
generateDocumentURI(RMObjectStore aoRMObjectStore,java.lang.String asURI)
  1. DispositionAllocatableObject
getActingDisposalSchedule(RMObject aoRMObject)
Deprecated. Use _getActingDisposalSchedule(RMObject aoRMObject) instead of this method.
  1. static
  2. java.util.List
getAllAssociatedROS(RMObjectStore rmFPOS)
  1. static
  2. java.util.Map
getAllImplementataions(RMObjectStore aoRMObjectStore)
This method search for the connector registration and returns the Map containing the implementation class name as the key and the value is the ArrayList that in turn contains the ArrayList containing the parameters like server name, repository name and the repository type
  1. static
  2. com.filenet.wcm.api.ObjectStores
getAllObjectStores(com.filenet.wcm.api.EntireNetwork loEntireNetwork)
Returns a collection that contains all the object stores in the EntireNetwork.
  1. static
  2. java.lang.String
getAllObjectStoresXML(com.filenet.wcm.api.EntireNetwork loEntireNetwork,java.lang.String[] propNames)
Returns all the object stores properties in XML form from the EntireNetwork Object
  1. static
  2. com.filenet.api.core.Connection
getCEConnection(com.filenet.wcm.api.Session session)
Retrieves a CE 4.0 Connection aka DaphneConnection object from the current Buzz Session
  1. com.filenet.wcm.api.ClassDescriptions
getClassDescriptions(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.lang.String
getClassDescriptionsXML(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.lang.String[]
getClassIDs(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.util.Collection
getCollection(java.lang.String[] asArrString)
Deprecated. Use _getCollection(String[] asArrString) instead of this method.
  1. java.lang.String
getConnectorQueryString(java.lang.String asRepositoryType,java.lang.String asRepositoryName,java.lang.String asServerName)
  1. com.filenet.wcm.api.CustomObject
getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
  1. static
  2. java.lang.String
getConnectorSearchURL(RMObjectStore aoRMObjectStore,java.lang.String asRMConn,java.util.Map aoImplClassMap)
Generates the search URL that needs to be passed to the RMConnector implementation for the search related methods
  1. int
getCountFromResultSet(java.lang.String asResultSet)
Deprecated. Use _getCountFromResultSet(String asResultSet) instead of this method.
  1. int
getCountFromSingleObjectType(java.lang.String asResultSet)
Deprecated. Use _getCountFromSingleObjectType(String asResultSet) instead of this method.
  1. java.util.Date
getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
Deprecated. Use _getCurrentPhaseExecutionDate(DisposableObject aoRMObject) instead of this method.
  1. DocumentStore
getDocumentStore(java.lang.Object aoObject)
Deprecated. Use _getDocumentStore(Object aoObject) instead of this method.
  1. java.lang.String[]
getFieldFromResultSet(java.lang.String asResultSet,java.lang.String asFieldName)
Deprecated. Use _getFieldFromResultSet(String asResultSet, String asFieldName) instead of this method.
  1. java.lang.String
getFilePlanID(RMFolder aoFolder)
Deprecated. Use _getFilePlanID(RMFolder aoFolder) instead of this method.
  1. RMObjectStores
getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use _getFilePlanObjectStores(ObjectStores aoObjectStores) instead of this method.
  1. static
  2. java.lang.String
getFormattedString(java.lang.String asStringValue)
Formats the passed String by replacing characters like &,',<,> with filter operators.
  1. static
  2. java.lang.String[]
getIdsFromEntityClass(RMObjectStore aoObjectStore,java.lang.String asFrom,java.lang.String asWhereClause)
Returns a String array whose elements specify the IDs of objects that match the given criteria.
  1. java.lang.String
getLimitedResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiMaxRecords)
  1. static
  2. java.util.Locale
getLocale(com.filenet.wcm.api.Session session)
Returns a Locale object from the Session
  1. com.filenet.wcm.api.BaseObjects
getMerged(java.util.ArrayList aoIDCheck,com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
  1. java.util.ArrayList
getMergedROSOR(java.util.ArrayList aoRecordID1,java.util.ArrayList aoRecordID2)
Deprecated. Use _getMergedROSOR(ArrayList aoRecordID1, ArrayList aoRecordID2) instead of this method.
  1. java.lang.String
getMergedXML(java.lang.String aoReaderXMLIDCheck,java.lang.String aoReaderXMLToBeReplaced,java.lang.String aoXSLFile)
  1. static
  2. java.lang.String
getModifiedConditionXML(RMObjectStore aoRMObjectStore,java.lang.String asConditionXML)
This method returns the XML after modidfying the Sql tag.
  1. org.w3c.dom.Document
getNewDocument()
Deprecated. Use _getNewDocument() instead of this method.
  1. java.lang.String
getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use _getObjectStoreXML(ObjectStores aoObjectStores) instead of this method.
  1. java.lang.String
getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores,java.lang.String[] asArrProps)
  1. static
  2. java.lang.String
getPreviewListingOfEntites(RMObjectStore aoRMObjectStore,java.lang.String[] asSelectClauseProperty,java.lang.String asConditionXML,java.lang.String asFilterCriteria,int aiMaxRecords)
This method returns the XML containig information about the entites depending upon the properties tag contained in the asConditionXML.
  1. com.filenet.wcm.api.PropertyDescriptions
getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
  1. java.lang.String
getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
  1. java.lang.String
getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType,RMRecordContainer aoContainer)
  1. com.filenet.wcm.api.BaseObjects
getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. com.filenet.wcm.api.BaseObjects
getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResult)
  1. java.io.Reader
getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType)
Deprecated. Use _getReader(String asFilePathOrString, String asReaderType) instead of this method.
  1. static
  2. java.io.Reader
getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType,java.lang.String asEncoding)
Deprecated. Use _getReader(String asFilePathOrString, String asReaderType) instead of this method.
  1. com.filenet.wcm.api.ObjectStores
getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use _getRecordObjectStores(ObjectStores aoObjectStores) instead of this method.
  1. java.lang.String
getRecordURI(RMObjectStore aoRMObjectStore,java.lang.String asRecordId)
Deprecated. Use _getRecordURI(RMObjectStore aoRMObjectStore, String asRecordId) instead of this method.
  1. com.filenet.wcm.api.CustomObject
getRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asRegistraionID)
  1. java.lang.String
getRegistrationID(RMObjectStore aoRMObjectStore,java.lang.String asRepositoryType,java.lang.String asServerName,java.lang.String asRepositoryName,boolean abCreate)
  1. java.lang.String
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuery)
Deprecated. Use _getResultSet(ObjectStore aoObjectStore, String asQuery) instead of this method.
  1. java.lang.String
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. java.lang.String
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
  1. java.lang.String
getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
Deprecated. Use _getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL) instead of this method.
  1. java.lang.String
getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. java.lang.String
getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
  1. static
  2. RMObjects
getRMObjects(RMObjectStore aoObjectStore,java.lang.String asFrom,java.lang.String asWhereClause)
Returns a collection of RMObjects that match the given criteria.
  1. RMObjectStore
getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use _getRMObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. com.filenet.wcm.api.ObjectStore
getROSObjectStore(RecordInfo loInfo,com.filenet.wcm.api.Session sess)
  1. static
  2. java.lang.String[]
GetROSURL(org.w3c.dom.NodeList loURLNode)
  1. java.lang.String
getUserId(RMObjectStore aoRMObjectStore)
Deprecated. Use _getUserId(RMObjectStore aoRMObjectStore) instead of this method.
  1. java.lang.String
getUserIdWithDomain(RMObjectStore aoRMObjectStore)
Deprecated. Use _getUserIdWithDomain(RMObjectStore aoRMObjectStore) instead of this method.
  1. static
  2. java.lang.String
getUsernameFromFullName(java.lang.String fullName)
Get the short username from possible full username.
  1. boolean
isAnyParentClosed(RMFolder aoRMFolder)
Deprecated. Use _isAnyParentClosed(RMFolder aoRMFolder) instead of this method.
  1. boolean
isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use _isFilePlanObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. boolean
isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use _isRecordObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. static
  2. RMBulkOperationResults
lauchWorkflow(filenet.vw.api.VWSession aoVWSession,java.lang.String[] aoObjects,RMObjectStore aoObjectStore,java.lang.String workflowVersionId,java.lang.String[] paramNames,java.lang.String[] paramValues)
Launches the workflow with a given version directly
  1. void
launchWorkFlow(RMObjectStore aoRMObjectStore,java.lang.String[] asGuidArray,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
  1. RecordInfo
locateRecord(java.lang.String asURI)
Deprecated. Use _locateRecord(String asURI) instead of this method.
  1. java.util.Map
populateMap(org.w3c.dom.Document aoDocument)
Deprecated. Use _populateMap(Document aoDocument) instead of this method.
  1. java.util.Map
populateMap(java.lang.String asURL)
Deprecated. Use _populateMap(String asURL) instead of this method.
  1. java.lang.String
removeNode(java.lang.String asURI,java.lang.String asKeyName)
Deprecated. Use _removeNode(String asURI, String asKeyName) instead of this method.
  1. static
  2. java.lang.String
replaceAll(java.lang.String acSpecialCh,java.lang.String asReplaceBy,java.lang.String asMainStr)
Returns String after replacing characters with the provided characters.
  1. static
  2. java.lang.String
replaceALLInstance(java.lang.String asFindStr,java.lang.String asReplaceBy,java.lang.String asMainStr)
This method replace all the occurance of asFindStr with asReplaceBy in as MainStr
  1. static
  2. java.util.Date
settingTimeComponentasZero(java.util.Date aoDate)
Sets the time component of the date as zero
  1. static
  2. java.lang.String
toStringFromStringArray(java.lang.String[] asArrString)
Converts the string elements in the string array to a string
  1. static
  2. void
tranferPhaseWithoutAction(RMObjectStore aoRMObjectStore,RMObject aoObject)
This method is used to transfer the phase (having no Current Phase Action )to the next phase.
  1. boolean
useInSubFolder(RMObjectStore aoObjectStore,java.lang.String aoFolderPath)
  1. static
  2. void
validateCustomObjectName(RMObjectStore aoRMOS,java.lang.String asCustomObjectClassName,java.lang.String asCustomObjectNameProperty,java.lang.String asName,java.lang.String asCustomObjectTypeProperty,int aiType)
Validates the values of the name property and type property of a CustomObject of specified type.
  1. boolean
validateDate(java.lang.String asDate,java.lang.String asFormat)
Deprecated. Use _validateDate(String asDate, String asFormat) instead of this method.
  1. void
validateDestination(RMRecordContainer aoDestination,RecordInfo loRecord)
  1. void
validateDisposition(DisposableObject aoDisposableObject)
Deprecated. Use _validateDisposition(DisposableObject aoDisposableObject) instead of this method.
  1. java.lang.String
writeXML(org.w3c.dom.Node aoNode)
Deprecated. Use _writeXML(Node aoNode) instead of this method.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISPOSAL

  1. public static final int DISPOSAL
The int value represents the Disposition Workflow associated to be launched.
See Also:

VITAL

  1. public static final int VITAL
The int value represents the Vital workflow associated with the entities to be launched.
See Also:

SCREENING

  1. public static final int SCREENING
The int value represents the Vital workflow associated with the entities to be launched.
See Also:

MAX_SUBJECT_INCLUDED_ENTITIES

  1. public static final int MAX_SUBJECT_INCLUDED_ENTITIES
See Also:

MAX_SUBJECT_LENGTH

  1. public static final int MAX_SUBJECT_LENGTH
See Also:

CEMP_PREFIX

  1. public static final java.lang.String CEMP_PREFIX
Determines the cemp prefix string
See Also:

Constructor Detail

RMUtil

  1. public RMUtil()
This is the default public constructor of the RMUtil class that initializes a newly created RMUtil.

Method Detail

getRMObjects

  1. public static RMObjects getRMObjects( RMObjectStore aoObjectStore,
  2. java.lang.String asFrom,
  3. java.lang.String asWhereClause)
Returns a collection of RMObjects that match the given criteria.
Parameters:
aoObjectStore - An object store on which action is to be performed.
asFrom - A class name from which the RMObjects are to be fetched.
asWhereClause - A string that represents the conditions based on which the RMObjects are to be fetched.
Returns:
An RMObjects collection that match the criteria.

getIdsFromEntityClass

  1. public static java.lang.String[] getIdsFromEntityClass( RMObjectStore aoObjectStore,
  2. java.lang.String asFrom,
  3. java.lang.String asWhereClause)
Returns a String array whose elements specify the IDs of objects that match the given criteria.
Parameters:
aoObjectStore - An object store on which action is to be performed.
asFrom - A class name from which the object IDs are to be fetched.
asWhereClause - A String that represents the conditions based on which the object IDs are to be fetched.
Returns:
A String array containing the IDs of objects that match the criteria.

launchWorkFlow

  1. public void launchWorkFlow(RMObjectStore aoRMObjectStore,
  2. java.lang.String[] asGuidArray,
  3. java.lang.String asFirstProperty,
  4. int aiWorkFlowProperty,
  5. filenet.vw.api.VWSession aoVWSession)
  6. throws RMException
Launches the workflow associated with the entities.
Parameters:
aoRMObjectStore - An object store where RM entities exist.
asGuidArray - A String array whose elements specify the IDs of RM entities.
asFirstProperty - A Property on which sorting is to be performed.
aiWorkFlowProperty - An int value represents the workflow to be launched
aoVWSession - A VWSession object.
Throws:
RMException - In case of any error, an RMException will be thrown.

_launchWorkFlow

  1. public static void _launchWorkFlow( RMObjectStore aoRMObjectStore,
  2. java.lang.String[] asGuidArray,
  3. java.lang.String asFirstProperty,
  4. int aiWorkFlowProperty,
  5. filenet.vw.api.VWSession aoVWSession)
  6. throws RMException
Launches the workflow associated with the entities.
Parameters:
aoRMObjectStore - An object store where RM entities exist.
asGuidArray - A String array whose elements specify the IDs of RM entities.
asFirstProperty - A Property on which sorting is to be performed.
aiWorkFlowProperty - An int value represents the workflow to be launched
aoVWSession - A VWSession object.
Throws:
RMException - In case of any error, an RMException will be thrown.

_launchWorkFlow

  1. public static void _launchWorkFlow( RMObjectStore aoRMObjectStore,
  2. java.util.Map aoMap,
  3. java.lang.String asFirstProperty,
  4. int aiWorkFlowProperty,
  5. filenet.vw.api.VWSession aoVWSession)
  6. throws RMException
Launches the workflow associated with the entities.
Parameters:
aoRMObjectStore - An object store where RM entities exist.
aoMap - A Map containing the as id of an RMObject and as the RMEntityType.
asFirstProperty - A Property on which sorting is to be performed.
aiWorkFlowProperty - An int value represents the workflow to be launched
aoVWSession - A VWSession object.
Throws:
RMException - In case of any error, an RMException will be thrown.

lauchWorkflow

  1. public static RMBulkOperationResults lauchWorkflow( filenet.vw.api.VWSession aoVWSession,
  2. java.lang.String[] aoObjects,
  3. RMObjectStore aoObjectStore,
  4. java.lang.String workflowVersionId,
  5. java.lang.String[] paramNames,
  6. java.lang.String[] paramValues)
Launches the workflow with a given version directly
Parameters:
aoVWSession - - a valid VW session
aoObjects -
aoObjectStore -
workflowVersionId -
paramNames -
paramValues -
Returns:

getRecordObjectStores

  1. public com.filenet.wcm.api.ObjectStores getRecordObjectStores( com.filenet.wcm.api.ObjectStores aoObjectStores)
  2. throws RMException
Deprecated. Use _getRecordObjectStores(ObjectStores aoObjectStores) instead of this method.
Returns an ObjectStores collection. This collection consists of all the object stores that are valid Records Object Stores.
Parameters:
aoObjectStores - A collection of object stores.
Returns:
An ObjectStores collection containing the valid Records Object Stores.
Throws:
RMException - if collection is empty or null, an RMException is thrown.

_getRecordObjectStores

  1. public static com.filenet.wcm.api.ObjectStores _getRecordObjectStores( com.filenet.wcm.api.ObjectStores aoObjectStores)
  2. throws RMException
Returns an ObjectStores collection. This collection consists of all the object stores that are valid Records Object Stores.
Parameters:
aoObjectStores - A collection of object stores.
Returns:
An ObjectStores collection containing the valid Records Object Stores.
Throws:
RMException - if collection is empty or null, an RMException is thrown.

getFilePlanObjectStores

  1. public RMObjectStores getFilePlanObjectStores( com.filenet.wcm.api.ObjectStores aoObjectStores)
  2. throws RMException
Deprecated. Use _getFilePlanObjectStores(ObjectStores aoObjectStores) instead of this method.
Returns an RMObjectStores collection. This collection consists of all the object stores that are valid File Plan Object Stores.
Parameters:
aoObjectStores - A collection of object stores.
Returns:
An RMObjectStores collection containing the vaild File Plan Object Stores.
Throws:
RMException - If the collection is empty or null, an RMException is thrown.

_getFilePlanObjectStores

  1. public static RMObjectStores _getFilePlanObjectStores( com.filenet.wcm.api.ObjectStores aoObjectStores)
  2. throws RMException
Returns an RMObjectStores collection. This collection consists of all the object stores that are valid File Plan Object Stores.
Parameters:
aoObjectStores - A collection of object stores.
Returns:
An RMObjectStores collection containing the vaild File Plan Object Stores.
Throws:
RMException - If the collection is empty or null, an RMException is thrown.

getFilePlanID

  1. public java.lang.String getFilePlanID( RMFolder aoFolder)
  2. throws RMException
Deprecated. Use _getFilePlanID(RMFolder aoFolder) instead of this method.
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
Parameters:
aoFolder - An RMFolder object.
Returns:
A String representing the GUID of ClassificationScheme object that contains the specified RMFolder object.
Throws:
RMException - In case of any error, an RMException will be thrown.

_getFilePlanID

  1. public static java.lang.String _getFilePlanID( RMFolder aoFolder)
  2. throws RMException
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
Parameters:
aoFolder - An RMFolder object.
Returns:
A String representing the GUID of ClassificationScheme object that contains the specified RMFolder object.
Throws:
RMException - In case of any error, an RMException will be thrown.

isFilePlanObjectStore

  1. public boolean isFilePlanObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Deprecated. Use _isFilePlanObjectStore(ObjectStore aoObjectStore) instead of this method.
Specifies if an object store is a valid File Plan Object Store.
Parameters:
aoObjectStore - An object store.
Returns:
true if the object store is a valid File Plan Object Store; otherwise false
Throws:
RMException - In case of any error, an RMException will be thrown.

_isFilePlanObjectStore

  1. public static boolean _isFilePlanObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Specifies if an object store is a valid File Plan Object Store.
Parameters:
aoObjectStore - An object store.
Returns:
true if the object store is a valid File Plan Object Store; otherwise false
Throws:
RMException - In case of any error, an RMException will be thrown.

getResultSet

  1. public java.lang.String getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuery)
Deprecated. Use _getResultSet(ObjectStore aoObjectStore, String asQuery) instead of this method.
Returns a string in XML that represents the results of a query in an object store.
Parameters:
aoObjectStore - An object store where a query is to be executed.
asQuery - A String that represents the SQL query.
Returns:
A String containing an XML representation of query results.
Throws:
RMException - In case of any error, an RMException will be thrown.

_getResultSet

  1. public static java.lang.String _getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuery)
Returns a string in XML that represents the results of a query in an object store.
Parameters:
aoObjectStore - An object store where a query is to be executed.
asQuery - A String that represents the SQL query.
Returns:
A String containing an XML representation of query results.
Throws:
RMException - In case of any error, an RMException will be thrown.

validateCustomObjectName

  1. public static void validateCustomObjectName( RMObjectStore aoRMOS,
  2. java.lang.String asCustomObjectClassName,
  3. java.lang.String asCustomObjectNameProperty,
  4. java.lang.String asName,
  5. java.lang.String asCustomObjectTypeProperty,
  6. int aiType)
  7. throws RMException
Validates the values of the name property and type property of a CustomObject of specified type. The property value should not be null or an empty string. Additionally, it must be unique across the object store. If any of the above validation fails, this method raises an exception.
Parameters:
aoRMOS - An object store where the validation is to be performed.
asCustomObjectClassName - Symbolic name of the CustomObject class, for example, DisposalTrigger.
asCustomObjectNameProperty - Symbolic name of the name property of the CustomObject class, for example, DisposalTriggerName.
asName - A String that specifies the value of the name property of a custom object.
asCustomObjectTypeProperty - Symbolic name of the custom object type property of the CustomObject class. This parameter specifies the type of a custom object with respect to the CustomObject class specified in asCustomObjectClassName, for example, EventType.
aiType - An int that specifies the value of the custom object type property of a custom object.
Throws:
RMException - If any error occurs, an RMException is thrown.

isRecordObjectStore

  1. public boolean isRecordObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Deprecated. Use _isRecordObjectStore(ObjectStore aoObjectStore) instead of this method.
Specifies if an object store is a valid Records Object Store.
Parameters:
aoObjectStore - An object store.
Returns:
true if the object store passed is a valid Records Object Store; otherwise false.
Throws:
RMException - In case of any error, an RMException will be thrown.

_isRecordObjectStore

  1. public static boolean _isRecordObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Specifies if an object store is a valid Records Object Store.
Parameters:
aoObjectStore - An object store.
Returns:
true if the object store passed is a valid Records Object Store; otherwise false.
Throws:
RMException - In case of any error, an RMException will be thrown.

getRegistrationID

  1. public java.lang.String getRegistrationID( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRepositoryType,
  3. java.lang.String asServerName,
  4. java.lang.String asRepositoryName,
  5. boolean abCreate)
  6. throws RMException
Returns the GUID of a connector registration object. Connector registration object represents the Records Object Store (ROS) where the document exists and is an RMCustomObject object of type ConnectorRegistration. The connector registration object should be invoked for the specified combination of repository type, server name, and repository name. If abCreate is false, it searches for an existing connector registration object for the given parameters. If it does not find an existing connector registration object, it returns a null value. However, if abCreate is true, the method creates and returns a new connector object if it does not find the appropriate connector object.
Parameters:
aoRMObjectStore - A FPOS where a connector registration object is to be located or created.
asRepositoryType - A String that represents the documents repository type. For this release it can only be CE.
asServerName - A String that represents the documents repository server URL. If the asRepositoryType is CE, asServerName has to be the remote server URL of CE. For this release this variable will be ignored in this method, so you can pass in null value.
asRepositoryName - A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE, the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.
abCreate - A boolean that indicates whether to create a new connector registration object if no existing object matches the given parameters.
Returns:
A String representing the GUID of a connector registration object.
Throws:
RMException - In case of any error, an RMException will be thrown.

_getRegistrationID

  1. public static java.lang.String _getRegistrationID( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRepositoryType,
  3. java.lang.String asServerName,
  4. java.lang.String asRepositoryName,
  5. boolean abCreate)
  6. throws RMException
Returns the GUID of a connector registration object. Connector registration object represents the Records Object Store (ROS) where the document exists and is an RMCustomObject object of type ConnectorRegistration. The connector registration object should be invoked for the specified combination of repository type, server name, and repository name. If abCreate is false, it searches for an existing connector registration object for the given parameters. If it does not find an existing connector registration object, it returns a null value. However, if abCreate is true, the method creates and returns a new connector object if it does not find the appropriate connector object.
Parameters:
aoRMObjectStore - A FPOS where a connector registration object is to be located or created.
asRepositoryType - A String that represents the documents repository type. For this release it can only be CE.
asServerName - A String that represents the documents repository server URL. If the asRepositoryType is CE, asServerName has to be the remote server URL of CE. For this release this variable will be ignored in this method, so you can pass in null value.
asRepositoryName - A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE, the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.
abCreate - A boolean that indicates whether to create a new connector registration object if no existing object matches the given parameters.
Returns:
A String representing the GUID of a connector registration object.
Throws:
RMException - In case of any error, an RMException will be thrown.

getFieldFromResultSet

  1. public java.lang.String[] getFieldFromResultSet( java.lang.String asResultSet,
  2. java.lang.String asFieldName)
  3. throws RMException
Returns the FieldName attribute of all the z_row elements passed in the ResultSet XML string. This ResultSet String must confirm to the schema used by the execute method of the CE Search class.
Parameters:
asResultSet - The ResultSetXML String
asFieldName - The field name to be retrieved
Returns:
A String[] array that contains the value of the field name passed as parameter
Throws:
RMException - If any error occurs, an RMException is thrown.

_getFieldFromResultSet

  1. public static java.lang.String[] _getFieldFromResultSet( java.lang.String asResultSet,
  2. java.lang.String asFieldName)
  3. throws RMException
Returns the FieldName attribute of all the z_row elements passed in the ResultSet XML string. This ResultSet String must confirm to the schema used by the execute method of the CE Search class.
Parameters:
asResultSet - The ResultSetXML String
asFieldName - The field name to be retrieved
Returns:
A String[] array that contains the value of the field name passed as parameter
Throws:
RMException - If any error occurs, an RMException is thrown.

getCountFromResultSet

  1. public int getCountFromResultSet( java.lang.String asResultSet)
  2. throws RMException
Deprecated. Use _getCountFromResultSet(String asResultSet) instead of this method.
Returns the count of all the z_row elements passed in the ResultSet XML string. This ResultSet String must confirm to the schema used by the execute method of the CE Search class.
Parameters:
asResultSet - The ResultSetXML String
Returns:
Count of all the z_row elements
Throws:
RMException - If any error occurs, an RMException is thrown.

_getCountFromResultSet

  1. public static int _getCountFromResultSet( java.lang.String asResultSet)
  2. throws RMException
Returns the count of all the z_row elements passed in the ResultSet XML string. This ResultSet String must confirm to the schema used by the execute method of the CE Search class.
Parameters:
asResultSet - The ResultSetXML String
Returns:
Count of all the z_row elements
Throws:
RMException - If any error occurs, an RMException is thrown.

batchClose

  1. public RMBulkOperationResults batchClose( com.filenet.wcm.api.BaseObjects aoBaseObjects,
  2. java.lang.String asReasonForClose)
  3. throws RMException
Performs the batch close operation for collection of BaseObjects passed as parameter.
Parameters:
aoBaseObjects - Collection of base objects
asReasonForClose - A string value specifying the reason for closing an RM entity.
Throws:
RMException - If an error occurs, an RMException is thrown.

_batchClose

  1. public static RMBulkOperationResults _batchClose( com.filenet.wcm.api.BaseObjects aoBaseObjects,
  2. java.lang.String asReasonForClose)
  3. throws RMException
Performs the batch close operation for collection of BaseObjects passed as parameter.
Parameters:
aoBaseObjects - Collection of base objects
asReasonForClose - A string value specifying the reason for closing an RM entity.
Throws:
RMException - If an error occurs, an RMException is thrown.

batchReopen

  1. public RMBulkOperationResults batchReopen( boolean abReOpen,
  2. com.filenet.wcm.api.BaseObjects aoBaseObjects,
  3. java.lang.String asReasonForClose)
  4. throws RMException
Reopens all the baseobject collection instances of ClosableObject (RecordCategory , RecordFolder or Volume). Once any RM entity is reopened, a user can add a child (RecordCategory , RecordFolder, Volume, or Record) to this RMEntity.
Parameters:
abReOpen - true/false to reopen or close an entity.
aoBaseObjects - Collection of Baseobjects to be reopened.
asReasonForClose - A String value specifying reason for reopening an entity.
Returns:
The collection object of RMBulkOperationResult.
Throws:
RMException - In case of any error, an RMException will be thrown.

_batchReopen

  1. public static RMBulkOperationResults _batchReopen( boolean abReOpen,
  2. com.filenet.wcm.api.BaseObjects aoBaseObjects,
  3. java.lang.String asReasonForClose)
  4. throws RMException
Reopens all the baseobject collection instances of ClosableObject (RecordCategory , RecordFolder or Volume). Once any RM entity is reopened, a user can add a child (RecordCategory , RecordFolder, Volume, or Record) to this RMEntity.
Parameters:
abReOpen - true/false to reopen or close an entity.
aoBaseObjects - Collection of Baseobjects to be reopened.
asReasonForClose - A String value specifying reason for reopening an entity.
Returns:
The collection object of RMBulkOperationResult.
Throws:
RMException - In case of any error, an RMException will be thrown.

batchInactivate

  1. public RMBulkOperationResults batchInactivate( boolean abIsInactive,
  2. RMObjectStore aoRMOS,
  3. com.filenet.wcm.api.BaseObjects aoBaseObjects,
  4. java.lang.String asReasonForInactivate)
  5. throws RMException
Performs the batch inactivate operation for collection of BaseObjects passed as parameter.
Parameters:
abIsInactive - true or false to inactivate or activate the current instance.
aoRMOS - This represents an instance of RMObjectStore.
aoBaseObjects - This represents the collection of baseobjects which need to be inactivated.
asReasonForInactivate - String specifying the reason for inactivation of base objects. The reason for the inactive state cannot be null, if a user intends to inactivate the current instance.
Returns:
A collection of RMBulkOperationResults
Throws:
RMException - If an error occurs, an RMException is thrown.

_batchInactivate

  1. public static RMBulkOperationResults _batchInactivate( boolean abIsInactive,
  2. RMObjectStore aoRMOS,
  3. com.filenet.wcm.api.BaseObjects aoBaseObjects,
  4. java.lang.String asReasonForInactivate)
  5. throws RMException
Performs the batch inactivate operation for collection of BaseObjects passed as parameter.
Parameters:
abIsInactive - true or false to inactivate or activate the current instance.
aoRMOS - This represents an instance of RMObjectStore.
aoBaseObjects - This represents the collection of baseobjects which need to be inactivated.
asReasonForInactivate - String specifying the reason for inactivation of base objects. The reason for the inactive state cannot be null, if a user intends to inactivate the current instance.
Returns:
A collection of RMBulkOperationResults
Throws:
RMException - If an error occurs, an RMException is thrown.

isAnyParentClosed

  1. public boolean isAnyParentClosed( RMFolder aoRMFolder)
  2. throws RMException
Deprecated. Use _isAnyParentClosed(RMFolder aoRMFolder) instead of this method.
Determines if any parent of the RMFolder is closed.
Parameters:
aoRMFolder - The RMFolder whose parents' closed state is to be determined.
Returns:
true if RMFolder's parent is closed; otherwise false.
Throws:
RMException - If an error occurs, an RMException is thrown.

_isAnyParentClosed

  1. public static boolean _isAnyParentClosed( RMFolder aoRMFolder)
  2. throws RMException
Determines if any parent of the RMFolder is closed.
Parameters:
aoRMFolder - The RMFolder whose parents' closed state is to be determined.
Returns:
true if RMFolder's parent is closed; otherwise false.
Throws:
RMException - If an error occurs, an RMException is thrown.

bulkUpdateEntities

  1. public com.filenet.wcm.api.BatchResultItems bulkUpdateEntities( com.filenet.wcm.api.Session aoSession,
  2. com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,
  3. com.filenet.wcm.api.Properties aoProperties,
  4. boolean abAsTransaction,
  5. boolean abDiscardResults,
  6. boolean abStopOnException)
Updates the entities in a batch of 10 entities.
Parameters:
aoSession - The value of the CE Session object.
aoEntitiestobeUpdated - Collection of entities to be updated.
aoProperties - Property collection to be updated.
abAsTransaction - This parameter is ignored.
abDiscardResults - If true, result objects that would normally be returned to the caller are simply discarded. If false, result objects are returned.
abStopOnException - If true, the remote server halts attempts to perform operations if any one operation returns an exception. An exception in this context means a condition that would normally result in an exception being thrown if the operations were not part of a batch.
Returns:
The collection of BatchResultitems.

_bulkUpdateEntities

  1. public static com.filenet.wcm.api.BatchResultItems _bulkUpdateEntities( com.filenet.wcm.api.Session aoSession,
  2. com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,
  3. com.filenet.wcm.api.Properties aoProperties,
  4. boolean abAsTransaction,
  5. boolean abDiscardResults,
  6. boolean abStopOnException)
Updates the entities in a batch of 10 entities.
Parameters:
aoSession - The value of the CE Session object.
aoEntitiestobeUpdated - Collection of entities to be updated.
aoProperties - Property collection to be updated.
abAsTransaction - This parameter is ignored.
abDiscardResults - If true, result objects that would normally be returned to the caller are simply discarded. If false, result objects are returned.
abStopOnException - If true, the remote server halts attempts to perform operations if any one operation returns an exception. An exception in this context means a condition that would normally result in an exception being thrown if the operations were not part of a batch.
Returns:
The collection of BatchResultitems.

checkNull

  1. public static java.lang.String checkNull( java.lang.String asString)
Validates if passed String is null. Returns an empty String "", if the passed string is null.
Parameters:
asString - The string to be validated
Returns:
Empty string "", if passed String is null; otherwise the passed string.

populateMap

  1. public java.util.Map populateMap( java.lang.String asURL)
  2. throws RMException
Deprecated. Use _populateMap(String asURL) instead of this method.
Returns a Map object for the asURL, which is an XML String with nodes as key, and the corresponding values as key-value pair. The passed String must be a valid XML String. The key-value pair consists of all the child nodes of the root node and their corresponding values.
Parameters:
asURL - An XML String
Returns:
Map Child nodes of root as key and their value as value
Throws:
RMException - If an error occurs, an RMException is thrown.

_populateMap

  1. public static java.util.Map _populateMap( java.lang.String asURL)
  2. throws RMException
Returns a Map object for the asURL, which is an XML String with nodes as key, and the corresponding values as key-value pair. The passed String must be a valid XML String. The key-value pair consists of all the child nodes of the root node and their corresponding values.
Parameters:
asURL - An XML String
Returns:
Map Child nodes of root as key and their value as value
Throws:
RMException - If an error occurs, an RMException is thrown.

populateMap

  1. public java.util.Map populateMap( org.w3c.dom.Document aoDocument)
  2. throws RMException
Deprecated. Use _populateMap(Document aoDocument) instead of this method.
Returns a Map object for the aoDocument, which is an XML String with nodes as key, and the corresponding values as key-value pair. The key-value pair consists of all the child nodes of the root node and their corresponding values.
Parameters:
aoDocument - A Document object.
Returns:
The Map child nodes of root as key and their value as value.
Throws:
RMException - In case of any error, an RMException will be thrown.

_populateMap

  1. public static java.util.Map _populateMap( org.w3c.dom.Document aoDocument)
  2. throws RMException
Returns a Map object for the aoDocument, which is an XML String with nodes as key, and the corresponding values as key-value pair. The key-value pair consists of all the child nodes of the root node and their corresponding values.
Parameters:
aoDocument - A Document object.
Returns:
The Map child nodes of root as key and their value as value.
Throws:
RMException - In case of any error, an RMException will be thrown.

getReader

  1. public static java.io.Reader getReader( java.lang.String asFilePathOrString,
  2. java.lang.String asReaderType,
  3. java.lang.String asEncoding)
  4. throws RMException
Deprecated. Use _getReader(String asFilePathOrString, String asReaderType) instead of this method.
Returns a Reader object. This object is obtained either by reading the String content passed as a parameter or the File content whose name is passed as a parameter depending on the asReaderType. Users calling this method must pass the STRING or FILE value defined by class as static variables to obtain the corresponding Reader object.
Parameters:
asFilePathOrString - The String content or the path of the file to be read.
asReaderType - String specifying the type of Reader to be initialized
Returns:
Reader The java.io.Reader after reading the content of file or String
Throws:
RMException - In case of any error, an RMException will be raised.

getReader

  1. public java.io.Reader getReader( java.lang.String asFilePathOrString,
  2. java.lang.String asReaderType)
  3. throws RMException
Deprecated. Use _getReader(String asFilePathOrString, String asReaderType) instead of this method.
Returns a Reader object. This object is obtained either by reading the String content passed as a parameter or the File content whose name is passed as a parameter depending on the asReaderType. Users calling this method must pass the STRING or FILE value defined by class as static variables to obtain the corresponding Reader object.
Parameters:
asFilePathOrString - The String content or the path of the file to be read.
asReaderType - String specifying the type of Reader to be initialized
Returns:
Reader The java.io.Reader after reading the content of file or String
Throws:
RMException - In case of any error, an RMException will be raised.

_getReader

  1. public static java.io.Reader _getReader( java.lang.String asFilePathOrString,
  2. java.lang.String asReaderType)
  3. throws RMException
Returns a Reader object. This object is obtained either by reading the String content passed as a parameter or the File content whose name is passed as a parameter depending on the asReaderType. Users calling this method must pass the STRING or FILE value defined by class as static variables to obtain the corresponding Reader object.
Parameters:
asFilePathOrString - The String content or the path of the file to be read.
asReaderType - String specifying the type of Reader to be initialized
Returns:
Reader The java.io.Reader after reading the content of file or String
Throws:
RMException - In case of any error, an RMException will be raised.

createXMLdoc

  1. public org.w3c.dom.Document createXMLdoc( org.xml.sax.InputSource aoSource)
  2. throws RMException
Deprecated. Use _createXMLdoc(InputSource aoSource) instead of this method.
Returns an XML document object. This object is obtained by parsing the content as an input source.
Parameters:
aoSource - An InputSource wrapped around the XML content.
Returns:
Document A Document Object obtained by parsing the content passed as an input source.
Throws:
RMException - If any error occurs, an RMException is raised.

_createXMLdoc

  1. public static org.w3c.dom.Document _createXMLdoc( org.xml.sax.InputSource aoSource)
  2. throws RMException
Returns an XML document object. This object is obtained by parsing the content as an input source.
Parameters:
aoSource - An InputSource wrapped around the XML content.
Returns:
Document A Document Object obtained by parsing the content passed as an input source.
Throws:
RMException - If any error occurs, an RMException is raised.

createXMLDoc

  1. public org.w3c.dom.Document createXMLDoc( java.io.Reader aoReader)
  2. throws RMException
Deprecated. Use _createXMLDoc(Reader aoReader) instead of this method.
Returns an XML document object. This object is obtained by parsing the content as a Reader object.
Parameters:
aoReader - A Reader object obtained by reading the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as a reader.
Throws:
RMException - If any error occurs, an RMException is raised.

_createXMLDoc

  1. public static org.w3c.dom.Document _createXMLDoc( java.io.Reader aoReader)
  2. throws RMException
Returns an XML document object. This object is obtained by parsing the content as a Reader object.
Parameters:
aoReader - A Reader object obtained by reading the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as a reader.
Throws:
RMException - If any error occurs, an RMException is raised.

createXMLDoc

  1. public org.w3c.dom.Document createXMLDoc( java.lang.String asString)
  2. throws RMException
Deprecated. Use _createXMLDoc(String asString) instead of this method.
Returns an XML document object. This object is obtained by parsing the content as a String object.
Parameters:
asString - A String wrapped around the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as a String.
Throws:
RMException - In case any error occurs, an RMException is raised.

_createXMLDoc

  1. public static org.w3c.dom.Document _createXMLDoc( java.lang.String asString)
  2. throws RMException
Returns an XML document object. This object is obtained by parsing the content as a String object.
Parameters:
asString - A String wrapped around the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as a String.
Throws:
RMException - In case any error occurs, an RMException is raised.

createXMLDoc

  1. public org.w3c.dom.Document createXMLDoc( java.io.InputStream aoInputStream)
  2. throws RMException
Deprecated. Use _createXMLDoc(InputStream aoInputStream) instead of this method.
Returns an XML document object. This object is obtained by parsing the content as a Input Steam.
Parameters:
aoInputStream - An InputStream wrapped around the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as an input stream.
Throws:
RMException - In case any error occurs, an RMException is raised.

_createXMLDoc

  1. public static org.w3c.dom.Document _createXMLDoc( java.io.InputStream aoInputStream)
  2. throws RMException
Returns an XML document object. This object is obtained by parsing the content as a Input Steam.
Parameters:
aoInputStream - An InputStream wrapped around the XML content.
Returns:
Document An XML document object obtained by parsing the content passed as an input stream.
Throws:
RMException - In case any error occurs, an RMException is raised.

doMultipleFilePlanExist

  1. public boolean doMultipleFilePlanExist( RMObjectStore aoRMObjectStore)
Deprecated. Use _doMultipleFilePlanExist(RMObjectStore aoRMObjectStore) instead of this method.
Checks whether the given object store contains more then one file plan.
Returns:
boolean true if the objectStore passed as parameter contains more then one file plan else returns false

_doMultipleFilePlanExist

  1. public static boolean _doMultipleFilePlanExist( RMObjectStore aoRMObjectStore)
Checks whether the given object store contains more then one file plan.
Returns:
boolean true if the objectStore passed as parameter contains more then one file plan else returns false

useInSubFolder

  1. public boolean useInSubFolder(RMObjectStore aoObjectStore,
  2. java.lang.String aoFolderPath)

_useInSubFolder

  1. public static boolean _useInSubFolder( RMObjectStore aoObjectStore,
  2. java.lang.String aoFolderPath)

generateDocumentURI

  1. public java.lang.String generateDocumentURI( RMObjectStore aoRMObjectStore,
  2. java.lang.String asURI)
  3. throws RMException
Returns a String Document URI obtained by modifying the URI (XML String) passed by a user while record declaration. The input URI string contains the document ID and registration ID of the implementation class This method reads the server name, repository type, and repository name of the implementation class corresponding to the registration ID and adds new nodes to the XML for each property. The generated XML String (URI) is send to connector.
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asURI - URI, XML String send by user to declare a Document
Returns:
String URI, modified XML String
Throws:
RMException - If any error occurs, an RMException is raised.

_generateDocumentURI

  1. public static java.lang.String _generateDocumentURI( RMObjectStore aoRMObjectStore,
  2. java.lang.String asURI)
  3. throws RMException
Returns a String Document URI obtained by modifying the URI (XML String) passed by a user while record declaration. The input URI string contains the document ID and registration ID of the implementation class This method reads the server name, repository type, and repository name of the implementation class corresponding to the registration ID and adds new nodes to the XML for each property. The generated XML String (URI) is send to connector.
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asURI - URI, XML String send by user to declare a Document
Returns:
String URI, modified XML String
Throws:
RMException - If any error occurs, an RMException is raised.

getRegistrationClass

  1. public com.filenet.wcm.api.CustomObject getRegistrationClass( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRegistraionID)
  3. throws RMException
Returns an RM custom object of type ConnectorRegistration that is retrieved from an RM object store using the ID of this custom object.
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asRegistraionID - The GUID of the ConnectorRegistration Object
Returns:
CustomObject The RM custom object of type ConnectorRegistration
Throws:
RMException - If any error occurs, an RMException is raised.

_getRegistrationClass

  1. public static com.filenet.wcm.api.CustomObject _getRegistrationClass( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRegistraionID)
  3. throws RMException
Returns an RM custom object of type ConnectorRegistration that is retrieved from an RM object store using the ID of this custom object.
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asRegistraionID - The GUID of the ConnectorRegistration Object
Returns:
CustomObject The RM custom object of type ConnectorRegistration
Throws:
RMException - If any error occurs, an RMException is raised.

getConnectorRegistrationClass

  1. public com.filenet.wcm.api.CustomObject getConnectorRegistrationClass( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL)
  3. throws RMException
Returns a ConnectorRegistration CustomObject retrieved from an RM object store based on the String query passed as parameter
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asQuerySQL - The SQL String
Returns:
CustomObject The ConnectorRegistration CustomObject
Throws:
RMException - If any error occurs, an RMException is raised.

_getConnectorRegistrationClass

  1. public static com.filenet.wcm.api.CustomObject _getConnectorRegistrationClass( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL)
  3. throws RMException
Returns a ConnectorRegistration CustomObject retrieved from an RM object store based on the String query passed as parameter
Parameters:
aoRMObjectStore - The object store where ConnectorRegistration exists
asQuerySQL - The SQL String
Returns:
CustomObject The ConnectorRegistration CustomObject
Throws:
RMException - If any error occurs, an RMException is raised.

getResultSet

  1. public java.lang.String getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL)
  3. throws RMException
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getResultSet

  1. public static java.lang.String _getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL)
  3. throws RMException
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getLimitedResultSet

  1. public java.lang.String getLimitedResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiMaxRecords)
  4. throws RMException
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store and retricts the result set as per the input parameter aiMaxRecords.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiMaxRecords - Limits the result set to be returned by the sql query.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getLimitedResultSet

  1. public static java.lang.String _getLimitedResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiMaxRecords)
  4. throws RMException
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store and retricts the result set as per the input parameter aiMaxRecords.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiMaxRecords - Limits the result set to be returned by the sql query.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getResultSet

  1. public java.lang.String getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store.
Parameters:
aoRMObjectStore - The RM ObjectStore where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int value that represents the base object type to be searched.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getResultSet

  1. public static java.lang.String _getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store.
Parameters:
aoRMObjectStore - The RM ObjectStore where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int value that represents the base object type to be searched.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getResultSet

  1. public java.lang.String getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResults)
  5. throws RMException
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store and retricts the result set as per the input parameter aiMaxResults.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
aiMaxResults - Limits the result set to be returned by the sql query.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getResultSet

  1. public static java.lang.String _getResultSet( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResults)
  5. throws RMException
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store and retricts the result set as per the input parameter aiMaxResults.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
aiMaxResults - Limits the result set to be returned by the sql query.
Returns:
The result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getResultSet

  1. public java.lang.String getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns the String XML result set obtained by executing the query passed as parameter asQuerySQL for an object store.
Parameters:
aoObjectStore - The object store where a query is to be executed.
asQuerySQL - The Sql query String
aiBaseType - An int that represents the base object type to be searched.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getResultSet

  1. public static java.lang.String _getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns the String XML result set obtained by executing the query passed as parameter asQuerySQL for an object store.
Parameters:
aoObjectStore - The object store where a query is to be executed.
asQuerySQL - The Sql query String
aiBaseType - An int that represents the base object type to be searched.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getResultSet

  1. public java.lang.String getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResults)
  5. throws RMException
Returns a String XML result set obtained by executing a the query passed as parameter asQuerySQL for an object store and retricts the ResultSet as per the input parameter aiMaxResults.
Parameters:
aoObjectStore - The object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
aiMaxResults - Limits the result set to be returned by the sql query.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

_getResultSet

  1. public static java.lang.String _getResultSet( com.filenet.wcm.api.ObjectStore aoObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResults)
  5. throws RMException
Returns a String XML result set obtained by executing a the query passed as parameter asQuerySQL for an object store and retricts the ResultSet as per the input parameter aiMaxResults.
Parameters:
aoObjectStore - The object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
aiMaxResults - Limits the result set to be returned by the sql query.
Returns:
A result set XML String.
Throws:
RMException - In case of any error, an RMException will be raised.

getQueriedObjects

  1. public com.filenet.wcm.api.BaseObjects getQueriedObjects( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
Returns:
A BaseObjects collection.
Throws:
RMException - In case of any error, an RMException will be raised.

_getQueriedObjects

  1. public static com.filenet.wcm.api.BaseObjects _getQueriedObjects( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType)
  4. throws RMException
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that represents the base object type to be searched.
Returns:
A BaseObjects collection.
Throws:
RMException - In case of any error, an RMException will be raised.

getQueriedObjects

  1. public com.filenet.wcm.api.BaseObjects getQueriedObjects( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResult)
  5. throws RMException
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store and retricts the ResultSet as per the input parameter aiMaxResult.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that representing the base object type to be searched.
aiMaxResult - Limits the result set to be returned by the sql query.
Returns:
A BaseObjects collection.
Throws:
RMException - In case of any error, an RMException will be thrown.

_getQueriedObjects

  1. public static com.filenet.wcm.api.BaseObjects _getQueriedObjects( RMObjectStore aoRMObjectStore,
  2. java.lang.String asQuerySQL,
  3. int aiBaseType,
  4. int aiMaxResult)
  5. throws RMException
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store and retricts the ResultSet as per the input parameter aiMaxResult.
Parameters:
aoRMObjectStore - The RM object store where a query is to be executed.
asQuerySQL - The Sql query String.
aiBaseType - An int that representing the base object type to be searched.
aiMaxResult - Limits the result set to be returned by the sql query.
Returns:
A BaseObjects collection.
Throws:
RMException - In case of any error, an RMException will be thrown.

getRecordURI

  1. public java.lang.String getRecordURI( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRecordId)
  3. throws RMException
Returns a URI string for the record
Parameters:
aoRMObjectStore - The object store where a record is to be found.
asRecordId - The ID of a record to be added.
Returns:
String URI, which is a modified XML string.
Throws:
RMException - If any error occurs, an RMException is thrown.

_getRecordURI

  1. public static java.lang.String _getRecordURI( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRecordId)
  3. throws RMException
Returns a URI string for the record
Parameters:
aoRMObjectStore - The object store where a record is to be found.
asRecordId - The ID of a record to be added.
Returns:
String URI, which is a modified XML string.
Throws:
RMException - If any error occurs, an RMException is thrown.

writeXML

  1. public java.lang.String writeXML( org.w3c.dom.Node aoNode)
  2. throws RMException
Deprecated. Use _writeXML(Node aoNode) instead of this method.
Returns an XML string representing the node passed as parameter. Users can pass an XML document object, which extends the Node interface to obtain complete XML content.
Parameters:
aoNode - The Node object to be obtained as string.
Returns:
String The XML string representing the Node object.
Throws:
RMException - If any error occurs, an RMException is thrown.

_writeXML

  1. public static java.lang.String _writeXML( org.w3c.dom.Node aoNode)
  2. throws RMException
Returns an XML string representing the node passed as parameter. Users can pass an XML document object, which extends the Node interface to obtain complete XML content.
Parameters:
aoNode - The Node object to be obtained as string.
Returns:
String The XML string representing the Node object.
Throws:
RMException - If any error occurs, an RMException is thrown.

checkPattern

  1. public boolean checkPattern(java.lang.String asBaseName,
  2. java.lang.String asPattern)
Deprecated. Use _checkPattern(String asBaseName, String asPattern) instead of this method.
Validates whether a string name that is passed in the asBaseName parameter is valid as per the pattern specified by the asPattern paramter.
Parameters:
asBaseName - The base name to be validated
asPattern - The pattern on which the base name is to be validated
Returns:
true, if base name matches the pattern; otherwise false.

_checkPattern

  1. public static boolean _checkPattern( java.lang.String asBaseName,
  2. java.lang.String asPattern)
Validates whether a string name that is passed in the asBaseName parameter is valid as per the pattern specified by the asPattern paramter.
Parameters:
asBaseName - The base name to be validated
asPattern - The pattern on which the base name is to be validated
Returns:
true, if base name matches the pattern; otherwise false.

locateRecord

  1. public RecordInfo locateRecord( java.lang.String asURI)
  2. throws RMException
Deprecated. Use _locateRecord(String asURI) instead of this method.
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
Parameters:
asURI - An XML URI string that contains record specific information. It must be in valid XML as specified by the Record URI XMl format.
Returns:
RecordInfo The RecordInfo object that is found for the passed asURI parameter.
Throws:
RMException - if any error occurs, an RMException is thrown.

_locateRecord

  1. public static RecordInfo _locateRecord( java.lang.String asURI)
  2. throws RMException
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
Parameters:
asURI - An XML URI string that contains record specific information. It must be in valid XML as specified by the Record URI XMl format.
Returns:
RecordInfo The RecordInfo object that is found for the passed asURI parameter.
Throws:
RMException - if any error occurs, an RMException is thrown.

getClassIDs

  1. public java.lang.String[] getClassIDs( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns a String array of the ClassIds of all the RM entities whose RM type is passed in the int array as a parameter. If abInculdeSubClasses is passed as true, IDs of all the subclasses are also included.
Parameters:
aoRMObjectStore - The RMObjectStore where Classes are defined
aiEntityTypes - An int array of entities whose GUIDs are to be retrieved
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included
Returns:
String[] An array of GUIDS
Throws:
RMException - If any error occurs, an RMException is thrown.

_getClassIDs

  1. public static java.lang.String[] _getClassIDs( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns a String array of the ClassIds of all the RM entities whose RM type is passed in the int array as a parameter. If abInculdeSubClasses is passed as true, IDs of all the subclasses are also included.
Parameters:
aoRMObjectStore - The RMObjectStore where Classes are defined
aiEntityTypes - An int array of entities whose GUIDs are to be retrieved
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included
Returns:
String[] An array of GUIDS
Throws:
RMException - If any error occurs, an RMException is thrown.

getClassDescriptions

  1. public com.filenet.wcm.api.ClassDescriptions getClassDescriptions( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns the collection of the ClassDescription of all the RM types which are passed in the int array as a parameter. If abInculdeSubClasses is passed as true, the IDs of all the ClassDescription of the subclasses are also included.
Parameters:
aoRMObjectStore - The RMObjectStore from where ClassDescriptions are to be retrieved.
aiEntityTypes - An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included.
Returns:
A collection of the ClassDescription objects.
Throws:
RMException - If any error occurs, an RMException is thrown.

_getClassDescriptions

  1. public static com.filenet.wcm.api.ClassDescriptions _getClassDescriptions( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns the collection of the ClassDescription of all the RM types which are passed in the int array as a parameter. If abInculdeSubClasses is passed as true, the IDs of all the ClassDescription of the subclasses are also included.
Parameters:
aoRMObjectStore - The RMObjectStore from where ClassDescriptions are to be retrieved.
aiEntityTypes - An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included.
Returns:
A collection of the ClassDescription objects.
Throws:
RMException - If any error occurs, an RMException is thrown.

getClassDescriptionsXML

  1. public java.lang.String getClassDescriptionsXML( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns a String in XML that represents the class descriptions for Content Engine classes and their subclasses.
Parameters:
aoRMObjectStore - The RMObjectStore from where ClassDescriptions are to be retrieved.
aiEntityTypes - An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included.
Returns:
A String that represents the ClassDescriptions XML.
Throws:
RMException - If any error occurs, an RMException is thrown.

_getClassDescriptionsXML

  1. public static java.lang.String _getClassDescriptionsXML( RMObjectStore aoRMObjectStore,
  2. int[] aiEntityTypes,
  3. boolean abInculdeSubClasses)
  4. throws RMException
Returns a String in XML that represents the class descriptions for Content Engine classes and their subclasses.
Parameters:
aoRMObjectStore - The RMObjectStore from where ClassDescriptions are to be retrieved.
aiEntityTypes - An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.
abInculdeSubClasses - A boolean flag to indicate whether subclasses are to be included.
Returns:
A String that represents the ClassDescriptions XML.
Throws:
RMException - If any error occurs, an RMException is thrown.

getPropertyDescriptionXML

  1. public java.lang.String getPropertyDescriptionXML( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType)
  3. throws RMException
Returns a String in XML that represents property descriptions for the specified classes, by filtering out hidden property descriptions based on type.
Parameters:
aoClassDescription - The ClassDescription whose property descriptions need to be retrieved
asFilterType - The string representing the type of PropertyDescription.
Returns:
An XML string
Throws:
RMException - If an error occurs, an RMException is thrown.

_getPropertyDescriptionXML

  1. public static java.lang.String _getPropertyDescriptionXML( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType)
  3. throws RMException
Returns a String in XML that represents property descriptions for the specified classes, by filtering out hidden property descriptions based on type.
Parameters:
aoClassDescription - The ClassDescription whose property descriptions need to be retrieved
asFilterType - The string representing the type of PropertyDescription.
Returns:
An XML string
Throws:
RMException - If an error occurs, an RMException is thrown.

getPropertyDescriptionXML

  1. public java.lang.String getPropertyDescriptionXML( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType,
  3. RMRecordContainer aoContainer)
  4. throws RMException
Returns a XML string of the property descriptions filtered out by the type of property descriptions The xml string also includes the Record Pattern associated with the aoContainer.
Parameters:
aoClassDescription - The ClassDescription whose property descriptions need to be retrieved
asFilterType - The string representing the type of PropertyDescription.
aoContainer - The RecordContainer on which the Record Pattern has been applied.
Returns:
An XML string
Throws:
RMException - If an error occurs, an RMException is thrown.

_getPropertyDescriptionXML

  1. public static java.lang.String _getPropertyDescriptionXML( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType,
  3. RMRecordContainer aoContainer)
  4. throws RMException
Returns a XML string of the property descriptions filtered out by the type of property descriptions The xml string also includes the Record Pattern associated with the aoContainer.
Parameters:
aoClassDescription - The ClassDescription whose property descriptions need to be retrieved
asFilterType - The string representing the type of PropertyDescription.
aoContainer - The RecordContainer on which the Record Pattern has been applied.
Returns:
An XML string
Throws:
RMException - If an error occurs, an RMException is thrown.

getPropertyDescriptions

  1. public com.filenet.wcm.api.PropertyDescriptions getPropertyDescriptions( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType)
  3. throws RMException
Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes by filtering out property descriptions based on type.
Parameters:
aoClassDescription - A ClassDescriptions collection containing the ClassDescription objects for which PropertyDescription objects are requested.
asFilterType - The string representing the type of PropertyDescription
Returns:
A PropertyDescriptions collection that contains the property descriptions for the requested classes
Throws:
RMException - If an error occurs, an RMException is thrown.

_getPropertyDescriptions

  1. public static com.filenet.wcm.api.PropertyDescriptions _getPropertyDescriptions( com.filenet.wcm.api.ClassDescription aoClassDescription,
  2. java.lang.String asFilterType)
  3. throws RMException
Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes by filtering out property descriptions based on type.
Parameters:
aoClassDescription - A ClassDescriptions collection containing the ClassDescription objects for which PropertyDescription objects are requested.
asFilterType - The string representing the type of PropertyDescription
Returns:
A PropertyDescriptions collection that contains the property descriptions for the requested classes
Throws:
RMException - If an error occurs, an RMException is thrown.

addNode

  1. public java.lang.String addNode( java.lang.String asURI,
  2. java.lang.String asKeyName,
  3. java.lang.String asValue)
  4. throws RMException
Deprecated. Use _addNode(String asURI, String asKeyName, String asValue) instead of this method.
Add Nodes to the XML String passed as parameter. The name of the node is specified by asKeyName and the node value is specified by the asValue parameters.
Parameters:
asURI - The XML String to be modified
asKeyName - The name of the node to be added
asValue - The value of the node to be added
Returns:
A Modified XML String
Throws:

_addNode

  1. public static java.lang.String _addNode( java.lang.String asURI,
  2. java.lang.String asKeyName,
  3. java.lang.String asValue)
  4. throws RMException
Add Nodes to the XML String passed as parameter. The name of the node is specified by asKeyName and the node value is specified by the asValue parameters.
Parameters:
asURI - The XML String to be modified
asKeyName - The name of the node to be added
asValue - The value of the node to be added
Returns:
A Modified XML String
Throws:

addNode

  1. public java.lang.String addNode( java.lang.String asURI,
  2. java.util.Map aoMap)
  3. throws RMException
Deprecated. Use _addNode(String asURI, Map aoMap) instead of this method.
Adds mulitiple nodes to the XML String passed as a parameter. All the 'keys' in the map are added as nodes and the corresponding 'values' are added as values to these nodes.
Parameters:
asURI - The XML String to be modified
aoMap - The map containing the keys to be added
Returns:
A Modified XML String
Throws:
RMException - If an error occurs, an RMException is thrown.

_addNode

  1. public static java.lang.String _addNode( java.lang.String asURI,
  2. java.util.Map aoMap)
  3. throws RMException
Adds mulitiple nodes to the XML String passed as a parameter. All the 'keys' in the map are added as nodes and the corresponding 'values' are added as values to these nodes.
Parameters:
asURI - The XML String to be modified
aoMap - The map containing the keys to be added
Returns:
A Modified XML String
Throws:
RMException - If an error occurs, an RMException is thrown.

removeNode

  1. public java.lang.String removeNode( java.lang.String asURI,
  2. java.lang.String asKeyName)
  3. throws RMException
Deprecated. Use _removeNode(String asURI, String asKeyName) instead of this method.
Removes the node from the XML String passed as a parameter whose name is specified by the key name.
Parameters:
asURI - The XML String to be modified
asKeyName - The name of the node to be removed
Returns:
A Modified XML String
Throws:
RMException - If an error occurs, an RMException is thrown.

_removeNode

  1. public static java.lang.String _removeNode( java.lang.String asURI,
  2. java.lang.String asKeyName)
  3. throws RMException
Removes the node from the XML String passed as a parameter whose name is specified by the key name.
Parameters:
asURI - The XML String to be modified
asKeyName - The name of the node to be removed
Returns:
A Modified XML String
Throws:
RMException - If an error occurs, an RMException is thrown.

validateDate

  1. public boolean validateDate(java.lang.String asDate,
  2. java.lang.String asFormat)
Deprecated. Use _validateDate(String asDate, String asFormat) instead of this method.
Returns true or false if the Date passed as String is as per the format passed as parameter
Parameters:
asDate - The String value for date
asFormat - The String representing the format
Returns:
true or false, if date can be parsed as per specified format

_validateDate

  1. public static boolean _validateDate( java.lang.String asDate,
  2. java.lang.String asFormat)
Returns true or false if the Date passed as String is as per the format passed as parameter
Parameters:
asDate - The String value for date
asFormat - The String representing the format
Returns:
true or false, if date can be parsed as per specified format

getCollection

  1. public java.util.Collection getCollection( java.lang.String[] asArrString)
  2. throws RMException
Deprecated. Use _getCollection(String[] asArrString) instead of this method.
Returns a collection of String objects for a String array
Parameters:
asArrString - A StringArray
Returns:
A Collection object
Throws:
RMException - If an error occurs, an RMException is thrown.

_getCollection

  1. public static java.util.Collection _getCollection( java.lang.String[] asArrString)
  2. throws RMException
Returns a collection of String objects for a String array
Parameters:
asArrString - A StringArray
Returns:
A Collection object
Throws:
RMException - If an error occurs, an RMException is thrown.

getUserId

  1. public java.lang.String getUserId( RMObjectStore aoRMObjectStore)
  2. throws RMException
Deprecated. Use _getUserId(RMObjectStore aoRMObjectStore) instead of this method.
Returns the UserId of the User who is logged on to the current instance of an object store.
Parameters:
aoRMObjectStore - The RMObjectStore to which a user is logged on.
Returns:
String The UserId
Throws:
RMException - If an error occurs, an RMException is thrown.

getUsernameFromFullName

  1. public static java.lang.String getUsernameFromFullName( java.lang.String fullName)
Get the short username from possible full username. Used by RMBatchAction.java, RMNavigationDataProvider.java and RMSearchDataProvider.java.
Returns:
the short username, like "Administrator"

_getUserId

  1. public static java.lang.String _getUserId( RMObjectStore rmObjStore)
  2. throws RMException
Returns the "ShortName" property for the user currently associated with the Buzz Session that is associated with the given RMObjectStore instance.
Parameters:
rmObjStore - The RMObjectStore to extract a Buzz Session from.
Returns:
the "ShortName" property string value belonging to the current user.
Throws:

getUserIdWithDomain

  1. public java.lang.String getUserIdWithDomain( RMObjectStore aoRMObjectStore)
  2. throws RMException
Deprecated. Use _getUserIdWithDomain(RMObjectStore aoRMObjectStore) instead of this method.
Returns a String specifying the complete domain name of a User who is logged on to the current instance of an object store.
Parameters:
aoRMObjectStore - The RMObjectStore to which a user is logged on.
Returns:
String The UserId
Throws:
RMException - If an error occurs, an RMException is thrown.

_getUserIdWithDomain

  1. public static java.lang.String _getUserIdWithDomain( RMObjectStore aoRMObjectStore)
  2. throws RMException
Returns a String specifying the complete domain name of a User who is logged on to the current instance of an object store.
Parameters:
aoRMObjectStore - The RMObjectStore to which a user is logged on.
Returns:
String The UserId
Throws:
RMException - If an error occurs, an RMException is thrown.

getObjectStoreXML

  1. public java.lang.String getObjectStoreXML( com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use _getObjectStoreXML(ObjectStores aoObjectStores) instead of this method.
Returns a String that contains an XML representation of the object stores The XML representation includes only those object stores that are valid FPOS.
Parameters:
aoObjectStores - An ObjectStore collection
Returns:
An XML string

_getObjectStoreXML

  1. public static java.lang.String _getObjectStoreXML( com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns a String that contains an XML representation of the object stores The XML representation includes only those object stores that are valid FPOS.
Parameters:
aoObjectStores - An ObjectStore collection
Returns:
An XML string

getObjectStoreXML

  1. public java.lang.String getObjectStoreXML( com.filenet.wcm.api.ObjectStores aoObjectStores,
  2. java.lang.String[] asArrProps)
Returns a string that contains an XML representation of the object stores (and their properties, specified as symbolic names). The XML representation includes only those object stores that are valid FPOS.
Parameters:
aoObjectStores - An ObjectStore collection.
asArrProps - A String array whose elements specify the symbolic names of the properties to return.
Returns:
An XML string

_getObjectStoreXML

  1. public static java.lang.String _getObjectStoreXML( com.filenet.wcm.api.ObjectStores aoObjectStores,
  2. java.lang.String[] asArrProps)
Returns a string that contains an XML representation of the object stores (and their properties, specified as symbolic names). The XML representation includes only those object stores that are valid FPOS.
Parameters:
aoObjectStores - An ObjectStore collection.
asArrProps - A String array whose elements specify the symbolic names of the properties to return.
Returns:
An XML string

getRMObjectStore

  1. public RMObjectStore getRMObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Deprecated. Use _getRMObjectStore(ObjectStore aoObjectStore) instead of this method.
Returns an instance of RMObjectStore for an object store. If the object store is not a valid File Plan object store, an exception is raised.
Parameters:
aoObjectStore - The object store for which the RMobjectStore handle is to be obtained.
Returns:
An RMObjectStore instance
Throws:
RMException - if object is not a valid FPOS, an RMException is thrown.

_getRMObjectStore

  1. public static RMObjectStore _getRMObjectStore( com.filenet.wcm.api.ObjectStore aoObjectStore)
  2. throws RMException
Returns an instance of RMObjectStore for an object store. If the object store is not a valid File Plan object store, an exception is raised.
Parameters:
aoObjectStore - The object store for which the RMobjectStore handle is to be obtained.
Returns:
An RMObjectStore instance
Throws:
RMException - if object is not a valid FPOS, an RMException is thrown.

getConnectorQueryString

  1. public java.lang.String getConnectorQueryString( java.lang.String asRepositoryType,
  2. java.lang.String asRepositoryName,
  3. java.lang.String asServerName)
Returns a query string to retrieve the connector registration object. Connector registration object represents the Records Object Store (ROS) where the document exists and is an RMCustomObject object of type ConnectorRegistration.
Parameters:
asRepositoryType - A String that represents the documents repository type. For this release it can only be CE.
asServerName - A String that represents the documents repository server URL. If the asRepositoryType is CE, asServerName has to be the remote server URL of CE. For this release this variable will be ignored in this method, so you can pass in null value.
asRepositoryName - A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE, the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.
Returns:
A SQL query string.

_getConnectorQueryString

  1. public static java.lang.String _getConnectorQueryString( java.lang.String asRepositoryType,
  2. java.lang.String asRepositoryName,
  3. java.lang.String asServerName)
Returns a query string to retrieve the connector registration object. Connector registration object represents the Records Object Store (ROS) where the document exists and is an RMCustomObject object of type ConnectorRegistration.
Parameters:
asRepositoryType - A String that represents the documents repository type. For this release it can only be CE.
asServerName - A String that represents the documents repository server URL. If the asRepositoryType is CE, asServerName has to be the remote server URL of CE. For this release this variable will be ignored in this method, so you can pass in null value.
asRepositoryName - A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE, the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.
Returns:
A SQL query string.

getMergedXML

  1. public java.lang.String getMergedXML( java.lang.String aoReaderXMLIDCheck,
  2. java.lang.String aoReaderXMLToBeReplaced,
  3. java.lang.String aoXSLFile)
Invokes the XSLT transformation on the XML DOM document represented by the aoReaderXMLIDCheck string. Additionally, this method passes the XML DOM document represented by the aoReaderXMLToBeReplaced string as a parameter. The XSLT transformation returns an XML string that is processed as per the transformation logic provided in the XSL.
Parameters:
aoReaderXMLIDCheck - An XML document in String format on which the XSLT transformation is to be invoked.
aoReaderXMLToBeReplaced - An XML document in String format to be used in the XSLT transformation and is passed as a parameter to the transformer.
aoXSLFile - The XSL file name with path, which signifies the transformation to be applied.
Returns:
A string that represents the filtered results on the basis of the transformation applied.

_getMergedXML

  1. public static java.lang.String _getMergedXML( java.lang.String aoReaderXMLIDCheck,
  2. java.lang.String aoReaderXMLToBeReplaced,
  3. java.lang.String aoXSLFile)
Invokes the XSLT transformation on the XML DOM document represented by the aoReaderXMLIDCheck string. Additionally, this method passes the XML DOM document represented by the aoReaderXMLToBeReplaced string as a parameter. The XSLT transformation returns an XML string that is processed as per the transformation logic provided in the XSL.
Parameters:
aoReaderXMLIDCheck - An XML document in String format on which the XSLT transformation is to be invoked.
aoReaderXMLToBeReplaced - An XML document in String format to be used in the XSLT transformation and is passed as a parameter to the transformer.
aoXSLFile - The XSL file name with path, which signifies the transformation to be applied.
Returns:
A string that represents the filtered results on the basis of the transformation applied.

getMerged

  1. public com.filenet.wcm.api.BaseObjects getMerged( java.util.ArrayList aoIDCheck,
  2. com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
Filters those documents from the aoToBeReplacedRecord BaseObjects collection that are not contained in the aoIDCheck collection.
Parameters:
aoIDCheck - An array list containing the record IDs.
aoToBeReplacedRecord - BaseObjects A collection that needs to be filtered for those documents that are not present in aoIDCheck.
Returns:
A filtered BaseObjects collection

_getMerged

  1. public static com.filenet.wcm.api.BaseObjects _getMerged( java.util.ArrayList aoIDCheck,
  2. com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
Filters those documents from the aoToBeReplacedRecord BaseObjects collection that are not contained in the aoIDCheck collection.
Parameters:
aoIDCheck - An array list containing the record IDs.
aoToBeReplacedRecord - BaseObjects A collection that needs to be filtered for those documents that are not present in aoIDCheck.
Returns:
A filtered BaseObjects collection

getMergedROSOR

  1. public java.util.ArrayList getMergedROSOR( java.util.ArrayList aoRecordID1,
  2. java.util.ArrayList aoRecordID2)
Deprecated. Use _getMergedROSOR(ArrayList aoRecordID1, ArrayList aoRecordID2) instead of this method.
Returns a union of the record IDs as specified in the input parameters.
Parameters:
aoRecordID1 - A collection that contains the record IDs.
aoRecordID2 - A collection that contains the record IDs.
Returns:
A filtered (ORed) collection.

_getMergedROSOR

  1. public static java.util.ArrayList _getMergedROSOR( java.util.ArrayList aoRecordID1,
  2. java.util.ArrayList aoRecordID2)
Returns a union of the record IDs as specified in the input parameters.
Parameters:
aoRecordID1 - A collection that contains the record IDs.
aoRecordID2 - A collection that contains the record IDs.
Returns:
A filtered (ORed) collection.

getNewDocument

  1. public org.w3c.dom.Document getNewDocument( )
  2. throws javax.xml.parsers.ParserConfigurationException
Deprecated. Use _getNewDocument() instead of this method.
Returns an empty Document object that is obtained from the Document Builder factory
Returns:
A Document object
Throws:
javax.xml.parsers.ParserConfigurationException - if an error occurs, the ParserConfigurationException is thrown.

_getNewDocument

  1. public static org.w3c.dom.Document _getNewDocument( )
  2. throws javax.xml.parsers.ParserConfigurationException
Returns an empty Document object that is obtained from the Document Builder factory
Returns:
A Document object
Throws:
javax.xml.parsers.ParserConfigurationException - if an error occurs, the ParserConfigurationException is thrown.

getDocumentStore

  1. public DocumentStore getDocumentStore( java.lang.Object aoObject)
  2. throws RMException
Deprecated. Use _getDocumentStore(Object aoObject) instead of this method.
Returns an instance of DocumentStore for the object store, which is passed as a parameter.
Parameters:
aoObject - The object store for which the DocumentStore handle is to be obtained.
Returns:
A DocumentStore instance.
Throws:
RMException - In case of any error an RMException will be thrown.

_getDocumentStore

  1. public static DocumentStore _getDocumentStore( java.lang.Object aoObject)
  2. throws RMException
Returns an instance of DocumentStore for the object store, which is passed as a parameter.
Parameters:
aoObject - The object store for which the DocumentStore handle is to be obtained.
Returns:
A DocumentStore instance.
Throws:
RMException - In case of any error an RMException will be thrown.

auditEvent

  1. public void auditEvent(RMObject aoRMObject,
  2. java.lang.String asReason,
  3. java.lang.String asActionType,
  4. java.lang.String asDescription,
  5. java.lang.String asLastReviewedBy,
  6. int aiEventStatus)
Audits the event based upon the value of Action type. The action type can be Review, Relocate, Export, Transfer, Interim Transfer. It also Audits the delete event. The delete action may occur because of direct delete method call on an RM entity, or when delete method is called from the destroy method. The reason for delete will also be audited along with the action type i.e. whether the action is delete or destroy.
Parameters:
aoRMObject - An RMObject with which an Audit is to be associated.
asReason - Reason for the Audit action performed.
asActionType - Type of audit action performed. The action type can be Review, Relocate, Export, Transfer, Interim Transfer, Delete or Destroy.
asDescription - A String that represents the description for the audit operation.

_auditEvent

  1. public static void _auditEvent( RMObject aoRMObject,
  2. java.lang.String asReason,
  3. java.lang.String asActionType,
  4. java.lang.String asDescription,
  5. java.lang.String asLastReviewedBy,
  6. int aiEventStatus)
Audits the event based upon the value of Action type. The action type can be Review, Relocate, Export, Transfer, Interim Transfer. It also Audits the delete event. The delete action may occur because of direct delete method call on an RM entity, or when delete method is called from the destroy method. The reason for delete will also be audited along with the action type i.e. whether the action is delete or destroy.
Parameters:
aoRMObject - An RMObject with which an Audit is to be associated.
asReason - Reason for the Audit action performed.
asActionType - Type of audit action performed. The action type can be Review, Relocate, Export, Transfer, Interim Transfer, Delete or Destroy.
asDescription - A String that represents the description for the audit operation.

validateDisposition

  1. public void validateDisposition( DisposableObject aoDisposableObject)
Deprecated. Use _validateDisposition(DisposableObject aoDisposableObject) instead of this method.
Validates whether the entity passed as input parameter can be disposed or not. Various business validations are performed on the RM entity on which disposition is to be performed.
Parameters:
aoDisposableObject - A DisposableObject object on which disposition is to be initiated.

_validateDisposition

  1. public static void _validateDisposition( DisposableObject aoDisposableObject)
Validates whether the entity passed as input parameter can be disposed or not. Various business validations are performed on the RM entity on which disposition is to be performed.
Parameters:
aoDisposableObject - A DisposableObject object on which disposition is to be initiated.

getFormattedString

  1. public static java.lang.String getFormattedString( java.lang.String asStringValue)
Formats the passed String by replacing characters like &,',<,> with filter operators.
Parameters:
asStringValue - String which is to be formatted
Returns:
A Modified String that has been formatted.

DecodeFormattedString

  1. public static java.lang.String DecodeFormattedString( java.lang.String asStringValue)
Decode the passed String by replacing strings like &,<,> with filter operators.
Parameters:
asStringValue - String which is to be decoded.
Returns:
A Modified String that has been decoded.

replaceAll

  1. public static java.lang.String replaceAll( java.lang.String acSpecialCh,
  2. java.lang.String asReplaceBy,
  3. java.lang.String asMainStr)
Returns String after replacing characters with the provided characters.
Parameters:
acSpecialCh - String reperesenting characters to be replaced.
asReplaceBy - String reperesenting new characters to be replaced with.
asMainStr - String on which the action is to be performed.
Returns:
A Modified String in which the characters are replaced with new characters.

getCurrentPhaseExecutionDate

  1. public java.util.Date getCurrentPhaseExecutionDate( DisposableObject aoRMObject)
Deprecated. Use _getCurrentPhaseExecutionDate(DisposableObject aoRMObject) instead of this method.
Calculates the current phase executution date for an entity
Parameters:
aoRMObject - DisposableObject An entity for which the current phase execution date is to be calculated.
Returns:
Date calculated as the Current Phase Execution Date

_getCurrentPhaseExecutionDate

  1. public static java.util.Date _getCurrentPhaseExecutionDate( DisposableObject aoRMObject)
Calculates the current phase executution date for an entity
Parameters:
aoRMObject - DisposableObject An entity for which the current phase execution date is to be calculated.
Returns:
Date calculated as the Current Phase Execution Date

getActingDisposalSchedule

  1. public DispositionAllocatableObject getActingDisposalSchedule( RMObject aoRMObject)
Deprecated. Use _getActingDisposalSchedule(RMObject aoRMObject) instead of this method.
Returns the entity with which a disposal schedule is associated or cut-off data is inherited.
Parameters:
aoRMObject - An entity for which DispositionAllocatableObject is to be fetched.
Returns:
DispositionAllocatableObject An entity with which a disposal schedule is associated or cut-off data is inherited.

_getActingDisposalSchedule

  1. public static DispositionAllocatableObject _getActingDisposalSchedule( RMObject aoRMObject)
Returns the entity with which a disposal schedule is associated or cut-off data is inherited.
Parameters:
aoRMObject - An entity for which DispositionAllocatableObject is to be fetched.
Returns:
DispositionAllocatableObject An entity with which a disposal schedule is associated or cut-off data is inherited.

checkForInteger

  1. protected boolean checkForInteger( java.lang.Integer aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)

_checkForInteger

  1. protected static boolean _checkForInteger( java.lang.Integer aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)
Compares the int value of the Integer object passed in the input parameter with the corresponding value contained in the String passed as parameter based on the operator parameter. If the specified condtion is satisfied, it returns true otherwise false.
Parameters:
aoValue - The integer object to be compared.
aoOperator - The int value representing an operator.
asCompareValue - The value against which a comparison is to be performed.
Returns:
true if the specified condition is satisfied; otherwise false.

checkForDate

  1. protected boolean checkForDate( java.util.Date aoValue,
  2. int aoOperator,
  3. java.lang.String aoCompareValue)

_checkForDate

  1. protected static boolean _checkForDate( java.util.Date aoValue,
  2. int aoOperator,
  3. java.lang.String aoCompareValue)
Compares the Date object passed as the aoValue parameter with the corresponding String value passed as the aoCompareValue parameter based on the aoOperator parameter. If the specified condition is satisfied, it returns true; otherwise false.
Parameters:
aoValue - The Date object to be compared
aoOperator - The Int value representing an operator
aoCompareValue - The value against which a comparison is to be performed. The value must be passed in the java date format, "EEE MMM dd HH:mm:ss zzz yyyy"
Returns:
true if the condition is satisfied; otherwise false.

checkForString

  1. protected boolean checkForString( java.lang.String aoValue,
  2. int aoOperator,
  3. java.lang.String aoCompareValue)

_checkForString

  1. protected static boolean _checkForString( java.lang.String aoValue,
  2. int aoOperator,
  3. java.lang.String aoCompareValue)
Compares the String object passed as the aoValue parameter with the corresponding String value passed as the aoCompareValue parameter based on the aoOperator parameter. If the specified condition is satisfied, it returns true; otherwise false.
Parameters:
aoValue - The String object to be compared
aoOperator - The Int value representing an operator
aoCompareValue - The value against which a comparison is to be performed.
Returns:
true if the condition is satisfied; otherwise false.

checkForObject

  1. protected boolean checkForObject( java.lang.Object aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)

_checkForObject

  1. protected static boolean _checkForObject( java.lang.Object aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)
Compares the object passed in the aoValue parameter with the corresponding value string passed as the asCompareValue parameter based on the aoOperator parameter. If the specified condtion is satisfied, it returns true; otherwise false.
Parameters:
aoValue - The String object to be compared.
aoOperator - The int value reopresenting an operator.
asCompareValue - The value against which a comparison is to be performed.
Returns:
true if the condition is satisfied; otherwise false.

checkForBoolean

  1. protected boolean checkForBoolean( java.lang.Object aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)

_checkForBoolean

  1. protected static boolean _checkForBoolean( java.lang.Object aoValue,
  2. int aoOperator,
  3. java.lang.String asCompareValue)
Compares the object passed in the aoValue parameter with the corresponding value string passed as the asCompareValue parameter based on the aoOperator parameter. If the specified condtion is satisfied, it returns true; otherwise false.
Parameters:
aoValue - The String object to be compared.
aoOperator - The int value representing an operator.
asCompareValue - The value against which a comparison is to be performed.
Returns:
true if the condition is satisfied; otherwise false.

addToDate

  1. public java.util.Date addToDate( java.util.Date aoBaseDate,
  2. int aiYear,
  3. int aiMonth,
  4. int aiDay)
Adds the year, month, and day passed as integers to the Date and returns the Modified Date.
Parameters:
aoBaseDate - The base date to which time is to be added
aiYear - Years to be added
aiMonth - Months to be added
aiDay - Days to be added
Returns:
The Modified date.

_addToDate

  1. public static java.util.Date _addToDate( java.util.Date aoBaseDate,
  2. int aiYear,
  3. int aiMonth,
  4. int aiDay)
Adds the year, month, and day passed as integers to the Date and returns the Modified Date.
Parameters:
aoBaseDate - The base date to which time is to be added
aiYear - Years to be added
aiMonth - Months to be added
aiDay - Days to be added
Returns:
The Modified date.

settingTimeComponentasZero

  1. public static java.util.Date settingTimeComponentasZero( java.util.Date aoDate)
Sets the time component of the date as zero
Parameters:
aoDate - The date to be modified
Returns:
The modified date

_getAllDateProperties

  1. public static java.util.Vector _getAllDateProperties( RMObjectStore aoRMObjectStore)
Retrieves the symbolic names of all the date-type properties of the Folder and Document classes.
Parameters:
aoRMObjectStore - An RMObjectStore
Returns:
Vector containing all the date-type property symbolic names

addRMLog

  1. public void addRMLog(RMObjectStore aoRMObjectStore,
  2. com.filenet.wcm.api.Properties aoProps,
  3. com.filenet.wcm.api.Permissions aoPermissions)
Creates an RMLog object as an instance of RMCustomObject.
Parameters:
aoRMObjectStore - An RM object store in which an RMLog object is to be created.
aoProps - The properties collection for the object to be created.
aoPermissions - The permissions collection for the object to be created.

_addRMLog

  1. public static void _addRMLog(RMObjectStore aoRMObjectStore,
  2. com.filenet.wcm.api.Properties aoProps,
  3. com.filenet.wcm.api.Permissions aoPermissions)
Creates an RMLog object as an instance of RMCustomObject.
Parameters:
aoRMObjectStore - An RM object store in which an RMLog object is to be created.
aoProps - The properties collection for the object to be created.
aoPermissions - The permissions collection for the object to be created.

toStringFromStringArray

  1. public static final java.lang.String toStringFromStringArray( java.lang.String[] asArrString)
Converts the string elements in the string array to a string
Parameters:
asArrString - String Array containing string elements.
Returns:
String cotaining the string elements of StringArray.

addPropertiestoSearchXml

  1. public java.lang.String addPropertiestoSearchXml( java.lang.String asSearchXml,
  2. java.lang.String[] asSymbolicName,
  3. java.lang.String lsClass)
Adds the symbolic name of the Properties to the search XML depending upon the value of lsclass.
Parameters:
asSearchXml - An XML String representation of the values that a user provides at runtime prior to executing the search.
asSymbolicName - Symbolic name of the properties to be added in the exeselectprops tag of the asSearchXml.
lsClass - lsClass can be either ‘document’ or ‘folder’.
Returns:
Modified Search XML with symbolic names of additional properties to be retrieved.

_addPropertiestoSearchXml

  1. public static java.lang.String _addPropertiestoSearchXml( java.lang.String asSearchXml,
  2. java.lang.String[] asSymbolicName,
  3. java.lang.String lsClass)
Adds the symbolic name of the Properties to the search XML depending upon the value of lsclass.
Parameters:
asSearchXml - An XML String representation of the values that a user provides at runtime prior to executing the search.
asSymbolicName - Symbolic name of the properties to be added in the exeselectprops tag of the asSearchXml.
lsClass - lsClass can be either ‘document’ or ‘folder’.
Returns:
Modified Search XML with symbolic names of additional properties to be retrieved.

getPreviewListingOfEntites

  1. public static java.lang.String getPreviewListingOfEntites( RMObjectStore aoRMObjectStore,
  2. java.lang.String[] asSelectClauseProperty,
  3. java.lang.String asConditionXML,
  4. java.lang.String asFilterCriteria,
  5. int aiMaxRecords)
This method returns the XML containig information about the entites depending upon the properties tag contained in the asConditionXML. This method ignore all properties having the value tag as null.
Returns:
An XML String representation of the list of objects that meet the search criteria. The returned XML String is formatted according to the Search XML Schema provided by the CE Java API

getModifiedConditionXML

  1. public static java.lang.String getModifiedConditionXML( RMObjectStore aoRMObjectStore,
  2. java.lang.String asConditionXML)
This method returns the XML after modidfying the Sql tag.
Returns:
An XML String after modifying the sql tag.

getCountFromSingleObjectType

  1. public int getCountFromSingleObjectType( java.lang.String asResultSet)
Deprecated. Use _getCountFromSingleObjectType(String asResultSet) instead of this method.
This method returns the count tag value from the ResultSet. The result set is returned from the call to singleObjectTypeExecuteXML method.
Returns:
integer value represents the number of entites returned in search result. This value is -1 if 'count'tag is not found in the ResultSet or 'count' tag value is null, then this method returns -1.

_getCountFromSingleObjectType

  1. public static int _getCountFromSingleObjectType( java.lang.String asResultSet)
This method returns the count tag value from the ResultSet. The result set is returned from the call to singleObjectTypeExecuteXML method.
Returns:
integer value represents the number of entites returned in search result. This value is -1 if 'count'tag is not found in the ResultSet or 'count' tag value is null, then this method returns -1.

validateDestination

  1. public void validateDestination( RMRecordContainer aoDestination,
  2. RecordInfo loRecord)
  3. throws RMException
Throws:

_validateDestination

  1. public static void _validateDestination( RMRecordContainer aoDestination,
  2. RecordInfo loRecord)
  3. throws RMException
Throws:

containsValue

  1. public boolean containsValue(int[] aiArrValue,
  2. int aiValue)

_containsValue

  1. public static boolean _containsValue( int[] aiArrValue,
  2. int aiValue)

batchFile

  1. public RMBulkOperationResults batchFile( com.filenet.wcm.api.BaseObjects aoBaseObjects,
  2. RMRecordContainer aoRecordContainer)
  3. throws RMException
Throws:

replaceALLInstance

  1. public static java.lang.String replaceALLInstance( java.lang.String asFindStr,
  2. java.lang.String asReplaceBy,
  3. java.lang.String asMainStr)
This method replace all the occurance of asFindStr with asReplaceBy in as MainStr
Returns:
The string from which all the occurance of asFindStr are replaced by the asReplaceBy.

_batchFile

  1. public static RMBulkOperationResults _batchFile( com.filenet.wcm.api.BaseObjects aoBaseObjects,
  2. RMRecordContainer aoRecordContainer)
  3. throws RMException
Throws:

tranferPhaseWithoutAction

  1. public static void tranferPhaseWithoutAction( RMObjectStore aoRMObjectStore,
  2. RMObject aoObject)
  3. throws RMException
This method is used to transfer the phase (having no Current Phase Action )to the next phase.
Parameters:
aoRMObjectStore - RMObjectStore
aoObject - RMObject which have all the disposition data without Current Phase Action.
Throws:
RMException - throws Exception in case any problem.

getROSObjectStore

  1. public com.filenet.wcm.api.ObjectStore getROSObjectStore( RecordInfo loInfo,
  2. com.filenet.wcm.api.Session sess)

getAllObjectStores

  1. public static com.filenet.wcm.api.ObjectStores getAllObjectStores( com.filenet.wcm.api.EntireNetwork loEntireNetwork)
Returns a collection that contains all the object stores in the EntireNetwork. It loops through every Domain object and adds them to the collection.
Parameters:
loEntireNetwork - an instantiated EntireNetwork Object
Returns:
ObjectStores a collection of object stores

getAllObjectStoresXML

  1. public static java.lang.String getAllObjectStoresXML( com.filenet.wcm.api.EntireNetwork loEntireNetwork,
  2. java.lang.String[] propNames)
Returns all the object stores properties in XML form from the EntireNetwork Object
Parameters:
loEntireNetwork - an instantiated EntireNetwork Object
propNames - the property names used to retrieve the appropiate values of the objectores

getLocale

  1. public static java.util.Locale getLocale( com.filenet.wcm.api.Session session)
Returns a Locale object from the Session
Parameters:
session - - a Session Object
Returns:
a java.util.Locale object

getCEConnection

  1. public static com.filenet.api.core.Connection getCEConnection( com.filenet.wcm.api.Session session)
Retrieves a CE 4.0 Connection aka DaphneConnection object from the current Buzz Session
Parameters:
session -
Returns:
Throws:
java.lang.Exception

getAllImplementataions

  1. public static java.util.Map getAllImplementataions( RMObjectStore aoRMObjectStore)
This method search for the connector registration and returns the Map containing the implementation class name as the key and the value is the ArrayList that in turn contains the ArrayList containing the parameters like server name, repository name and the repository type
Returns:
The Map containing the Implementation class name as the key and the value is the ArrayList that in turn contains the ArrayList containing the parameters like server name, repository name and the repository type

getConnectorSearchURL

  1. public static java.lang.String getConnectorSearchURL( RMObjectStore aoRMObjectStore,
  2. java.lang.String asRMConn,
  3. java.util.Map aoImplClassMap)
Generates the search URL that needs to be passed to the RMConnector implementation for the search related methods
Parameters:
asRMConn - A String that contains the implementation class name for which the search Url needs to be created
aoImplClassMap - A Map object that holds the implementation class name as the key and the value contains the ArrayList that in turn contains the set of the parameters like Repository name, server name and the repository type
Returns:
An XML string that is the to be passed to the searchDocument() of the RMConnector as the search URL

GetROSURL

  1. public static java.lang.String[] GetROSURL( org.w3c.dom.NodeList loURLNode)

getAllAssociatedROS

  1. public static java.util.List getAllAssociatedROS( RMObjectStore rmFPOS)