com.ibm.jarm.api.core

Interface FilePlanRepository

    • Method Detail

      • addFilePlan

        FilePlan addFilePlan(java.lang.String classIdent,
                           RMProperties props,
                           java.util.List<RMPermission> perms)
        Creates a new FilePlan instance and saves it to this file plan repository.

        Note: Unless a specific value for the new FilePlan instance's RetainMetadata property is supplied within the props input parameter collection, the RetainMetadata property for the new FilePlan instance will be set to the RetainMetadata.NeverRetain value.

        Parameters:
        classIdent - an optional String identifier of repository class to base new file plan upon.
        props - a RMProperties collection to assign to the new file plan.
        perms - an optional List of RMPermission instances to assign to the new file plan.
        Returns:
        a new FilePlan instance.
      • addFilePlan

        FilePlan addFilePlan(java.lang.String classIdent,
                           RMProperties props,
                           java.util.List<RMPermission> perms,
                           java.lang.String idStr)
        Creates a new FilePlan instance and saves it to this file plan repository.

        Note: Unless a specific value for the new FilePlan instance's RetainMetadata property is supplied within the props input parameter collection, the RetainMetadata property for the new FilePlan instance will be set to the RetainMetadata.NeverRetain value.

        Parameters:
        classIdent - an optional String identifier of repository class to base new file plan upon.
        props - a RMProperties collection to assign to the new file plan.
        perms - an optional List of RMPermission instances to assign to the new file plan.
        idStr - a String Id value to be assigned to the new instance. This parameter can be null in which case an Id value will be automatically generated for the new instance.
        Returns:
        a new FilePlan instance.
      • getSystemConfigurations

        java.util.Map<java.lang.String,SystemConfiguration> getSystemConfigurations()
        Returns a read-only collection of SystemConfiguration instances that applies to this file plan repository.
        Returns:
        A Map of SystemConfiguration which are keyed by each member's "PropertyName" property value String.
      • putSystemConfiguration

        SystemConfiguration putSystemConfiguration(java.lang.String propertyName,
                                                 java.lang.String propertyValue)
        Updates (or adds) the SystemConfiguration instance identified by the propertyName parameter using the given propertyValue parameter to this file plan repository.

        Note that some specific SystemConfiguration instances are considered read-only and cannot be updated. See SystemConfiguration.canBeUpdated().

        Parameters:
        propertyName - the propertyName string that uniquely identifies the SystemConfiguration instance.
        propertyValue - the string value to apply to the instance's propertyValue.
        Returns:
        A new SystemConfiguration instance representing the updated or new object from the file plan repository.
      • getLocations

        java.util.List<Location> getLocations(RMPropertyFilter filter)
        Returns a collection of available Location instances defined on this file plan repository.
        Parameters:
        filter - a RMPropertyFilter controlling the properties to return for each Location instance.
        Returns:
        A List of Location instances. This entry can be empty.
      • getDoDMaxDeclassifyTimeLimit

        java.lang.Integer getDoDMaxDeclassifyTimeLimit()
        For a file plan repository based on the DoD Classified data model, returns the current Maximum Declassification time limit value (in years).
        Returns:
        An Integer. This entry can be null.
      • getWorkflowDefinitions

        java.util.List<RMWorkflowDefinition> getWorkflowDefinitions(RMPropertyFilter filter)
        Returns a collection of available, IER-related RMWorkflowDefinition instances defined on this file plan repository. The resulting collection is restricted to those workflow definitions found under the "/Records Management/Workflow Definitions" folder hierarchy of the file plan repository.
        Parameters:
        filter - A RMPropertyFilter controlling the properties to return for each RMWorkflowDefinition instance.
        Returns:
        A List of RMWorkflowDefinition instances. This entry can be empty.
      • getHolds

        java.util.List<Hold> getHolds(RMPropertyFilter filter)
        Returns a collection of Hold instances defined on this file plan repository.
        Parameters:
        filter - A RMPropertyFilter controlling the properties to return for each Hold instance.
        Returns:
        A List of Hold instances. This entry can be empty.
      • getAssociatedContentRepositories

        java.util.List<ContentRepository> getAssociatedContentRepositories()
        Returns a collection of ContentRepository instances each of which has had at least one ContentItem declared as a Record which resides in this file plan repository.

        This method is primarily helpful for content-based-retrieval search operations when there is a need to know which ContentRepository instances need to be included in a record-related search.

        Returns:
        A List of ContentRepository instances. This entry can be empty.
      • supportsExternalManagement

        boolean supportsExternalManagement()
        Indicates whether or not this file plan repository supports the "RMExternallyManagedBy" property that allows disposition-related artifacts to be managed by external applications.
        Returns:
        true if the "RMExternallyManagedBy" property is defined and assigned to the necessary classes; false otherwise.
      • supportsDefensibleDisposal

        boolean supportsDefensibleDisposal()
        Indicates whether or not this file plan repository can support "Defensible Disposal" containers and the processes associated with such.
        Returns:
        true if this file plan repository can support "Defensible Disposal"; false otherwise.
      • isRecordMultiFilingEnabled

        boolean isRecordMultiFilingEnabled()
        Indicates whether or not this file plan repository allows a record to be filed in more than one container.
        Returns:
        true if multi-filing of records is allowed; false otherwise.
      • launchWorkflows

        void launchWorkflows(java.util.List<BaseEntity> entities,
                           java.lang.String separationPropertyName,
                           int workflowType,
                           java.lang.Object vwSession)
        Launches one or more PE Workflow instances for the specified entitites. FOR INTERNAL USE ONLY!

        Entities are first sorted by their respective IsScreeningRequired property value.

        If a non-null sortByPropertyName value is provided, then further sorting is performed based upon the value of this property for each entity. This property name is typically "Reviewer".

        The supported types of workflow are defined as follows:

        • 1001 - Disposal workflow
        • 1002 - Vital workflow
        • 1003 - Screening workflow

        If the "Screening" type is specified, entities will be sorted based upon their individual "IsScreeningRequired" property value. Those marked for screening will use the Screening workflow, while all others will default to the Dispose workflow.

        IMPORTANT: This method assumes that any necessary authentication JAAS Subject is already established on the current thread. The RMUserContext is NOT used during this particular method call.

        Parameters:
        entities - the entities to be processed by the launched workflows.
        separationPropertyName - an optional property symbolic name to separate by.
        workflowType - defines type of workflow to run.
        vwSession - a required IBM P8 PE API VWSession object.

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