org.alfresco.module.org_alfresco_module_rm.model.behaviour

Class RecordsManagementSearchBehaviour

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.model.behaviour.RecordsManagementSearchBehaviour

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel

public class RecordsManagementSearchBehaviour
extends Object
implements RecordsManagementModel

Search behaviour class. Manages the collapse of data onto the supporting aspect on the record/record folder.

Since:

1.0

Author:

Roy Wetherall

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	convertedToOrFromRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName oldType, org.alfresco.service.namespace.QName newType) On update type to or from record folder behaviour implementation
void	disableDispositionScheduleBehaviour() Disabled disposition schedule behaviour
void	dispositionActionCreate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) On disposition action create behaviour implementation
void	dispositionActionPropertiesUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before, Map<org.alfresco.service.namespace.QName,Serializable> after) Updates the disposition action properties
void	dispositionSchedulePropertiesUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before, Map<org.alfresco.service.namespace.QName,Serializable> after) Updates the disposition schedule properties
void	enableDispositionScheduleBehaviour() Enables disposition schedule behaviour
void	eventExecutionDelete(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef, boolean isNodeArchived) On event execution delete behaviour implementation.
void	eventExecutionUpdate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef, boolean isNewNode) On update of event execution information behaviour\
void	fixupSearchAspect(org.alfresco.service.cmr.repository.NodeRef recordOrFolder) Ensures the search aspect for the given node is present, complete and correct.
void	init() Initialisation method
void	onAddDispositionLifecycleAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspectTypeQName) On addition of the disposition lifecycle aspect
void	onAddRecordAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspectTypeQName) On add record aspect behaviour implementation
void	recordFolderCreate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) On create record folder behaviour implmentation
void	rmSearchAspectAdd(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspectTypeQName) On add search aspect behaviour implementation.
void	setDispositionService(DispositionService dispositionService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)
void	setRecordFolderService(RecordFolderService recordFolderService)
void	setRecordService(RecordService recordService)
void	setRecordsManagementServiceRegistry(RecordsManagementServiceRegistry recordsManagementServiceRegistry)
void	setVitalRecordService(VitalRecordService vitalRecordService)
void	vitalRecordDefintionAddAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspectTypeQName) On add aspect vital record defintion behaviour implementation.
void	vitalRecordDefintionUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef, Map<org.alfresco.service.namespace.QName,Serializable> before, Map<org.alfresco.service.namespace.QName,Serializable> after) On update vital record definition properties behaviour implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordsManagementSearchBehaviour

public RecordsManagementSearchBehaviour()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Parameters:

nodeService - the nodeService to set

setDispositionService

public void setDispositionService(DispositionService dispositionService)

Parameters:

dispositionService - the disposition service

setPolicyComponent

public void setPolicyComponent(org.alfresco.repo.policy.PolicyComponent policyComponent)

Parameters:

policyComponent - the policyComponent to set

setRecordsManagementServiceRegistry

public void setRecordsManagementServiceRegistry(RecordsManagementServiceRegistry recordsManagementServiceRegistry)

Parameters:

recordsManagementServiceRegistry - the records management service registry

setVitalRecordService

public void setVitalRecordService(VitalRecordService vitalRecordService)

Parameters:

vitalRecordService - vital record service

setRecordFolderService

public void setRecordFolderService(RecordFolderService recordFolderService)

Parameters:

recordFolderService - record folder service

setRecordService

public void setRecordService(RecordService recordService)

Parameters:

recordService - record service

init

public void init()

Initialisation method

disableDispositionScheduleBehaviour

public void disableDispositionScheduleBehaviour()

Disabled disposition schedule behaviour

enableDispositionScheduleBehaviour

public void enableDispositionScheduleBehaviour()

Enables disposition schedule behaviour

fixupSearchAspect

public void fixupSearchAspect(org.alfresco.service.cmr.repository.NodeRef recordOrFolder)

Ensures the search aspect for the given node is present, complete and correct.

Parameters:

recordOrFolder - node reference to record or record folder

dispositionActionPropertiesUpdate

public void dispositionActionPropertiesUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                              Map<org.alfresco.service.namespace.QName,Serializable> before,
                                              Map<org.alfresco.service.namespace.QName,Serializable> after)

Updates the disposition action properties

Parameters:

nodeRef - node reference

before - value of properties before

after - value of properties after

onAddRecordAspect

public void onAddRecordAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                              org.alfresco.service.namespace.QName aspectTypeQName)

On add record aspect behaviour implementation

Parameters:

nodeRef - node reference

aspectTypeQName - aspect type qname

onAddDispositionLifecycleAspect

public void onAddDispositionLifecycleAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                            org.alfresco.service.namespace.QName aspectTypeQName)

On addition of the disposition lifecycle aspect

Parameters:

nodeRef -

aspectTypeQName -

recordFolderCreate

public void recordFolderCreate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

On create record folder behaviour implmentation

Parameters:

childAssocRef - child association reference

convertedToOrFromRecordFolder

public void convertedToOrFromRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                          org.alfresco.service.namespace.QName oldType,
                                          org.alfresco.service.namespace.QName newType)

On update type to or from record folder behaviour implementation

Parameters:

nodeRef - the updated node

oldType - the type the node had before update

newType - the type the node has after update

dispositionActionCreate

public void dispositionActionCreate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

On disposition action create behaviour implementation

Parameters:

childAssocRef - child association reference

eventExecutionUpdate

public void eventExecutionUpdate(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef,
                                 boolean isNewNode)

On update of event execution information behaviour\

Parameters:

childAssocRef - child association reference

isNewNode - true if a new node, false otherwise

eventExecutionDelete

public void eventExecutionDelete(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef,
                                 boolean isNodeArchived)

On event execution delete behaviour implementation.

Parameters:

childAssocRef - child association reference

isNodeArchived - true if node is archived on delete, false otherwise

rmSearchAspectAdd

public void rmSearchAspectAdd(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                              org.alfresco.service.namespace.QName aspectTypeQName)

On add search aspect behaviour implementation.

Parameters:

nodeRef - node reference

aspectTypeQName - aspect type qname

vitalRecordDefintionAddAspect

public void vitalRecordDefintionAddAspect(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                          org.alfresco.service.namespace.QName aspectTypeQName)

On add aspect vital record defintion behaviour implementation.

Parameters:

nodeRef - node reference

aspectTypeQName - aspect tyep qname

vitalRecordDefintionUpdateProperties

public void vitalRecordDefintionUpdateProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                 Map<org.alfresco.service.namespace.QName,Serializable> before,
                                                 Map<org.alfresco.service.namespace.QName,Serializable> after)

On update vital record definition properties behaviour implementation.

Parameters:

nodeRef - node reference

before - before properties

after - after properties

dispositionSchedulePropertiesUpdate

public void dispositionSchedulePropertiesUpdate(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                Map<org.alfresco.service.namespace.QName,Serializable> before,
                                                Map<org.alfresco.service.namespace.QName,Serializable> after)

Updates the disposition schedule properties

Parameters:

nodeRef - node reference

before - properties before

after - properties after