Package org.alfresco.module.org_alfresco_module_rm.model.rma.type

Class RmSiteType

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.model.BaseBehaviourBean

org.alfresco.module.org_alfresco_module_rm.model.rma.type.RmSiteType

All Implemented Interfaces:

RecordsManagementCustomModel, RecordsManagementModel, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnCreateChildAssociationPolicy, NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnDeleteChildAssociationPolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, BehaviourRegistry, AssociationPolicy, ClassPolicy, Policy, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class RmSiteType
extends BaseBehaviourBean
implements NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.OnUpdatePropertiesPolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnCreateChildAssociationPolicy, NodeServicePolicies.OnDeleteChildAssociationPolicy

Behaviour associated with the RM Site type

Since:

2.2

Author:

Roy Wetherall, Silviu Dinuta

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields

Modifier and Type	Field	Description
protected CapabilityService	capabilityService	Capability service
static final String	COMPONENT_DOCUMENT_LIBRARY	Constant values
static final QName	DEFAULT_FILE_PLAN_TYPE
static final String	DEFAULT_SITE_NAME
protected Map<QName,QName>	mapFilePlanType	Map of file plan type's key'ed by corresponding site types
protected RecordsManagementSearchService	recordsManagementSearchService	Record Management Search Service
protected SiteService	siteService	Site service

Fields inherited from class org.alfresco.module.org_alfresco_module_rm.model.BaseBehaviourBean

behaviourFilter, behaviours, LOGGER, MULTIPLE_CHILDREN_TYPE_ERROR, UNIQUE_CHILD_TYPE_ERROR

Fields inherited from class org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

applicationContext, authenticationUtil, contentService, dictionaryService, nodeService, nodeTypeUtility, renditionService, transactionalResourceHelper

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnCreateNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnDeleteChildAssociationPolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnUpdatePropertiesPolicy

ARG_0, ARG_1, ARG_2, QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

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_DELETION_REASON, 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

Constructor	Description
RmSiteType()

Method Summary

Modifier and Type	Method	Description
void	beforeDeleteNode(NodeRef nodeRef)
void	onCreateChildAssociation(ChildAssociationRef childAssocRef, boolean isNewNode)	Add the limitation of creating only one rma:filePlan or one dod:filePlan depending on the type of rm site.
void	onCreateNode(ChildAssociationRef childAssocRef)
void	onDeleteChildAssociation(ChildAssociationRef childAssocRef)	Handles site deletion in order to reset the records management root cache
void	onDeleteNodeOnCommit(ChildAssociationRef childAssocRef, boolean isNodeArchived)	Handles the deletion node policy (alf:onDeleteNode), resetting the records management root cache and enabling file plan behavior as well
void	onUpdateProperties(NodeRef nodeRef, Map<QName,Serializable> before, Map<QName,Serializable> after)	Ensure that the visibility of a RM site can not be changed to anything but public.
void	registerFilePlanType(QName siteType, QName filePlanType)	Registers a file plan type for a specific site type.
void	setAuthorityService(AuthorityService authorityService)
void	setCapabilityService(CapabilityService capabilityService)
void	setFilePlanType(FilePlanType filePlanType)
void	setRecordsManagementSearchService(RecordsManagementSearchService recordsManagementSearchService)
void	setRmContainerCacheManager(RMContainerCacheManager rmContainerCacheManager)
void	setSiteService(SiteService siteService)	Set the site service

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.model.BaseBehaviourBean

getBehaviour, registerBehaviour, setBehaviourFilter, validateNewChildAssociation, validateNewChildAssociationSubTypesIncluded

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

getFilePlan, getFilePlanComponentKind, getFilePlanComponentKindFromType, getInternalNodeService, getNextCount, getTypeAndApsects, instanceOf, instanceOf, isDeclared, isFilePlan, isFilePlanComponent, isFilePlanContainer, isHold, isRecord, isRecordCategory, isRecordFolder, isTransfer, isUnfiledRecordsContainer, setApplicationContext, setAuthenticationUtil, setContentService, setDictionaryService, setNodeService, setNodeTypeUtility, setRenditionService, setTransactionalResourceHelper

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_DOCUMENT_LIBRARY

public static final String COMPONENT_DOCUMENT_LIBRARY

Constant values

See Also:

• Constant Field Values

DEFAULT_SITE_NAME

public static final String DEFAULT_SITE_NAME

See Also:

• Constant Field Values

DEFAULT_FILE_PLAN_TYPE

public static final QName DEFAULT_FILE_PLAN_TYPE

siteService

protected SiteService siteService

Site service

recordsManagementSearchService

protected RecordsManagementSearchService recordsManagementSearchService

Record Management Search Service

capabilityService

protected CapabilityService capabilityService

Capability service

mapFilePlanType

protected Map<QName,QName> mapFilePlanType

Map of file plan type's key'ed by corresponding site types

Constructor Details

RmSiteType

public RmSiteType()

Method Details

setSiteService

public void setSiteService(SiteService siteService)

Set the site service

Parameters:

siteService - site service

setRecordsManagementSearchService

public void setRecordsManagementSearchService(RecordsManagementSearchService recordsManagementSearchService)

Parameters:

recordsManagementSearchService - records management search service

setCapabilityService

public void setCapabilityService(CapabilityService capabilityService)

Parameters:

capabilityService - capability service

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Parameters:

authorityService - authority service

setFilePlanType

public void setFilePlanType(FilePlanType filePlanType)

setRmContainerCacheManager

public void setRmContainerCacheManager(RMContainerCacheManager rmContainerCacheManager)

Parameters:

rmContainerCacheManager - RM container cache manager

registerFilePlanType

public void registerFilePlanType(QName siteType,
 QName filePlanType)

Registers a file plan type for a specific site type.

Parameters:

siteType - siteType sub-type of rma:rmsite

filePlanType - filePlanType sub-type of rma:filePlan

Since:

2.2

onCreateNode

public void onCreateNode(ChildAssociationRef childAssocRef)

Specified by:

onCreateNode in interface NodeServicePolicies.OnCreateNodePolicy

See Also:

• NodeServicePolicies.OnCreateNodePolicy.onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef)

onUpdateProperties

public void onUpdateProperties(NodeRef nodeRef,
 Map<QName,Serializable> before,
 Map<QName,Serializable> after)

Ensure that the visibility of a RM site can not be changed to anything but public. TODO support other site visibilities

Specified by:

onUpdateProperties in interface NodeServicePolicies.OnUpdatePropertiesPolicy

See Also:

• NodeServicePolicies.OnUpdatePropertiesPolicy.onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef, java.util.Map, java.util.Map)

beforeDeleteNode

public void beforeDeleteNode(NodeRef nodeRef)

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

See Also:

• NodeServicePolicies.BeforeDeleteNodePolicy.beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef)

onDeleteChildAssociation

public void onDeleteChildAssociation(ChildAssociationRef childAssocRef)

Handles site deletion in order to reset the records management root cache

Specified by:

onDeleteChildAssociation in interface NodeServicePolicies.OnDeleteChildAssociationPolicy

Parameters:

childAssocRef -

See Also:

• NodeServicePolicies.OnDeleteAssociationPolicy.onDeleteAssociation(org.alfresco.service.cmr.repository.AssociationRef)

onCreateChildAssociation

public void onCreateChildAssociation(ChildAssociationRef childAssocRef,
 boolean isNewNode)

Add the limitation of creating only one rma:filePlan or one dod:filePlan depending on the type of rm site. Let multiple cm:folder type be created under rm site. Other than this nothing can be created under rm site nodeRef

Specified by:

onCreateChildAssociation in interface NodeServicePolicies.OnCreateChildAssociationPolicy

Since:

2.6

onDeleteNodeOnCommit

public void onDeleteNodeOnCommit(ChildAssociationRef childAssocRef,
 boolean isNodeArchived)

Handles the deletion node policy (alf:onDeleteNode), resetting the records management root cache and enabling file plan behavior as well

Parameters:

childAssocRef -

isNodeArchived -