org.alfresco.module.org_alfresco_module_rm.forms

Class RecordsManagementTypeFormFilter

java.lang.Object

org.alfresco.repo.forms.processor.AbstractFilter<ItemType,org.alfresco.service.cmr.repository.NodeRef>

org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementFormFilter<org.alfresco.service.cmr.dictionary.TypeDefinition>

org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementTypeFormFilter

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel, org.alfresco.repo.forms.processor.Filter<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

public class RecordsManagementTypeFormFilter
extends RecordsManagementFormFilter<org.alfresco.service.cmr.dictionary.TypeDefinition>
implements RecordsManagementModel

Implementation of a form processor Filter.

The filter implements the afterGenerate method to ensure a default unique identifier is provided for the rma:identifier property.

The filter also ensures that any custom properties defined for the records management type are provided as part of the Form.

Author:

Gavin Cornwell

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.alfresco.repo.forms.FieldGroup	DESC_FIELD_GROUP
protected static String	DESC_FIELD_GROUP_ID
protected IdentifierService	identifierService Identifier service
protected static org.alfresco.repo.forms.FieldGroup	NAME_FIELD_GROUP
protected static String	NAME_FIELD_GROUP_ID
protected static org.alfresco.repo.forms.FieldGroup	OTHER_FIELD_GROUP
protected static String	OTHER_FIELD_GROUP_ID
protected static org.alfresco.repo.forms.FieldGroup	TITLE_FIELD_GROUP
protected static String	TITLE_FIELD_GROUP_ID

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.model.RecordsManagementModel

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_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_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_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, 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_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

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

Constructor Summary

Constructors

Constructor and Description
RecordsManagementTypeFormFilter()

Method Summary

Modifier and Type	Method and Description
protected void	addCustomRMProperties(org.alfresco.service.namespace.QName customisableType, org.alfresco.repo.forms.Form form) Adds a property definition for each of the custom properties for the given RM type to the given form.
void	afterGenerate(org.alfresco.service.cmr.dictionary.TypeDefinition type, List<String> fields, List<String> forcedFields, org.alfresco.repo.forms.Form form, Map<String,Object> context)
void	afterPersist(org.alfresco.service.cmr.dictionary.TypeDefinition item, org.alfresco.repo.forms.FormData data, org.alfresco.service.cmr.repository.NodeRef persistedObject)
void	beforePersist(org.alfresco.service.cmr.dictionary.TypeDefinition item, org.alfresco.repo.forms.FormData data)
void	setIdentifierService(IdentifierService identifierService)

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementFormFilter

addPropertyFieldsToGroup, beforeGenerate, setDictionaryService, setNamespaceService, setNodeService, setRecordService, setRecordsManagementAdminService, setRecordsManagementServiceRegistry

Methods inherited from class org.alfresco.repo.forms.processor.AbstractFilter

isActive, register, setActive, setFilterRegistry, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAME_FIELD_GROUP_ID

protected static final String NAME_FIELD_GROUP_ID

See Also:

Constant Field Values

TITLE_FIELD_GROUP_ID

protected static final String TITLE_FIELD_GROUP_ID

See Also:

Constant Field Values

DESC_FIELD_GROUP_ID

protected static final String DESC_FIELD_GROUP_ID

See Also:

Constant Field Values

OTHER_FIELD_GROUP_ID

protected static final String OTHER_FIELD_GROUP_ID

See Also:

Constant Field Values

NAME_FIELD_GROUP

protected static final org.alfresco.repo.forms.FieldGroup NAME_FIELD_GROUP

TITLE_FIELD_GROUP

protected static final org.alfresco.repo.forms.FieldGroup TITLE_FIELD_GROUP

DESC_FIELD_GROUP

protected static final org.alfresco.repo.forms.FieldGroup DESC_FIELD_GROUP

OTHER_FIELD_GROUP

protected static final org.alfresco.repo.forms.FieldGroup OTHER_FIELD_GROUP

identifierService

protected IdentifierService identifierService

Identifier service

Constructor Detail

RecordsManagementTypeFormFilter

public RecordsManagementTypeFormFilter()

Method Detail

setIdentifierService

public void setIdentifierService(IdentifierService identifierService)

Parameters:

identifierService - identifier service

afterGenerate

public void afterGenerate(org.alfresco.service.cmr.dictionary.TypeDefinition type,
                          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.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

addCustomRMProperties

protected void addCustomRMProperties(org.alfresco.service.namespace.QName customisableType,
                                     org.alfresco.repo.forms.Form form)

Adds a property definition for each of the custom properties for the given RM type to the given form.

Parameters:

rmTypeCustomAspect - Enum representing the RM type to add custom properties for

form - The form to add the properties to

beforePersist

public void beforePersist(org.alfresco.service.cmr.dictionary.TypeDefinition item,
                          org.alfresco.repo.forms.FormData data)

Specified by:

beforePersist in interface org.alfresco.repo.forms.processor.Filter<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Overrides:

beforePersist in class RecordsManagementFormFilter<org.alfresco.service.cmr.dictionary.TypeDefinition>

See Also:

RecordsManagementFormFilter.beforePersist(java.lang.Object, org.alfresco.repo.forms.FormData)

afterPersist

public void afterPersist(org.alfresco.service.cmr.dictionary.TypeDefinition item,
                         org.alfresco.repo.forms.FormData data,
                         org.alfresco.service.cmr.repository.NodeRef persistedObject)

Specified by:

afterPersist in interface org.alfresco.repo.forms.processor.Filter<org.alfresco.service.cmr.dictionary.TypeDefinition,org.alfresco.service.cmr.repository.NodeRef>

Overrides:

afterPersist in class RecordsManagementFormFilter<org.alfresco.service.cmr.dictionary.TypeDefinition>

See Also:

RecordsManagementFormFilter.afterPersist(java.lang.Object, org.alfresco.repo.forms.FormData, org.alfresco.service.cmr.repository.NodeRef)