com.filenet.rm.api

Interface RMObjectStore

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ObjectStore, com.filenet.wcm.api.ReadableMetadataObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject


    public interface RMObjectStore
    extends RMObject, com.filenet.wcm.api.ObjectStore
    Represents a Records Manager object store that can hold multiple file plans.

    You can create an instance of the RMObjectStore interface by calling the _getRMObjectStore(ObjectStore) method on an RMUtil object.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ClassificationGuide createClassificationGuide(java.lang.String asGuideName, java.lang.String asClassID, com.filenet.wcm.api.Properties aoGuideProps, com.filenet.wcm.api.Permissions aoGuideACLs)
      Creates a new ClassificationGuide object in the /Records Management/ClassificationGuides folder within this object store.
      ClassificationScheme createClassificationScheme(java.lang.String asClassificationSchemeName, com.filenet.wcm.api.Properties aoClassificationSchemeProps, com.filenet.wcm.api.Permissions aoClassificationSchemeACLs)
      Constructs a ClassificationScheme object with the specified property and permission values, and places the new object in this object store.
      DispositionSchedule createDispositionSchedule(com.filenet.wcm.api.Properties aoDispositionScheduleProps, com.filenet.wcm.api.Permissions aoDispositionScheduleACLs)
      Constructs a DispositionSchedule object with the specified property and permission values, and places the new object in this object store.
      RMCustomObject createLocation(com.filenet.wcm.api.Properties aoProperties, com.filenet.wcm.api.Permissions aoAcls, java.lang.String Guid)
      Creates a Location object in the specified folder.
      RMCustomObject createPattern(com.filenet.wcm.api.Properties aoProperties, com.filenet.wcm.api.Permissions aoPermissions)
      Creates a Pattern object that specifies a naming pattern for file plans in the object store.
      RMCustomObject createPatternLevel(com.filenet.wcm.api.Properties aoProperties, com.filenet.wcm.api.Permissions aoPermissions, java.lang.String asPatternGUID)
      Creates a PatternLevel object to be associated with the specified Pattern object in this object store.
      RecordType createRecordType(com.filenet.wcm.api.Properties aoRecordTypeProps, com.filenet.wcm.api.Permissions aoRecordTypeACLs)
      Constructs a RecordType object with the specified property and permission values, and places the new object in this object store.
      RMCustomObject createRMCustomObject(int aiCustomClassType, com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoACL)
      Constructs an RMCustomObject object of the specified type and places the new object in this object store.
      com.filenet.wcm.api.ClassDescriptions getClassDescriptions(int[] aiEntityTypes, boolean abInculdeSubClasses, boolean abGetAll)
      Returns a collection of the ClassDescription objects, which contain the metadata for the classes of the specified types in this object store.
      ClassificationGuides getClassificationGuides()
      Returns the ClassificationGuide objects that are contained in this object store.
      ClassificationGuides getClassificationGuides(java.lang.String[] asPropNames)
      Returns the ClassificationGuide objects, along with their properties, that are contained in this object store.
      java.lang.String getClassificationGuidesXML(java.lang.String[] asPropNames)
      Returns a String in XML format that represents the collection of ClassificationGuide objects in this object store along with their properties.
      ClassificationScheme getClassificationSchemeInterface(com.filenet.wcm.api.Folder aoFolder)
      Constructs a ClassificationScheme object based on the specified Folder object and places the new object in this object store.
      java.lang.String getClassificationSchemeRootPath()
      Returns the path of ClassificationSchemeRoot object for this object store.
      ClassificationSchemes getClassificationSchemes()
      Returns a collection containing the ClassificationScheme objects in this object store.
      java.lang.String getClassificationSchemesXML(java.lang.String[] asPropNames)
      Returns a String that contains the XML representation of the ClassificationScheme objects in this object store along with their specified properties.
      RMObject getObject(java.lang.String asRMObjectId)
      Returns the specified RMObject object.
      java.lang.String[] getPropertyNames(int aiEntityType)
      Returns an array containing the symbolic names of all properties for objects of the specified entity type.
      RecordInfo getRecord(java.lang.String asDocURI)
      Returns the RecordInfo object in this object store that has the the specified document URI.
      RecordCategory getRecordCategoryInterface(com.filenet.wcm.api.Folder aoFolder)
      Constructs a RecordCategory object based on the specified Folder object and places the new object in this object store.
      RecordFolder getRecordFolderInterface(com.filenet.wcm.api.Folder aoFolder)
      Constructs a RecordFolder object object based on the specified Folder object and places the new object in this object store.
      RecordInfo getRecordInfoInterface(com.filenet.wcm.api.Document aoDocument)
      Constructs a RecordInfo object based on the specified Document object and places the new object in this object store.
      RecordType getRecordTypeInterface(com.filenet.wcm.api.CustomObject aoRecordType)
      Constructs a RecordType object based on the specified Folder object and places the new object in this object store.
      RecordTypes getRecordTypes()
      Returns a collection containing the RecordType objects in this object store.
      RMCustomObject getRMCustomObjectInterface(com.filenet.wcm.api.CustomObject aoCustomObject)
      Constructs an RMCustomObject object based on the specified CustomObject object and places the new object in this object store.
      RMCustomObjects getRMCustomObjects(int aiRMtype)
      Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store for which the user has permission to update the schedule.
      RMCustomObjects getRMCustomObjects(int aiRMtype, java.lang.String asWhereClause)
      Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store.
      int getRMEntityType()
      Returns the type of this object store.
      int getRMEntityType(java.lang.String asGuid)
      Returns the type of the specified Records Manager entity.
      int getRMFolderType(com.filenet.wcm.api.Folder aoFolder)
      Returns the entity type of the specified container object.
      int getRMFolderType(java.lang.String asGUID)
      Returns the entity type of the container object with the specified GUID.
      RMObjects getRMObjects()
      Creates an empty RMObjects collection that can contain any type of RMObject object.
      RMPagedSearch getRMPagedSearch()
      Returns an RMPagedSearch object that can be used to search this object store and to return paged results.
      RMSearch getRMSearch()
      Returns an RMSearch object that can be used to search this object store.
      RMStoredSearches getRMStoredSearches(int[] aiArrObjTypes, java.lang.String[] asArrPropNames)
      Returns a collection of the RMStoredSearch objects, along with their properties, that are contained in this object store.
      java.lang.String getRMStoredSearchesXML(int[] aiArrObjTypes, java.lang.String[] asArrPropNames)
      Returns a String in XML format representing a collection of the RMStoredSearch objects, along with their properties, that are contained in this object store.
      java.lang.Object getSystemConfigurationValue(java.lang.String asPropertyName)
      Returns the value of the specified SystemConfiguration property for the ClassificationSchemes object in this object store.
      Volume getVolumeInterface(com.filenet.wcm.api.Folder aoFolder)
      Constructs a Volume object based on the specified Folder object and places the new object in this object store.
      boolean isRecordMultiFilingEnabled()
      Indicates whether or not multi-filing of records is allowed on this RMObjectStore.
      • Methods inherited from interface com.filenet.wcm.api.ObjectStore

        createAndFileObject, createObject, createObject, exportObjects, getCheckoutList, getCheckoutList, getCheckoutListXML, getChoiceLists, getChoiceListsXML, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptions, getClassDescriptionsXML, getClassDescriptionsXML, getClassDescriptionsXML, getClassDescriptionsXML, getClassifierMimeTypes, getEventActions, getEventActions, getObject, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPropertyDescriptionsXML, getPublishRequests, getPublishRequests, getRootFolder, getSecurityPolicies, getSecurityPolicies, getSecurityPoliciesXML, getSecurityPoliciesXML, getStoredSearches, getStoredSearchesXML, getStringLookupLists, getStyleTemplates, getTopFoldersXML, getWorkflowDefinitions, getWorkflowDefinitions, importBaseObject, importObjects, installFeatureAddOn, supports
      • Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject

        getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
    • Method Detail

      • getClassificationSchemesXML

        java.lang.String getClassificationSchemesXML(java.lang.String[] asPropNames)
                                                     throws RMException
        Returns a String that contains the XML representation of the ClassificationScheme objects in this object store along with their specified properties.
        Parameters:
        asPropNames - A String array that contains the symbolic names of the properties to be returned. If this parameter is null or if the array is empty, all properties of the ClassificationScheme objects are returned.
        Returns:
        A String value that contains the XML representation of the ClassificationScheme objects in this object store along with their specified properties.
        Throws:
        RMException - If a Records Manager error occurs.
      • createClassificationScheme

        ClassificationScheme createClassificationScheme(java.lang.String asClassificationSchemeName,
                                                      com.filenet.wcm.api.Properties aoClassificationSchemeProps,
                                                      com.filenet.wcm.api.Permissions aoClassificationSchemeACLs)
                                                        throws RMException
        Constructs a ClassificationScheme object with the specified property and permission values, and places the new object in this object store.
        Parameters:
        asClassificationSchemeName - A String specifying the name for the new classification scheme.
        aoClassificationSchemeProps - A Properties collection containing the property values for the new classification scheme. If a property value is not defined, the default value defined for the Content Engine object store is used.
        aoClassificationSchemeACLs - A Permissions collection containing the access permissions for the new classification scheme. If this parameter is null, the classification scheme inherits the default instance permissions defined for the class.
        Returns:
        The new ClassificationScheme object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecordTypes

        RecordTypes getRecordTypes()
                                   throws RMException
        Returns a collection containing the RecordType objects in this object store.
        Returns:
        A RecordTypes collection that contains the RecordType objects in this object store.
        Throws:
        RMException - If a Records Manager error occurs.
      • createRecordType

        RecordType createRecordType(com.filenet.wcm.api.Properties aoRecordTypeProps,
                                  com.filenet.wcm.api.Permissions aoRecordTypeACLs)
                                    throws RMException
        Constructs a RecordType object with the specified property and permission values, and places the new object in this object store.
        Parameters:
        aoRecordTypeProps - A Properties collection containing the property values for the new record type. If a property value is not defined, the default value defined for the Content Engine object store is used.
        aoRecordTypeACLs - A Permissions collection containing the access permissions for the new record type. If this parameter is null, the record type inherits the default instance permissions defined for the class.
        Returns:
        The new RecordType object.
        Throws:
        RMException - If a Records Manager error occurs.
      • createDispositionSchedule

        DispositionSchedule createDispositionSchedule(com.filenet.wcm.api.Properties aoDispositionScheduleProps,
                                                    com.filenet.wcm.api.Permissions aoDispositionScheduleACLs)
                                                      throws RMException
        Constructs a DispositionSchedule object with the specified property and permission values, and places the new object in this object store.
        Parameters:
        aoDispositionScheduleProps - A Properties collection containing the property values for the new disposition schedule. If a property value is not defined, the default value defined for the Content Engine object store is used.
        aoDispositionScheduleACLs - A Permissions collection containing the access permissions for the new disposition schedule. If this parameter is null, the disposition schedule inherits the default instance permissions defined for the class.
        Returns:
        The new DispositionSchedule object.
        Throws:
        RMException - If a Records Manager error occurs.
      • createRMCustomObject

        RMCustomObject createRMCustomObject(int aiCustomClassType,
                                          com.filenet.wcm.api.Properties aoProps,
                                          com.filenet.wcm.api.Permissions aoACL)
                                            throws RMException
        Constructs an RMCustomObject object of the specified type and places the new object in this object store.
        Parameters:
        aiCustomClassType - An int value that indicates the type of custom object to be created.
        aoProps - A Properties collection containing the property values for the new custom object. If a property value is not defined, the default value defined for the Content Engine object store is used.
        A - Permissions collection containing the access permissions for the new custom object. If this parameter is null, the disposition schedule inherits the default instance permissions defined for the class.
        Returns:
        The new RMCustomObject object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecord

        RecordInfo getRecord(java.lang.String asDocURI)
                             throws RMException
        Returns the RecordInfo object in this object store that has the the specified document URI.
        Parameters:
        asDocURI - A String that represents the value of the DocURI property of the RecordInfo to be returned.
        Returns:
        The specified RecordInfo object.
        Throws:
        RMException - If the asDocURIparameter is null or empty, or if a Records Manager error occurs.
      • getPropertyNames

        java.lang.String[] getPropertyNames(int aiEntityType)
                                            throws RMException
        Returns an array containing the symbolic names of all properties for objects of the specified entity type.
        Parameters:
        aiEntityType - An int value representing the RMEntityType property value that identifies the type of entity for which property names are to be returned.
        Returns:
        A String array containing the names of the properties for the entity type.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMFolderType

        int getRMFolderType(java.lang.String asGUID)
                            throws RMException
        Returns the entity type of the container object with the specified GUID.
        Parameters:
        asGUID - A String that represents the GUID for the container object.
        Returns:
        An int value that represents the RMEntityType property value of the specified container object.
        Throws:
        RMException - If the asGUID parameter is null or empty, or if a Records Manager error occurs.
      • getRMFolderType

        int getRMFolderType(com.filenet.wcm.api.Folder aoFolder)
                            throws RMException
        Returns the entity type of the specified container object.
        Parameters:
        aoFolder - A Folder object that represents a Records Manager container object.
        Returns:
        An int value that represents the RMEntityType property value of the specified container object.
        Throws:
        RMException - If the aoFolder parameter is null or empty, if the RMEntityType property is not found, or if a Records Manager error occurs.
      • getClassificationSchemeInterface

        ClassificationScheme getClassificationSchemeInterface(com.filenet.wcm.api.Folder aoFolder)
                                                              throws RMException
        Constructs a ClassificationScheme object based on the specified Folder object and places the new object in this object store.
        Parameters:
        aoFolder - A Folder object of type RM_TYPE_CLASSIFICATIONSCHEME on which the ClassificationScheme object is to be based.
        Returns:
        The new ClassificationScheme object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecordCategoryInterface

        RecordCategory getRecordCategoryInterface(com.filenet.wcm.api.Folder aoFolder)
                                                  throws RMException
        Constructs a RecordCategory object based on the specified Folder object and places the new object in this object store.
        Parameters:
        aoFolder - A Folder object of type RM_TYPE_RECORDCATEGORY on which the RecordCategory object is to be based.
        Returns:
        The new RecordCategory object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecordFolderInterface

        RecordFolder getRecordFolderInterface(com.filenet.wcm.api.Folder aoFolder)
                                              throws RMException
        Constructs a RecordFolder object object based on the specified Folder object and places the new object in this object store.
        Parameters:
        aoFolder - A Folder object of type RM_TYPE_RECORDFOLDER on which the RecordFolder object is to be based.
        Returns:
        The new RecordFolder object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getVolumeInterface

        Volume getVolumeInterface(com.filenet.wcm.api.Folder aoFolder)
                                  throws RMException
        Constructs a Volume object based on the specified Folder object and places the new object in this object store.
        Parameters:
        aoFolder - A Folder object of type RM_TYPE_VOLUME on which the Volume object is to be based.
        Returns:
        The new Volume object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecordTypeInterface

        RecordType getRecordTypeInterface(com.filenet.wcm.api.CustomObject aoRecordType)
                                          throws RMException
        Constructs a RecordType object based on the specified Folder object and places the new object in this object store.
        Parameters:
        aoRecordType - A CustomObject object of type RM_TYPE_RECORDCATEGORY on which the RecordType object is to be based.
        Returns:
        The new RecordType object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRecordInfoInterface

        RecordInfo getRecordInfoInterface(com.filenet.wcm.api.Document aoDocument)
                                          throws RMException
        Constructs a RecordInfo object based on the specified Document object and places the new object in this object store.
        Parameters:
        aoDocument - A Document object on which the RecordInfo object is to be based.
        Returns:
        The new RecordInfo object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMCustomObjectInterface

        RMCustomObject getRMCustomObjectInterface(com.filenet.wcm.api.CustomObject aoCustomObject)
                                                  throws RMException
        Constructs an RMCustomObject object based on the specified CustomObject object and places the new object in this object store.
        Parameters:
        aoCustomObject - A CustomObject object of type RM_TYPE_RECORDTYPE on which the RMCustomObject object is to be based.
        Returns:
        The new RMCustomObject object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getSystemConfigurationValue

        java.lang.Object getSystemConfigurationValue(java.lang.String asPropertyName)
                                                     throws RMException
        Returns the value of the specified SystemConfiguration property for the ClassificationSchemes object in this object store.
        Parameters:
        asPropertyName - A String that specifies the name of SystemConfiguration property whose value is to be returned.
        Returns:
        An object that represents the specified SystemConfiguration property.
        Throws:
        RMException - If the asPropertyName parameter is null or empty, if the specified property is not found, or if a Records Manager error occurs.
      • getRMStoredSearches

        RMStoredSearches getRMStoredSearches(int[] aiArrObjTypes,
                                           java.lang.String[] asArrPropNames)
        Returns a collection of the RMStoredSearch objects, along with their properties, that are contained in this object store.
        Parameters:
        aiArrObjTypes - An int array identifying type of objects to be returned as follows:

        • StoredSearch.TYPE_SEARCH: Returns stored searches.

        • StoredSearch.TYPE_TEMPLATE: Returns stored search templates.

        asArrPropNames - A String array that contains the symbolic names of properties to be retrieved for each returned object. If this parameter is null or empty, this method retrieves an initial set of hard-coded properties.
        Returns:
        An RMStoredSearches collection containing the specified stored searches.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMStoredSearchesXML

        java.lang.String getRMStoredSearchesXML(int[] aiArrObjTypes,
                                              java.lang.String[] asArrPropNames)
        Returns a String in XML format representing a collection of the RMStoredSearch objects, along with their properties, that are contained in this object store.
        Parameters:
        aiArrObjTypes - An int array identifying type of objects to be returned as follows:

        • StoredSearch.TYPE_SEARCH: Returns stored searches.

        • StoredSearch.TYPE_TEMPLATE: Returns stored search templates.

        asArrPropNames - A String array that contains the symbolic names of properties to be retrieved for each returned object. If this parameter is null or empty, this method retrieves an initial set of hard-coded properties.
        Returns:
        A String containing the specified stored searches in XML format.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMCustomObjects

        RMCustomObjects getRMCustomObjects(int aiRMtype,
                                         java.lang.String asWhereClause)
                                           throws RMException
        Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store.
        Parameters:
        aiRMtype - An int value that specifies the type of RMCustomObject object to be returned.
        asWhereClause - A String that specifies the where clause that is used to further filter the objects to be returned. If no where clause is provided, all RMCustomObject of the specified type are returned.
        Returns:
        An RMCustomObjects collection containing the specified RMCustomObject objects.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMCustomObjects

        RMCustomObjects getRMCustomObjects(int aiRMtype)
                                           throws RMException
        Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store for which the user has permission to update the schedule.
        Parameters:
        aiRMtype - An int value that specifies the type of RMCustomObject object to be returned.
        Returns:
        An RMCustomObjects collection containing the specified RMCustomObject objects.
        Throws:
        RMException - If the user does not have permission to update the schedule for the specified objects or if a Records Manager error occurs.
      • getClassificationSchemeRootPath

        java.lang.String getClassificationSchemeRootPath()
                                                         throws RMException
        Returns the path of ClassificationSchemeRoot object for this object store. The path that is returned is relative to the RootFolder object.
        Returns:
        A String that represents the relative path of the ClassificationSchemeRoot object for this object store.
        Throws:
        RMException - If no ClassificationSchemeRoot object exists in this object store, if more than one ClassificationSchemeRoot object exists in this object store, or if a Records Manager error occurs.
      • getRMEntityType

        int getRMEntityType()
                            throws RMException
        Returns the type of this object store.
        Specified by:
        getRMEntityType in interface RMObject
        Returns:
        An int value that represents the type of this object store.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMEntityType

        int getRMEntityType(java.lang.String asGuid)
                            throws RMException
        Returns the type of the specified Records Manager entity.
        Parameters:
        asGuid - A String that specifies the GUID of the Records Manager entity for which the type is to be returned.
        Returns:
        An int value that represents the type of the specified Records Manager entity.
        Throws:
        RMException - If the asGuid parameter does not contain a valid GUID for this object store or if a Records Manager error occurs.
      • getRMSearch

        RMSearch getRMSearch()
                             throws RMException
        Returns an RMSearch object that can be used to search this object store.
        Returns:
        An RMSearch object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getRMPagedSearch

        RMPagedSearch getRMPagedSearch()
                                       throws RMException
        Returns an RMPagedSearch object that can be used to search this object store and to return paged results.
        Returns:
        An RMPagedSearch object.
        Throws:
        RMException - If a Records Manager error occurs.
      • createPattern

        RMCustomObject createPattern(com.filenet.wcm.api.Properties aoProperties,
                                   com.filenet.wcm.api.Permissions aoPermissions)
                                     throws RMException
        Creates a Pattern object that specifies a naming pattern for file plans in the object store.
        Parameters:
        aoProperties - A Properties collection that specifies the properties to be used for the new Pattern object.
        aoPermissions - Permissions collection that specifies the permissions to be used for the new Pattern object.
        Returns:
        An RMCustomObject object that represents the new Pattern object.
        Throws:
        RMException - If a Records Manager error occurs.
      • createPatternLevel

        RMCustomObject createPatternLevel(com.filenet.wcm.api.Properties aoProperties,
                                        com.filenet.wcm.api.Permissions aoPermissions,
                                        java.lang.String asPatternGUID)
                                          throws RMException
        Creates a PatternLevel object to be associated with the specified Pattern object in this object store.
        Parameters:
        aoProperties - A Properties collection that specifies the properties to be used for the new PatternLevel object.
        aoPermissions - Permissions collection that specifies the permissions to be used for the new PatternLevel object.
        asPatternGUID - A String that specifies the GUID of the Pattern object with which this PatternLevel object is to be associated.
        Returns:
        An RMCustomObject object that represents the new PatternLevel object.
        Throws:
        RMException - If a Records Manager error occurs.
      • createLocation

        RMCustomObject createLocation(com.filenet.wcm.api.Properties aoProperties,
                                    com.filenet.wcm.api.Permissions aoAcls,
                                    java.lang.String Guid)
                                      throws RMException
        Creates a Location object in the specified folder.
        Parameters:
        aoProperties - A Properties collection that specifies the properties to be used for the new Location object.
        aoAcls - A Permissions collection that specifies the permissions to be used for the new Location object.
        asPatternGUID - A String that specifies the GUID of the Folder object in which this Location object is to be placed.
        Returns:
        An RMCustomObject object that represents the new Location object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getClassDescriptions

        com.filenet.wcm.api.ClassDescriptions getClassDescriptions(int[] aiEntityTypes,
                                                                 boolean abInculdeSubClasses,
                                                                 boolean abGetAll)
                                                                   throws RMException
        Returns a collection of the ClassDescription objects, which contain the metadata for the classes of the specified types in this object store.
        Parameters:
        aiEntityTypes - An int array that specifies the object types of the classes for which metadata is to be returned.
        abInculdeSubClasses - A boolean value that indicates whether the method is to return metadata for the subclasses of the specified classes. Set this value to true to return metadata for subclasses.
        abGetAll - A boolean value that indicates whether metadata is to be returned for hidden class descriptions. Set this value to true to return metadata for hidden class descriptions.

        NOTE A ClassDescription object is hidden if its IsHidden property is set to true.

        Returns:
        A ClassDescriptions collection that contains the requested the ClassDescription objects for classes of the specified types.
        Throws:
        RMException - If a Records Manager error occurs.
      • getObject

        RMObject getObject(java.lang.String asRMObjectId)
                           throws RMException
        Returns the specified RMObject object.
        Parameters:
        asRMObjectId - A String that specifies the GUID of the object to be returned.
        Returns:
        The RMObject object corresponding to the specified GUID.
        Throws:
        RMException - If the GUID specified by the asRMObjectId parameter does not point to an RMObject object or if a Records Manager error occurs.
      • createClassificationGuide

        ClassificationGuide createClassificationGuide(java.lang.String asGuideName,
                                                    java.lang.String asClassID,
                                                    com.filenet.wcm.api.Properties aoGuideProps,
                                                    com.filenet.wcm.api.Permissions aoGuideACLs)
                                                      throws RMException
        Creates a new ClassificationGuide object in the /Records Management/ClassificationGuides folder within this object store.
        Parameters:
        asGuideName - A String that specifies the name for the new classification guide.
        asClassID - A String that specifies the class ID for the new classification guide.
        aoGuideProps - A Properties collection that specifies the properties to be used for a top-level classification guide.
        aoGuideACLs - A Permissions collection that specifies the permissions to be used for a top-level classification guide.
        Returns:
        The new ClassificationGuide object.
        Throws:
        RMException - If a Records Manager error occurs.
      • getClassificationGuides

        ClassificationGuides getClassificationGuides(java.lang.String[] asPropNames)
                                                     throws RMException
        Returns the ClassificationGuide objects, along with their properties, that are contained in this object store.
        Parameters:
        asPropNames - A String array that specifies the names of the properties to be returned.
        Returns:
        A ClassificationGuides collection that contains the classification guides and their properties.
        Throws:
        RMException - If a Records Manager error occurs.
      • getClassificationGuidesXML

        java.lang.String getClassificationGuidesXML(java.lang.String[] asPropNames)
                                                    throws RMException
        Returns a String in XML format that represents the collection of ClassificationGuide objects in this object store along with their properties.
        Parameters:
        asPropNames - A String array that specifies the symbolic names of the properties to be returned. If this parameter is null or empty, the method returns all properties for the ClassificationGuide objects.
        Returns:
        A String in XML format that represents the collection of ClassificationGuide objects along with their properties.
        Throws:
        RMException - If a Records Manager error occurs.
      • isRecordMultiFilingEnabled

        boolean isRecordMultiFilingEnabled()
        Indicates whether or not multi-filing of records is allowed on this RMObjectStore.
        Returns:
        true if record multi-filing is allowed, otherwise returns false.

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