Class RecordsManagementNodeFormFilter

  • All Implemented Interfaces:
    DOD5015Model, RecordsManagementCustomModel, RecordsManagementModel, org.alfresco.repo.forms.processor.Filter<org.alfresco.service.cmr.repository.NodeRef,​org.alfresco.service.cmr.repository.NodeRef>

    public class RecordsManagementNodeFormFilter
    extends RecordsManagementFormFilter<org.alfresco.service.cmr.repository.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
    • Constructor Detail

      • RecordsManagementNodeFormFilter

        public RecordsManagementNodeFormFilter()
    • Method Detail

      • getDispositionService

        protected DispositionService getDispositionService()
        Returns the disposition service
        Returns:
        Disposition service
      • getFilePlanService

        protected FilePlanService getFilePlanService()
        Returns the file plan service
        Returns:
        File plan service
      • setDispositionService

        public void setDispositionService​(DispositionService dispositionService)
        Sets the disposition service
        Parameters:
        dispositionService - disposition service
      • setFilePlanService

        public void setFilePlanService​(FilePlanService filePlanService)
        Parameters:
        filePlanService - file plan service
      • afterGenerate

        public void afterGenerate​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                  List<String> fields,
                                  List<String> forcedFields,
                                  org.alfresco.repo.forms.Form form,
                                  Map<String,​Object> context)
        Specified by:
        afterGenerate in interface org.alfresco.repo.forms.processor.Filter<org.alfresco.service.cmr.repository.NodeRef,​org.alfresco.service.cmr.repository.NodeRef>
        See Also:
        Filter.afterGenerate(java.lang.Object, java.util.List, java.util.List, org.alfresco.repo.forms.Form, java.util.Map)
      • addCustomPropertyFieldsToGroup

        protected void addCustomPropertyFieldsToGroup​(org.alfresco.repo.forms.Form form,
                                                      org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Parameters:
        form -
        nodeRef -
      • addRecordMetadataPropertyFieldsToGroup

        protected void addRecordMetadataPropertyFieldsToGroup​(org.alfresco.repo.forms.Form form,
                                                              org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Parameters:
        form -
        nodeRef -
      • forceSupplementalMarkingListProperty

        protected void forceSupplementalMarkingListProperty​(org.alfresco.repo.forms.Form form,
                                                            org.alfresco.service.cmr.repository.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.
        Parameters:
        form - The Form instance to add the property to
        nodeRef - The node the form is being generated for
      • addTransientProperties

        protected void addTransientProperties​(org.alfresco.repo.forms.Form form,
                                              org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Parameters:
        form -
        nodeRef -
      • addTransientPropertyField

        protected void addTransientPropertyField​(org.alfresco.repo.forms.Form form,
                                                 String name,
                                                 org.alfresco.service.namespace.QName type,
                                                 Object value)
        Parameters:
        form -
        name -
        type -
        value -
      • protectRecordProperties

        protected void protectRecordProperties​(org.alfresco.repo.forms.Form form,
                                               org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Parameters:
        form -
        nodeRef -
      • protectEmailExtractedFields

        protected void protectEmailExtractedFields​(org.alfresco.repo.forms.Form form,
                                                   org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Marks all the fields that contain data extracted from an email as protected fields.
        Parameters:
        form - The Form instance to add the property to
        nodeRef - The node the form is being generated for
      • protectRecordLevelDispositionPropertyField

        protected void protectRecordLevelDispositionPropertyField​(org.alfresco.repo.forms.Form form)
        Marks the recordLevelDisposition property as protected to disable editing
        Parameters:
        form - The Form instance