public interface FilePlanRepository extends Repository
A specific file plan repository might be obtained using
the RMFactory.FilePlanRepository
factory class.
All of the available file plan repositories for a specific
domain can be retrieved using the
RMDomain.fetchFilePlanRepositories
method.
RMFactory.FilePlanRepository
Modifier and Type | Method and Description |
---|---|
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. |
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. |
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. |
java.util.List<ClassificationGuide> |
getClassificationGuides(RMPropertyFilter filter)
Returns a collection of available
ClassificationGuide instances defined on this file plan repository. |
DataModelType |
getDataModelType()
Returns the
DataModelType
of this file plan repository. |
java.util.List<DispositionAction> |
getDispositionActions(RMPropertyFilter filter)
Returns a collection of available
DispositionAction instances defined on this file plan repository. |
java.util.List<DispositionSchedule> |
getDispositionSchedules(RMPropertyFilter filter)
Returns a collection of available
DispositionSchedule instances defined on this file plan repository. |
java.util.List<DispositionTrigger> |
getDispositionTriggers(RMPropertyFilter filter)
Returns a collection of available
DispositionTrigger instances defined on this file plan repository. |
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).
|
java.util.List<FilePlan> |
getFilePlans(RMPropertyFilter filter)
Returns a collection of available
FilePlan instances defined on this file plan repository. |
java.util.List<Hold> |
getHolds(RMPropertyFilter filter)
Returns a collection of
Hold instances defined on this file plan repository. |
java.util.List<Location> |
getLocations(RMPropertyFilter filter)
Returns a collection of available
Location instances defined on this file plan repository. |
java.util.List<RecordType> |
getRecordTypes(RMPropertyFilter filter)
Returns a collection of available
RecordType instances defined on this file plan repository. |
java.util.List<ReportDefinition> |
getReportDefinitions(RMPropertyFilter filter)
Returns a collection of available
ReportDefinition instances defined on this file plan repository. |
java.util.Map<java.lang.String,SystemConfiguration> |
getSystemConfigurations()
Returns a read-only collection of
SystemConfiguration
instances that applies to this file plan repository. |
java.util.List<RMWorkflowDefinition> |
getWorkflowDefinitions(RMPropertyFilter filter)
Returns a collection of available, IER-related
RMWorkflowDefinition instances defined
on this file plan repository. |
boolean |
isRecordMultiFilingEnabled()
Indicates whether or not this file plan repository allows a record to be filed
in more than one container.
|
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.
|
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. |
boolean |
supportsDefensibleDisposal()
Indicates whether or not this file plan repository can support "Defensible Disposal"
containers and the processes associated with such.
|
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.
|
fetchChoiceLists, fetchClassDescriptions, getDisplayName, getDomain, getRepositoryType, getSymbolicName
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
FilePlan addFilePlan(java.lang.String classIdent, RMProperties props, java.util.List<RMPermission> perms)
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.
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.FilePlan
instance.FilePlan addFilePlan(java.lang.String classIdent, RMProperties props, java.util.List<RMPermission> perms, java.lang.String idStr)
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.
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.FilePlan
instance.java.util.List<FilePlan> getFilePlans(RMPropertyFilter filter)
FilePlan
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each FilePlan
instance.List
of FilePlan
instances.java.util.Map<java.lang.String,SystemConfiguration> getSystemConfigurations()
SystemConfiguration
instances that applies to this file plan repository.Map
of SystemConfiguration
which are keyed by each member's "PropertyName" property value String
.SystemConfiguration putSystemConfiguration(java.lang.String propertyName, java.lang.String propertyValue)
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()
.
propertyName
- the propertyName string that uniquely identifies the SystemConfiguration
instance.propertyValue
- the string value to apply to the instance's propertyValue.SystemConfiguration
instance representing the updated
or new object from the file plan repository.DataModelType getDataModelType()
DataModelType
of this file plan repository.DataModelType
.java.util.List<Location> getLocations(RMPropertyFilter filter)
Location
instances defined on this file plan repository.filter
- a RMPropertyFilter
controlling
the properties to return for each Location
instance.List
of Location
instances. This entry can be empty.java.util.List<RecordType> getRecordTypes(RMPropertyFilter filter)
RecordType
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each RecordType
instance.List
of RecordType
instances. This entry can be empty.java.util.List<ClassificationGuide> getClassificationGuides(RMPropertyFilter filter)
ClassificationGuide
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each ClassificationGuide
instance.List
of ClassificationGuide
instances. This entry can be empty.java.lang.Integer getDoDMaxDeclassifyTimeLimit()
Integer
. This entry can be null
.java.util.List<DispositionAction> getDispositionActions(RMPropertyFilter filter)
DispositionAction
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each DispositionAction
instance.List
of DispositionAction
instances. This entry can be empty.java.util.List<DispositionTrigger> getDispositionTriggers(RMPropertyFilter filter)
DispositionTrigger
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each DispositionTrigger
instance.List
of DispositionTrigger
instances. This entry can be empty.java.util.List<DispositionSchedule> getDispositionSchedules(RMPropertyFilter filter)
DispositionSchedule
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each DispositionSchedule
instance.List
of DispositionSchedule
instances. This entry can be empty.java.util.List<ReportDefinition> getReportDefinitions(RMPropertyFilter filter)
ReportDefinition
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each ReportDefinition
instance.List
of ReportDefinition
instances. This entry can be empty.java.util.List<RMWorkflowDefinition> getWorkflowDefinitions(RMPropertyFilter filter)
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.filter
- A RMPropertyFilter
controlling
the properties to return for each RMWorkflowDefinition
instance.List
of RMWorkflowDefinition
instances. This entry can be empty.java.util.List<Hold> getHolds(RMPropertyFilter filter)
Hold
instances defined on this file plan repository.filter
- A RMPropertyFilter
controlling
the properties to return for each Hold
instance.List
of Hold
instances. This entry can be empty.java.util.List<ContentRepository> getAssociatedContentRepositories()
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.
List
of ContentRepository
instances. This entry can be empty.boolean supportsExternalManagement()
true
if the "RMExternallyManagedBy" property is defined and
assigned to the necessary classes; false
otherwise.boolean supportsDefensibleDisposal()
true
if this file plan repository can support "Defensible Disposal";
false
otherwise.boolean isRecordMultiFilingEnabled()
true
if multi-filing of records is allowed; false
otherwise.void launchWorkflows(java.util.List<BaseEntity> entities, java.lang.String separationPropertyName, int workflowType, java.lang.Object vwSession)
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:
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.
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.