Class RecordsManagementNodeFormFilter
java.lang.Object
org.alfresco.repo.forms.processor.AbstractFilter<ItemType,NodeRef>
org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementFormFilter<NodeRef>
org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementNodeFormFilter
- All Implemented Interfaces:
DOD5015Model
,RecordsManagementCustomModel
,RecordsManagementModel
,Filter<NodeRef,
NodeRef>
public class RecordsManagementNodeFormFilter
extends RecordsManagementFormFilter<NodeRef>
implements RecordsManagementModel, DOD5015Model
Implementation of a form processor Filter.
The filter ensures that any custom properties defined for the records management type are provided as part of the Form and also assigned to the same field group.
- Author:
- Gavin Cornwell
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final String
protected static final String
protected static final String
Fields inherited from class org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementFormFilter
CUSTOM_RM_FIELD_GROUP_ID, dictionaryService, namespaceService, nodeService, recordService, RM_METADATA_PREFIX, rmAdminService, rmServiceRegistry
Fields inherited from class org.alfresco.repo.forms.processor.AbstractFilter
active, filterRegistry
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.dod5015.DOD5015Model
ASPECT_DIGITAL_PHOTOGRAPH_RECORD, ASPECT_DOD_5015_RECORD, ASPECT_PDF_RECORD, ASPECT_SCANNED_RECORD, ASPECT_WEB_RECORD, DOD_PREFIX, DOD_URI, PROP_ADDRESS, PROP_BIT_DEPTH, PROP_CAPTION, PROP_CAPTURE_DATE, PROP_CAPTURE_METHOD, PROP_COMPRESSION, PROP_CONTACT, PROP_CONTENT_MANAGEMENT_SYSTEM, PROP_COPYRIGHT, PROP_CREATING_APPLICATION, PROP_DATE_RECEIVED, PROP_DOCUMENT_SECURITY_SETTINGS, PROP_EXIF_INFORMATION, PROP_FORMAT, PROP_ICC_ICM_PROFILE, PROP_IMAGE_SIZE_X, PROP_IMAGE_SIZE_Y, PROP_IMAGE_SOURCE, PROP_MEDIA_TYPE, PROP_ORIGINATING_ORGANIZATION, PROP_ORIGINATOR, PROP_OTHER_ADDRESS, PROP_PDF_VERSION, PROP_PHOTOGRAPHER, PROP_PRODUCING_APPLICATION, PROP_PRODUCING_APPLICATION_VERSION, PROP_PUBLICATION_DATE, PROP_RESOLUTION_X, PROP_RESOLUTION_Y, PROP_SCANNED_BIT_DEPTH, PROP_SCANNED_FORMAT, PROP_SCANNED_FORMAT_VERSION, PROP_WEB_FILE_NAME, PROP_WEB_PLATFORM, PROP_WEB_SITE_URL, PROP_WEBSITE_NAME, TYPE_DOD_5015_FILE_PLAN, TYPE_DOD_5015_SITE
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel
ASPECT_CUSTOM_ASSOCIATIONS, ASPECT_SUPPLEMENTAL_MARKING_LIST, CONSTRAINT_CUSTOM_SMLIST, CUSTOM_REF_CROSSREFERENCE, CUSTOM_REF_OBSOLETES, CUSTOM_REF_RENDITION, CUSTOM_REF_SUPERSEDES, CUSTOM_REF_SUPPORTS, CUSTOM_REF_VERSIONS, PROP_SUPPLEMENTAL_MARKING_LIST, RM_CUSTOM_MODEL, RM_CUSTOM_PREFIX, RM_CUSTOM_URI
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel
ASPECT_ARCHIVED, ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COMMON_RECORD_DETAILS, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, ASPECT_DISPOSITION_PROCESSED, ASPECT_EMAIL_CONFIG_ROOT, ASPECT_EXTENDED_SECURITY, ASPECT_FILABLE, ASPECT_FILE_PLAN_COMPONENT, ASPECT_FROZEN, ASPECT_GHOSTED, ASPECT_HELD_CHILDREN, ASPECT_LOADED_DATA_SET_ID, ASPECT_RECORD, ASPECT_RECORD_COMPONENT_ID, ASPECT_RECORD_META_DATA, ASPECT_RECORD_ORIGINATING_DETAILS, ASPECT_RECORD_REJECTION_DETAILS, ASPECT_RECORDS_MANAGEMENT_ROOT, ASPECT_RM_SEARCH, ASPECT_SAVED_SEARCH, ASPECT_SCHEDULED, ASPECT_TRANSFERRED, ASPECT_TRANSFERRING, ASPECT_UNCUT_OFF, ASPECT_UNPUBLISHED_UPDATE, ASPECT_VERSIONED_RECORD, ASPECT_VITAL_RECORD, ASPECT_VITAL_RECORD_DEFINITION, ASSOC_CAVEAT_CONFIG, ASSOC_DISPOSITION_ACTION_DEFINITIONS, ASSOC_DISPOSITION_ACTION_HISTORY, ASSOC_DISPOSITION_SCHEDULE, ASSOC_EMAIL_CONFIG, ASSOC_EVENT_EXECUTIONS, ASSOC_FROZEN_CONTENT, ASSOC_FROZEN_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, GL_URI, PROP_COMBINE_DISPOSITION_STEP_CONDITIONS, PROP_COUNT, PROP_CUT_OFF_DATE, PROP_DATE_FILED, PROP_DB_UNIQUENESS_ID, PROP_DECLARED_AT, PROP_DECLARED_BY, PROP_DISPOSITION_ACTION, PROP_DISPOSITION_ACTION_COMPLETED_AT, PROP_DISPOSITION_ACTION_COMPLETED_BY, PROP_DISPOSITION_ACTION_GHOST_ON_DESTROY, PROP_DISPOSITION_ACTION_ID, PROP_DISPOSITION_ACTION_NAME, PROP_DISPOSITION_ACTION_STARTED_AT, PROP_DISPOSITION_ACTION_STARTED_BY, PROP_DISPOSITION_AS_OF, PROP_DISPOSITION_AUTHORITY, PROP_DISPOSITION_DESCRIPTION, PROP_DISPOSITION_EVENT, PROP_DISPOSITION_EVENT_COMBINATION, PROP_DISPOSITION_EVENTS_ELIGIBLE, PROP_DISPOSITION_INSTRUCTIONS, PROP_DISPOSITION_LOCATION, PROP_DISPOSITION_PERIOD, PROP_DISPOSITION_PERIOD_PROPERTY, PROP_EVENT_EXECUTION_AUTOMATIC, PROP_EVENT_EXECUTION_COMPLETE, PROP_EVENT_EXECUTION_COMPLETED_AT, PROP_EVENT_EXECUTION_COMPLETED_BY, PROP_EVENT_EXECUTION_NAME, PROP_FROZEN_AT, PROP_FROZEN_BY, PROP_HELD_CHILDREN_COUNT, PROP_HOLD_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_MANUALLY_SET_AS_OF, PROP_ORIGIONAL_NAME, PROP_PUBLISH_IN_PROGRESS, PROP_READERS, PROP_RECORD_LEVEL_DISPOSITION, PROP_RECORD_ORIGINATING_CREATION_DATE, PROP_RECORD_ORIGINATING_LOCATION, PROP_RECORD_ORIGINATING_USER_ID, PROP_RECORD_REJECTION_DATE, PROP_RECORD_REJECTION_REASON, PROP_RECORD_REJECTION_USER_ID, PROP_REVIEW_AS_OF, PROP_REVIEW_PERIOD, PROP_ROOT_NODEREF, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_AT, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_BY, PROP_RS_DISPOITION_AUTHORITY, PROP_RS_DISPOITION_INSTRUCTIONS, PROP_RS_DISPOSITION_ACTION_AS_OF, PROP_RS_DISPOSITION_ACTION_NAME, PROP_RS_DISPOSITION_EVENTS, PROP_RS_DISPOSITION_EVENTS_ELIGIBLE, PROP_RS_DISPOSITION_PERIOD, PROP_RS_DISPOSITION_PERIOD_EXPRESSION, PROP_RS_HAS_DISPOITION_SCHEDULE, PROP_RS_HOLD_REASON, PROP_RS_VITAL_RECORD_REVIEW_PERIOD, PROP_RS_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION, PROP_TRANSFER_ACCESSION_INDICATOR, PROP_TRANSFER_LOCATION, PROP_TRANSFER_PDF_INDICATOR, PROP_UNPUBLISHED_UPDATE, PROP_UPDATE_TO, PROP_UPDATED_PROPERTIES, PROP_VITAL_RECORD_INDICATOR, PROP_WRITERS, RM_MODEL, RM_PREFIX, RM_URI, TYPE_CAVEAT_CONFIG, TYPE_DISPOSITION_ACTION, TYPE_DISPOSITION_ACTION_DEFINITION, TYPE_DISPOSITION_SCHEDULE, TYPE_EMAIL_CONFIG, TYPE_EVENT_EXECUTION, TYPE_FILE_PLAN, TYPE_HOLD, TYPE_HOLD_CONTAINER, TYPE_NON_ELECTRONIC_DOCUMENT, TYPE_RECORD_CATEGORY, TYPE_RECORD_FOLDER, TYPE_RECORDS_MANAGEMENT_CONTAINER, TYPE_RM_SITE, TYPE_TRANSFER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER, TYPE_UNFILED_RECORD_FOLDER, UPDATE_TO_DISPOSITION_ACTION_DEFINITION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addCustomPropertyFieldsToGroup
(Form form, NodeRef nodeRef) protected void
addRecordMetadataPropertyFieldsToGroup
(Form form, NodeRef nodeRef) protected void
addTransientProperties
(Form form, NodeRef nodeRef) protected void
addTransientPropertyField
(Form form, String name, QName type, Object value) void
afterGenerate
(NodeRef nodeRef, List<String> fields, List<String> forcedFields, Form form, Map<String, Object> context) protected void
forceSupplementalMarkingListProperty
(Form form, NodeRef nodeRef) Forces the "rmc:supplementalMarkingList" property to be present, if it is already on the given node this method does nothing, otherwise a property field definition is generated for the property.protected DispositionService
Returns the disposition serviceprotected FilePlanService
Returns the file plan serviceprotected void
protectEmailExtractedFields
(Form form, NodeRef nodeRef) Marks all the fields that contain data extracted from an email as protected fields.protected void
Marks the recordLevelDisposition property as protected to disable editingprotected void
protectRecordProperties
(Form form, NodeRef nodeRef) void
setDispositionService
(DispositionService dispositionService) Sets the disposition servicevoid
setFilePlanService
(FilePlanService filePlanService) Methods inherited from class org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementFormFilter
addPropertyFieldsToGroup, afterPersist, beforeGenerate, beforePersist, setDictionaryService, setNamespaceService, setNodeService, setRecordService, setRecordsManagementAdminService, setRecordsManagementServiceRegistry
Methods inherited from class org.alfresco.repo.forms.processor.AbstractFilter
isActive, register, setActive, setFilterRegistry, toString
-
Field Details
-
TRANSIENT_DECLARED
- See Also:
-
TRANSIENT_CATEGORY_ID
- See Also:
-
TRANSIENT_DISPOSITION_INSTRUCTIONS
- See Also:
-
-
Constructor Details
-
RecordsManagementNodeFormFilter
public RecordsManagementNodeFormFilter()
-
-
Method Details
-
getDispositionService
Returns the disposition service- Returns:
- Disposition service
-
getFilePlanService
Returns the file plan service- Returns:
- File plan service
-
setDispositionService
Sets the disposition service- Parameters:
dispositionService
- disposition service
-
setFilePlanService
- Parameters:
filePlanService
- file plan service
-
afterGenerate
public void afterGenerate(NodeRef nodeRef, List<String> fields, List<String> forcedFields, Form form, Map<String, Object> context) - Specified by:
afterGenerate
in interfaceFilter<NodeRef,
NodeRef> - See Also:
-
addCustomPropertyFieldsToGroup
- Parameters:
form
-nodeRef
-
-
addRecordMetadataPropertyFieldsToGroup
- Parameters:
form
-nodeRef
-
-
forceSupplementalMarkingListProperty
Forces the "rmc:supplementalMarkingList" property to be present, if it is already on the given node this method does nothing, otherwise a property field definition is generated for the property.- Parameters:
form
- The Form instance to add the property tonodeRef
- The node the form is being generated for
-
addTransientProperties
- Parameters:
form
-nodeRef
-
-
addTransientPropertyField
- Parameters:
form
-name
-type
-value
-
-
protectRecordProperties
- Parameters:
form
-nodeRef
-
-
protectEmailExtractedFields
Marks all the fields that contain data extracted from an email as protected fields.- Parameters:
form
- The Form instance to add the property tonodeRef
- The node the form is being generated for
-
protectRecordLevelDispositionPropertyField
Marks the recordLevelDisposition property as protected to disable editing- Parameters:
form
- The Form instance
-