com.filenet.rm.api.util

Class RMUtil

  • java.lang.Object
    • com.filenet.rm.api.util.RMUtil


  • public class RMUtil
    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 Detail

      • DISPOSAL

        public static final int DISPOSAL
        The int value represents the Disposition Workflow associated to be launched.
        See Also:
        Constant Field Values
      • VITAL

        public static final int VITAL
        The int value represents the Vital workflow associated with the entities to be launched.
        See Also:
        Constant Field Values
      • SCREENING

        public static final int SCREENING
        The int value represents the Vital workflow associated with the entities to be launched.
        See Also:
        Constant Field Values
      • MAX_SUBJECT_INCLUDED_ENTITIES

        public static final int MAX_SUBJECT_INCLUDED_ENTITIES
        See Also:
        Constant Field Values
      • CEMP_PREFIX

        public static final java.lang.String CEMP_PREFIX
        Determines the cemp prefix string
        See Also:
        Constant Field Values
    • Constructor Detail

      • RMUtil

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

      • getRMObjects

        public static RMObjects getRMObjects(RMObjectStore aoObjectStore,
                             java.lang.String asFrom,
                             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

        public static 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.
        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

        public static void _launchWorkFlow(RMObjectStore aoRMObjectStore,
                           java.lang.String[] asGuidArray,
                           java.lang.String asFirstProperty,
                           int aiWorkFlowProperty,
                           filenet.vw.api.VWSession aoVWSession)
                                    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

        public static void _launchWorkFlow(RMObjectStore aoRMObjectStore,
                           java.util.Map aoMap,
                           java.lang.String asFirstProperty,
                           int aiWorkFlowProperty,
                           filenet.vw.api.VWSession aoVWSession)
                                    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

        public static 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
        Parameters:
        aoVWSession - - a valid VW session
        aoObjects -
        aoObjectStore -
        workflowVersionId -
        paramNames -
        paramValues -
        Returns:
      • getRecordObjectStores

        public com.filenet.wcm.api.ObjectStores getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
                                                               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

        public static com.filenet.wcm.api.ObjectStores _getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
                                                                       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

        public RMObjectStores getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
                                               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

        public static RMObjectStores _getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
                                                       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

        public java.lang.String getFilePlanID(RMFolder aoFolder)
                                       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

        public static java.lang.String _getFilePlanID(RMFolder aoFolder)
                                               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

        public boolean isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                      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

        public static boolean _isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                              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

        public 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.
        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

        public static 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.
        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

        public static void validateCustomObjectName(RMObjectStore aoRMOS,
                                    java.lang.String asCustomObjectClassName,
                                    java.lang.String asCustomObjectNameProperty,
                                    java.lang.String asName,
                                    java.lang.String asCustomObjectTypeProperty,
                                    int aiType)
                                             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

        public boolean isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                    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

        public static boolean _isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                            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

        public java.lang.String getRegistrationID(RMObjectStore aoRMObjectStore,
                                         java.lang.String asRepositoryType,
                                         java.lang.String asServerName,
                                         java.lang.String asRepositoryName,
                                         boolean abCreate)
                                           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

        public static java.lang.String _getRegistrationID(RMObjectStore aoRMObjectStore,
                                          java.lang.String asRepositoryType,
                                          java.lang.String asServerName,
                                          java.lang.String asRepositoryName,
                                          boolean abCreate)
                                                   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

        public java.lang.String[] getFieldFromResultSet(java.lang.String asResultSet,
                                               java.lang.String asFieldName)
                                                 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

        public static java.lang.String[] _getFieldFromResultSet(java.lang.String asResultSet,
                                                java.lang.String asFieldName)
                                                         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

        public int getCountFromResultSet(java.lang.String asResultSet)
                                  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

        public static int _getCountFromResultSet(java.lang.String asResultSet)
                                          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

        public RMBulkOperationResults batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                        java.lang.String asReasonForClose)
                                          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

        public static RMBulkOperationResults _batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                         java.lang.String asReasonForClose)
                                                  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

        public RMBulkOperationResults batchReopen(boolean abReOpen,
                                         com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                         java.lang.String asReasonForClose)
                                           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

        public static RMBulkOperationResults _batchReopen(boolean abReOpen,
                                          com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                          java.lang.String asReasonForClose)
                                                   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

        public RMBulkOperationResults batchInactivate(boolean abIsInactive,
                                             RMObjectStore aoRMOS,
                                             com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                             java.lang.String asReasonForInactivate)
                                               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

        public static RMBulkOperationResults _batchInactivate(boolean abIsInactive,
                                              RMObjectStore aoRMOS,
                                              com.filenet.wcm.api.BaseObjects aoBaseObjects,
                                              java.lang.String asReasonForInactivate)
                                                       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

        public boolean isAnyParentClosed(RMFolder aoRMFolder)
                                  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

        public static boolean _isAnyParentClosed(RMFolder aoRMFolder)
                                          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

        public 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.
        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

        public static 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.
        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

        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

        public java.util.Map populateMap(java.lang.String asURL)
                                  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

        public static java.util.Map _populateMap(java.lang.String asURL)
                                          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

        public java.util.Map populateMap(org.w3c.dom.Document aoDocument)
                                  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

        public static java.util.Map _populateMap(org.w3c.dom.Document aoDocument)
                                          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

        public static java.io.Reader getReader(java.lang.String asFilePathOrString,
                               java.lang.String asReaderType,
                               java.lang.String asEncoding)
                                        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
        asEncoding, - The encoding technique that will be used for the Reader object. The encoding technique can be UTF-8, Unicode or ANSI etc.
        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

        public java.io.Reader getReader(java.lang.String asFilePathOrString,
                               java.lang.String asReaderType)
                                 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

        public static java.io.Reader _getReader(java.lang.String asFilePathOrString,
                                java.lang.String asReaderType)
                                         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

        public org.w3c.dom.Document createXMLdoc(org.xml.sax.InputSource aoSource)
                                          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

        public static org.w3c.dom.Document _createXMLdoc(org.xml.sax.InputSource aoSource)
                                                  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

        public org.w3c.dom.Document createXMLDoc(java.io.Reader aoReader)
                                          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

        public static org.w3c.dom.Document _createXMLDoc(java.io.Reader aoReader)
                                                  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

        public org.w3c.dom.Document createXMLDoc(java.lang.String asString)
                                          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

        public static org.w3c.dom.Document _createXMLDoc(java.lang.String asString)
                                                  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

        public org.w3c.dom.Document createXMLDoc(java.io.InputStream aoInputStream)
                                          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

        public static org.w3c.dom.Document _createXMLDoc(java.io.InputStream aoInputStream)
                                                  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

        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.
        Parameters:
        aoObjectStore - An RMObjectStore where this check need to perform.
        Returns:
        boolean true if the objectStore passed as parameter contains more then one file plan else returns false
      • _doMultipleFilePlanExist

        public static boolean _doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
        Checks whether the given object store contains more then one file plan.
        Parameters:
        aoObjectStore - An RMObjectStore where this check need to perform.
        Returns:
        boolean true if the objectStore passed as parameter contains more then one file plan else returns false
      • useInSubFolder

        public boolean useInSubFolder(RMObjectStore aoObjectStore,
                             java.lang.String aoFolderPath)
      • _useInSubFolder

        public static boolean _useInSubFolder(RMObjectStore aoObjectStore,
                              java.lang.String aoFolderPath)
      • generateDocumentURI

        public java.lang.String generateDocumentURI(RMObjectStore aoRMObjectStore,
                                           java.lang.String asURI)
                                             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

        public static java.lang.String _generateDocumentURI(RMObjectStore aoRMObjectStore,
                                            java.lang.String asURI)
                                                     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

        public com.filenet.wcm.api.CustomObject getRegistrationClass(RMObjectStore aoRMObjectStore,
                                                            java.lang.String asRegistraionID)
                                                              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

        public static com.filenet.wcm.api.CustomObject _getRegistrationClass(RMObjectStore aoRMObjectStore,
                                                             java.lang.String asRegistraionID)
                                                                      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

        public com.filenet.wcm.api.CustomObject getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,
                                                                     java.lang.String asQuerySQL)
                                                                       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

        public static com.filenet.wcm.api.CustomObject _getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,
                                                                      java.lang.String asQuerySQL)
                                                                               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

        public java.lang.String getResultSet(RMObjectStore aoRMObjectStore,
                                    java.lang.String asQuerySQL)
                                      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

        public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore,
                                     java.lang.String asQuerySQL)
                                              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

        public java.lang.String getLimitedResultSet(RMObjectStore aoRMObjectStore,
                                           java.lang.String asQuerySQL,
                                           int aiMaxRecords)
                                             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

        public static java.lang.String _getLimitedResultSet(RMObjectStore aoRMObjectStore,
                                            java.lang.String asQuerySQL,
                                            int aiMaxRecords)
                                                     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

        public java.lang.String getResultSet(RMObjectStore aoRMObjectStore,
                                    java.lang.String asQuerySQL,
                                    int aiBaseType)
                                      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

        public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore,
                                     java.lang.String asQuerySQL,
                                     int aiBaseType)
                                              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

        public java.lang.String getResultSet(RMObjectStore aoRMObjectStore,
                                    java.lang.String asQuerySQL,
                                    int aiBaseType,
                                    int aiMaxResults)
                                      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

        public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore,
                                     java.lang.String asQuerySQL,
                                     int aiBaseType,
                                     int aiMaxResults)
                                              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

        public java.lang.String getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
                                    java.lang.String asQuerySQL,
                                    int aiBaseType)
                                      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

        public static java.lang.String _getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
                                     java.lang.String asQuerySQL,
                                     int aiBaseType)
                                              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

        public java.lang.String getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
                                    java.lang.String asQuerySQL,
                                    int aiBaseType,
                                    int aiMaxResults)
                                      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

        public static java.lang.String _getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
                                     java.lang.String asQuerySQL,
                                     int aiBaseType,
                                     int aiMaxResults)
                                              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

        public com.filenet.wcm.api.BaseObjects getQueriedObjects(RMObjectStore aoRMObjectStore,
                                                        java.lang.String asQuerySQL,
                                                        int aiBaseType)
                                                          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

        public static com.filenet.wcm.api.BaseObjects _getQueriedObjects(RMObjectStore aoRMObjectStore,
                                                         java.lang.String asQuerySQL,
                                                         int aiBaseType)
                                                                  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

        public com.filenet.wcm.api.BaseObjects getQueriedObjects(RMObjectStore aoRMObjectStore,
                                                        java.lang.String asQuerySQL,
                                                        int aiBaseType,
                                                        int aiMaxResult)
                                                          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

        public static com.filenet.wcm.api.BaseObjects _getQueriedObjects(RMObjectStore aoRMObjectStore,
                                                         java.lang.String asQuerySQL,
                                                         int aiBaseType,
                                                         int aiMaxResult)
                                                                  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

        public java.lang.String getRecordURI(RMObjectStore aoRMObjectStore,
                                    java.lang.String asRecordId)
                                      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

        public static java.lang.String _getRecordURI(RMObjectStore aoRMObjectStore,
                                     java.lang.String asRecordId)
                                              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

        public java.lang.String writeXML(org.w3c.dom.Node aoNode)
                                  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

        public static java.lang.String _writeXML(org.w3c.dom.Node aoNode)
                                          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

        public boolean checkPattern(java.lang.String asBaseName,
                           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

        public static 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.
        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

        public RecordInfo locateRecord(java.lang.String asURI)
                                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

        public static RecordInfo _locateRecord(java.lang.String asURI)
                                        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

        public java.lang.String[] getClassIDs(RMObjectStore aoRMObjectStore,
                                     int[] aiEntityTypes,
                                     boolean abInculdeSubClasses)
                                       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

        public static java.lang.String[] _getClassIDs(RMObjectStore aoRMObjectStore,
                                      int[] aiEntityTypes,
                                      boolean abInculdeSubClasses)
                                               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

        public com.filenet.wcm.api.ClassDescriptions getClassDescriptions(RMObjectStore aoRMObjectStore,
                                                                 int[] aiEntityTypes,
                                                                 boolean abInculdeSubClasses)
                                                                   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

        public static com.filenet.wcm.api.ClassDescriptions _getClassDescriptions(RMObjectStore aoRMObjectStore,
                                                                  int[] aiEntityTypes,
                                                                  boolean abInculdeSubClasses)
                                                                           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

        public java.lang.String getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
                                               int[] aiEntityTypes,
                                               boolean abInculdeSubClasses)
                                                 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

        public static java.lang.String _getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
                                                int[] aiEntityTypes,
                                                boolean abInculdeSubClasses)
                                                         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

        public java.lang.String getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                 java.lang.String asFilterType)
                                                   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

        public static java.lang.String _getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                  java.lang.String asFilterType)
                                                           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

        public java.lang.String getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                 java.lang.String asFilterType,
                                                 RMRecordContainer aoContainer)
                                                   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

        public static java.lang.String _getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                  java.lang.String asFilterType,
                                                  RMRecordContainer aoContainer)
                                                           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

        public com.filenet.wcm.api.PropertyDescriptions getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                                       java.lang.String asFilterType)
                                                                         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

        public static com.filenet.wcm.api.PropertyDescriptions _getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,
                                                                        java.lang.String asFilterType)
                                                                                 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

        public java.lang.String addNode(java.lang.String asURI,
                               java.lang.String asKeyName,
                               java.lang.String asValue)
                                 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:
        RMException
      • _addNode

        public static java.lang.String _addNode(java.lang.String asURI,
                                java.lang.String asKeyName,
                                java.lang.String asValue)
                                         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:
        RMException
      • addNode

        public java.lang.String addNode(java.lang.String asURI,
                               java.util.Map aoMap)
                                 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

        public static java.lang.String _addNode(java.lang.String asURI,
                                java.util.Map aoMap)
                                         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

        public java.lang.String removeNode(java.lang.String asURI,
                                  java.lang.String asKeyName)
                                    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

        public static java.lang.String _removeNode(java.lang.String asURI,
                                   java.lang.String asKeyName)
                                            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

        public boolean validateDate(java.lang.String asDate,
                           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

        public static 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
        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

        public java.util.Collection getCollection(java.lang.String[] asArrString)
                                           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

        public static java.util.Collection _getCollection(java.lang.String[] asArrString)
                                                   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

        public java.lang.String getUserId(RMObjectStore aoRMObjectStore)
                                   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

        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.
        Parameters:
        fullName. - For Tivoli, the credential will return the username in "uid=Administrator,ou=FileNet,dc=hqpsidcdom,dc=com" format.
        Returns:
        the short username, like "Administrator"
      • _getUserId

        public static java.lang.String _getUserId(RMObjectStore rmObjStore)
                                           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:
        RMException
      • getUserIdWithDomain

        public java.lang.String getUserIdWithDomain(RMObjectStore aoRMObjectStore)
                                             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

        public static java.lang.String _getUserIdWithDomain(RMObjectStore aoRMObjectStore)
                                                     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

        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

        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

        public 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). 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

        public static 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). 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

        public RMObjectStore getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                       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

        public static RMObjectStore _getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
                                               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

        public 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. 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

        public static 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. 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

        public 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. 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

        public static 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. 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

        public 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.
        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

        public static 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.
        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

        public java.util.ArrayList getMergedROSOR(java.util.ArrayList aoRecordID1,
                                         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

        public static 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.
        Parameters:
        aoRecordID1 - A collection that contains the record IDs.
        aoRecordID2 - A collection that contains the record IDs.
        Returns:
        A filtered (ORed) collection.
      • getNewDocument

        public org.w3c.dom.Document getNewDocument()
                                            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

        public static org.w3c.dom.Document _getNewDocument()
                                                    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

        public DocumentStore getDocumentStore(java.lang.Object aoObject)
                                       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

        public static DocumentStore _getDocumentStore(java.lang.Object aoObject)
                                               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

        public 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. 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

        public static 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. 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

        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

        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

        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

        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

        public static 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.
        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

        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

        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

        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

        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.
      • addToDate

        public 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.
        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

        public static 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.
        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

        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

        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

        public 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.
        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

        public static 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.
        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

        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

        public 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.
        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

        public static 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.
        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

        public static 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. This method ignore all properties having the value tag as null.
        Parameters:
        aoRMObjectStore, - A FPOS where asConditionXML is executed.
        asConditionXML, - The ConditionXML can contain the tag of only one of the Entity. The entity can be either RecordCategory,RecordFolder,Volume or Record. All date type property values should be in the w3c format.
        asFilterCriteria, - A extra clause in the Query is Added.
        aiMaxRecords, - The maximum number of objects returned.
        asSelectClauseProperty, - String array that contain the extra properties need to be specified in the select clause of query.
        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

        public static java.lang.String getModifiedConditionXML(RMObjectStore aoRMObjectStore,
                                               java.lang.String asConditionXML)
        This method returns the XML after modidfying the Sql tag.
        Parameters:
        aoRMObjectStore, - A FPOS where asConditionXML is executed.
        asConditionXML, - The ConditionXML can contain one or more Aggregation tag. All date type property values should be in the w3c format.
        Returns:
        An XML String after modifying the sql tag.
      • getCountFromSingleObjectType

        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.
        Parameters:
        asResultSet, - The string value represents the ResultSet
        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

        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.
        Parameters:
        asResultSet, - The string value represents the ResultSet
        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.
      • containsValue

        public boolean containsValue(int[] aiArrValue,
                            int aiValue)
      • _containsValue

        public static boolean _containsValue(int[] aiArrValue,
                             int aiValue)
      • replaceALLInstance

        public static 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
        Parameters:
        asFindStr, - The string value to be searched in the main string.
        asReplaceBy, - The string value to be replaced in the main string.
        asMainStr, - The main string in which all the occurance of asFindStr is replaced by the asReplaceBy value.
        Returns:
        The string from which all the occurance of asFindStr are replaced by the asReplaceBy.
      • tranferPhaseWithoutAction

        public static void tranferPhaseWithoutAction(RMObjectStore aoRMObjectStore,
                                     RMObject aoObject)
                                              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

        public com.filenet.wcm.api.ObjectStore getROSObjectStore(RecordInfo loInfo,
                                                        com.filenet.wcm.api.Session sess)
      • getAllObjectStores

        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

        public static 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
        Parameters:
        loEntireNetwork - an instantiated EntireNetwork Object
        propNames - the property names used to retrieve the appropiate values of the objectores
      • getLocale

        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

        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

        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

        public static 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
        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

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

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

© Copyright IBM Corp. 2003, 2013. All Rights Reserved.