org.alfresco.module.org_alfresco_module_rm.hold

Class HoldServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.hold.HoldServiceImpl

All Implemented Interfaces:

HoldService, RecordsManagementCustomModel, RecordsManagementModel, org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy, org.alfresco.repo.policy.ClassPolicy, org.alfresco.repo.policy.Policy, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class HoldServiceImpl
extends ServiceBaseImpl
implements HoldService, org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy, RecordsManagementModel

Hold service implementation

Since:

2.2

Author:

Tuna Aksoy

Nested Class Summary

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

org.alfresco.repo.policy.Policy.Arg

Field Summary

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

applicationContext, authenticationUtil, dictionaryService, nodeService, renditionService, transactionalResourceHelper

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

QNAME

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

NAMESPACE

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
HoldServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addToHold(org.alfresco.service.cmr.repository.NodeRef hold, List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Adds the items to the the given hold
void	addToHold(org.alfresco.service.cmr.repository.NodeRef hold, org.alfresco.service.cmr.repository.NodeRef nodeRef) Adds the record to the given hold
void	addToHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds, List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Adds the given items to the given list of holds
void	addToHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds, org.alfresco.service.cmr.repository.NodeRef nodeRef) Adds the record to the given list of holds
void	beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef hold) Behaviour unfreezes node's that will no longer he held after delete.
org.alfresco.service.cmr.repository.NodeRef	createHold(org.alfresco.service.cmr.repository.NodeRef filePlan, String name, String reason, String description) Creates a hold with the given name, reason and description for the given file plan
void	deleteHold(org.alfresco.service.cmr.repository.NodeRef hold) Deletes the hold
List<org.alfresco.service.cmr.repository.NodeRef>	getHeld(org.alfresco.service.cmr.repository.NodeRef hold) Gets the list of item node references which are in the given hold
org.alfresco.service.cmr.repository.NodeRef	getHold(org.alfresco.service.cmr.repository.NodeRef filePlan, String name) Gets the node reference for the hold with the given name in the given file plan
String	getHoldReason(org.alfresco.service.cmr.repository.NodeRef hold) Gets the hold reason for the given hold node reference
List<org.alfresco.service.cmr.repository.NodeRef>	getHolds(org.alfresco.service.cmr.repository.NodeRef filePlan) Gets the list of all the holds within the holds container in the given file plan
List<org.alfresco.service.cmr.repository.NodeRef>	heldBy(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean includedInHold) Gets the list of all the holds within the holds container for the given node reference
void	init() Initialise hold service
void	removeFromAllHolds(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Removes the given list of NodeRefs from all the holds
void	removeFromAllHolds(org.alfresco.service.cmr.repository.NodeRef nodeRef) Removes the given NodeRef from all the holds
void	removeFromHold(org.alfresco.service.cmr.repository.NodeRef hold, List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Removes the given items from the given hold
void	removeFromHold(org.alfresco.service.cmr.repository.NodeRef hold, org.alfresco.service.cmr.repository.NodeRef nodeRef) Removes the record from the given hold
void	removeFromHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds, List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs) Removes the items from the given holds
void	removeFromHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds, org.alfresco.service.cmr.repository.NodeRef nodeRef) Removes the item from the given list of hold
void	setFilePlanService(FilePlanService filePlanService) Set the file plan service
void	setHoldReason(org.alfresco.service.cmr.repository.NodeRef hold, String reason) Sets the hold reason
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService) Set the permission service
void	setRecordFolderService(RecordFolderService recordFolderService) Set the record folder service
void	setRecordService(RecordService recordService) Set the record service
void	setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService)

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, setDictionaryService, setRenditionService, setTransactionalResourceHelper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.module.org_alfresco_module_rm.hold.HoldService

isHold

Constructor Detail

HoldServiceImpl

public HoldServiceImpl()

Method Detail

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

Set the file plan service

Parameters:

filePlanService - the file plan service

setNodeService

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

Set the node service

Overrides:

setNodeService in class ServiceBaseImpl

Parameters:

nodeService - the node service

setRecordService

public void setRecordService(RecordService recordService)

Set the record service

Parameters:

recordService - the record service

setRecordFolderService

public void setRecordFolderService(RecordFolderService recordFolderService)

Set the record folder service

Parameters:

recordFolderService - the record folder service

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

Set the permission service

Parameters:

permissionService - the permission services

setRecordsManagementAuditService

public void setRecordsManagementAuditService(RecordsManagementAuditService recordsManagementAuditService)

Parameters:

recordsManagementAuditService - records management audit service

init

public void init()

Initialise hold service

beforeDeleteNode

public void beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef hold)

Behaviour unfreezes node's that will no longer he held after delete.

Specified by:

beforeDeleteNode in interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

See Also:

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

getHolds

public List<org.alfresco.service.cmr.repository.NodeRef> getHolds(org.alfresco.service.cmr.repository.NodeRef filePlan)

Description copied from interface: HoldService

Gets the list of all the holds within the holds container in the given file plan

Specified by:

getHolds in interface HoldService

Parameters:

filePlan - The NodeRef of the file plan

Returns:

List of hold node references

See Also:

HoldService.getHolds(org.alfresco.service.cmr.repository.NodeRef)

heldBy

public List<org.alfresco.service.cmr.repository.NodeRef> heldBy(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                                boolean includedInHold)

Description copied from interface: HoldService

Gets the list of all the holds within the holds container for the given node reference

Specified by:

heldBy in interface HoldService

Parameters:

nodeRef - The NodeRef of the record / record folder

includedInHold - true to retrieve the list of hold node references which will include the node reference false to get a list of node references which will not have the given node reference

Returns:

List of hold node references

See Also:

HoldService.heldBy(org.alfresco.service.cmr.repository.NodeRef, boolean)

getHold

public org.alfresco.service.cmr.repository.NodeRef getHold(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                                           String name)

Description copied from interface: HoldService

Gets the node reference for the hold with the given name in the given file plan

Specified by:

getHold in interface HoldService

name - String The name of the hold

Returns:

NodeRef of the hold with the given name

See Also:

HoldService.getHold(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

getHeld

public List<org.alfresco.service.cmr.repository.NodeRef> getHeld(org.alfresco.service.cmr.repository.NodeRef hold)

Description copied from interface: HoldService

Gets the list of item node references which are in the given hold

Specified by:

getHeld in interface HoldService

Parameters:

hold - NodeRef of the hold

Returns:

Lost of item NodeRefs which are in the given hold

See Also:

HoldService.getHeld(org.alfresco.service.cmr.repository.NodeRef)

createHold

public org.alfresco.service.cmr.repository.NodeRef createHold(org.alfresco.service.cmr.repository.NodeRef filePlan,
                                                              String name,
                                                              String reason,
                                                              String description)

Description copied from interface: HoldService

Creates a hold with the given name, reason and description for the given file plan

Specified by:

createHold in interface HoldService

Parameters:

filePlan - The NodeRef of the file plan

name - String The name of the hold

reason - String The reason of the hold

description - String The description of the hold

Returns:

The NodeRef of the created hold

See Also:

HoldService.createHold(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String, java.lang.String)

getHoldReason

public String getHoldReason(org.alfresco.service.cmr.repository.NodeRef hold)

Description copied from interface: HoldService

Gets the hold reason for the given hold node reference

Specified by:

getHoldReason in interface HoldService

Parameters:

hold - The NodeRef of the hold

Returns:

String The reason of the hold

See Also:

HoldService.getHoldReason(org.alfresco.service.cmr.repository.NodeRef)

setHoldReason

public void setHoldReason(org.alfresco.service.cmr.repository.NodeRef hold,
                          String reason)

Description copied from interface: HoldService

Sets the hold reason

Specified by:

setHoldReason in interface HoldService

Parameters:

hold - The NodeRef of the hold

reason - String The reason for the hold

See Also:

HoldService.setHoldReason(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

deleteHold

public void deleteHold(org.alfresco.service.cmr.repository.NodeRef hold)

Description copied from interface: HoldService

Deletes the hold

Specified by:

deleteHold in interface HoldService

Parameters:

hold - The NodeRef of the hold

See Also:

HoldService.deleteHold(org.alfresco.service.cmr.repository.NodeRef)

addToHold

public void addToHold(org.alfresco.service.cmr.repository.NodeRef hold,
                      org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: HoldService

Adds the record to the given hold

Specified by:

addToHold in interface HoldService

Parameters:

hold - The NodeRef of the hold

nodeRef - The NodeRef of the record / record folder which will be added to the given hold

See Also:

HoldService.addToHold(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)

addToHold

public void addToHold(org.alfresco.service.cmr.repository.NodeRef hold,
                      List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Description copied from interface: HoldService

Adds the items to the the given hold

Specified by:

addToHold in interface HoldService

Parameters:

hold - The NodeRef of the hold to which the items will be added

nodeRefs - The item NodeRefs which will be added to the hold

See Also:

HoldService.addToHold(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

addToHolds

public void addToHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds,
                       org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: HoldService

Adds the record to the given list of holds

Specified by:

addToHolds in interface HoldService

Parameters:

holds - The list of NodeRefs of the holds

nodeRef - The NodeRef of the record / record folder which will be added to the given holds

See Also:

HoldService.addToHolds(java.util.List, org.alfresco.service.cmr.repository.NodeRef)

addToHolds

public void addToHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds,
                       List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Description copied from interface: HoldService

Adds the given items to the given list of holds

Specified by:

addToHolds in interface HoldService

Parameters:

holds - List of holds to which the given items will be added

nodeRefs - The list of items which will be added to the given holds

See Also:

HoldService.addToHolds(java.util.List, java.util.List)

removeFromHold

public void removeFromHold(org.alfresco.service.cmr.repository.NodeRef hold,
                           org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: HoldService

Removes the record from the given hold

Specified by:

removeFromHold in interface HoldService

Parameters:

hold - The NodeRef of the hold

nodeRef - The NodeRef of the record / record folder which will be removed from the given hold

See Also:

HoldService.removeFromHold(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)

removeFromHold

public void removeFromHold(org.alfresco.service.cmr.repository.NodeRef hold,
                           List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Description copied from interface: HoldService

Removes the given items from the given hold

Specified by:

removeFromHold in interface HoldService

Parameters:

hold - The hold NodeRef from which the given items will be removed

nodeRefs - The list of items which will be removed from the given holds

See Also:

HoldService.removeFromHold(org.alfresco.service.cmr.repository.NodeRef, java.util.List)

removeFromHolds

public void removeFromHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds,
                            org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: HoldService

Removes the item from the given list of hold

Specified by:

removeFromHolds in interface HoldService

Parameters:

holds - The list NodeRefs of the holds

nodeRef - The NodeRef of the record / record folder which will be removed from the given holds

See Also:

HoldService.removeFromHolds(java.util.List, org.alfresco.service.cmr.repository.NodeRef)

removeFromHolds

public void removeFromHolds(List<org.alfresco.service.cmr.repository.NodeRef> holds,
                            List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Description copied from interface: HoldService

Removes the items from the given holds

Specified by:

removeFromHolds in interface HoldService

Parameters:

holds - List of hold NodeRefs from which the items will be removed

nodeRefs - List of item NodeRefs which will be removed from the given holds

See Also:

HoldService.removeFromHolds(java.util.List, java.util.List)

removeFromAllHolds

public void removeFromAllHolds(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: HoldService

Removes the given NodeRef from all the holds

Specified by:

removeFromAllHolds in interface HoldService

Parameters:

nodeRef - The NodeRef of item which will be removed from all the holds

See Also:

HoldService.removeFromAllHolds(org.alfresco.service.cmr.repository.NodeRef)

removeFromAllHolds

public void removeFromAllHolds(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs)

Description copied from interface: HoldService

Removes the given list of NodeRefs from all the holds

Specified by:

removeFromAllHolds in interface HoldService

Parameters:

nodeRefs - The list of item NodeRefs which will be removed from all the holds

See Also:

HoldService.removeFromAllHolds(java.util.List)