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,NodeServicePolicies.BeforeDeleteNodePolicy,ClassPolicy,Policy,org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware
public class HoldServiceImpl
extends ServiceBaseImpl
implements HoldService, 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
Policy.Arg -
Field Summary
Fields inherited from class org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl
applicationContext, authenticationUtil, contentService, dictionaryService, nodeService, nodeTypeUtility, renditionService, transactionalResourceHelperFields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy
QNAMEFields 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_URIFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the items to the the given holdvoidAdds the item to the given holdvoidaddToHolds(List<NodeRef> holds, List<NodeRef> nodeRefs) Adds the given items to the given list of holdsvoidaddToHolds(List<NodeRef> holds, NodeRef nodeRef) Adds the item to the given list of holdsvoidbeforeDeleteNode(NodeRef hold) Behaviour unfreezes node's that will no longer he held after delete.createHold(NodeRef filePlan, String name, String reason, String description) Creates a hold with the given name, reason and description for the given file planvoiddeleteHold(NodeRef hold) Deletes the holdGets the list of item node references which are in the given holdGets the node reference for the hold with the given name in the given file plangetHoldReason(NodeRef hold) Gets the hold reason for the given hold node referenceGets the list of all the holds within the holds container in the given file planprotected PolicyComponentGets the policy component instanceGets the list of all the holds within the holds container for the given node referencevoidinit()Initialise hold serviceprotected voidinvokeBeforeAddToHold(NodeRef hold, NodeRef contentNodeRef) Invoke beforeAddToHold policyprotected voidinvokeBeforeCreateHold(NodeRef nodeRef, String name, String reason) Invoke beforeCreateHold policyprotected voidinvokeBeforeDeleteHold(NodeRef nodeRef) Invoke beforeDeleteHold policyprotected voidinvokeBeforeRemoveFromHold(NodeRef hold, NodeRef contentNodeRef) Invoke beforeRemoveFromHold policyprotected voidinvokeOnAddToHold(NodeRef hold, NodeRef contentNodeRef) Invoke onAddToHold policyprotected voidinvokeOnCreateHold(NodeRef nodeRef) Invoke onCreateHold policyprotected voidinvokeOnDeleteHold(String holdName, Set<QName> classQNames) Invoke onDeleteHold policyprotected voidinvokeOnRemoveFromHold(NodeRef hold, NodeRef contentNodeRef) Invoke onRemoveFromHold policyvoidremoveFromAllHolds(List<NodeRef> nodeRefs) Removes the given list ofNodeRefs from all the holdsvoidremoveFromAllHolds(NodeRef nodeRef) Removes the givenNodeReffrom all the holdsvoidremoveFromHold(NodeRef hold, List<NodeRef> nodeRefs) Removes the given items from the given holdvoidremoveFromHold(NodeRef hold, NodeRef nodeRef) Removes the record from the given holdvoidremoveFromHolds(List<NodeRef> holds, List<NodeRef> nodeRefs) Removes the items from the given holdsvoidremoveFromHolds(List<NodeRef> holds, NodeRef nodeRef) Removes the item from the given list of holdvoidsetCapabilityService(CapabilityService capabilityService) voidsetFilePlanService(FilePlanService filePlanService) Set the file plan servicevoidsetHoldDeletionReason(NodeRef hold, String reason) Sets the reason for the hold deletionvoidsetHoldReason(NodeRef hold, String reason) Sets the hold reasonvoidsetPermissionService(PermissionService permissionService) Set the permission servicevoidsetPolicyComponent(PolicyComponent policyComponent) Sets the policy component instancevoidsetRecordFolderService(RecordFolderService recordFolderService) Set the record folder servicevoidsetRecordService(RecordService recordService) Set the record servicevoidupdateHold(NodeRef hold, String name, String reason, String description) Updates a hold with the given name, reason and descriptionMethods 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, setTransactionalResourceHelperMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.alfresco.module.org_alfresco_module_rm.hold.HoldService
isHold
-
Constructor Details
-
HoldServiceImpl
public HoldServiceImpl()
-
-
Method Details
-
setFilePlanService
Set the file plan service- Parameters:
filePlanService- the file plan service
-
setRecordService
Set the record service- Parameters:
recordService- the record service
-
setRecordFolderService
Set the record folder service- Parameters:
recordFolderService- the record folder service
-
setPermissionService
Set the permission service- Parameters:
permissionService- the permission services
-
setCapabilityService
- Parameters:
capabilityService- capability service
-
getPolicyComponent
Gets the policy component instance- Returns:
- The policy component instance
-
setPolicyComponent
Sets the policy component instance- Parameters:
policyComponent- The policy component instance
-
init
public void init()Initialise hold service -
beforeDeleteNode
Behaviour unfreezes node's that will no longer he held after delete. -
getHolds
Description copied from interface:HoldServiceGets the list of all the holds within the holds container in the given file plan- Specified by:
getHoldsin interfaceHoldService- Parameters:
filePlan- TheNodeRefof the file plan- Returns:
- List of hold node references
- See Also:
-
heldBy
Description copied from interface:HoldServiceGets the list of all the holds within the holds container for the given node reference- Specified by:
heldByin interfaceHoldService- Parameters:
nodeRef- TheNodeRefof the record / record folder /active contentincludedInHold-trueto retrieve the list of hold node references which will include the node referencefalseto get a list of node references which will not have the given node reference- Returns:
- List of hold node references
- See Also:
-
getHold
Description copied from interface:HoldServiceGets the node reference for the hold with the given name in the given file plan- Specified by:
getHoldin interfaceHoldServicename-StringThe name of the hold- Returns:
NodeRefof the hold with the given name- See Also:
-
getHeld
Description copied from interface:HoldServiceGets the list of item node references which are in the given hold- Specified by:
getHeldin interfaceHoldService- Parameters:
hold-NodeRefof the hold- Returns:
- Lost of item
NodeRefs which are in the given hold - See Also:
-
createHold
Description copied from interface:HoldServiceCreates a hold with the given name, reason and description for the given file plan- Specified by:
createHoldin interfaceHoldService- Parameters:
filePlan- TheNodeRefof the file planname-StringThe name of the holdreason-StringThe reason of the holddescription-StringThe description of the hold- Returns:
- The
NodeRefof the created hold - See Also:
-
getHoldReason
Description copied from interface:HoldServiceGets the hold reason for the given hold node reference- Specified by:
getHoldReasonin interfaceHoldService- Parameters:
hold- TheNodeRefof the hold- Returns:
StringThe reason of the hold- See Also:
-
setHoldReason
Description copied from interface:HoldServiceSets the hold reason- Specified by:
setHoldReasonin interfaceHoldService- Parameters:
hold- TheNodeRefof the holdreason-StringThe reason for the hold- See Also:
-
setHoldDeletionReason
Description copied from interface:HoldServiceSets the reason for the hold deletion- Specified by:
setHoldDeletionReasonin interfaceHoldService- Parameters:
hold- TheNodeRefof the holdreason-StringThe reason for the hold- See Also:
-
updateHold
Description copied from interface:HoldServiceUpdates a hold with the given name, reason and description- Specified by:
updateHoldin interfaceHoldService- Parameters:
hold- TheNodeRefof the holdname-StringThe name of the holdreason-StringThe reason of the holddescription-StringThe description of the hold- See Also:
-
deleteHold
Description copied from interface:HoldServiceDeletes the hold- Specified by:
deleteHoldin interfaceHoldService- Parameters:
hold- TheNodeRefof the hold- See Also:
-
addToHold
Description copied from interface:HoldServiceAdds the item to the given hold- Specified by:
addToHoldin interfaceHoldService- Parameters:
hold- TheNodeRefof the holdnodeRef- TheNodeRefof the record / record folder / active content which will be added to the given hold- See Also:
-
addToHold
Description copied from interface:HoldServiceAdds the items to the the given hold- Specified by:
addToHoldin interfaceHoldService- Parameters:
hold- TheNodeRefof the hold to which the items will be addednodeRefs- The itemNodeRefs which will be added to the hold- See Also:
-
addToHolds
Description copied from interface:HoldServiceAdds the item to the given list of holds- Specified by:
addToHoldsin interfaceHoldService- Parameters:
holds- The list ofNodeRefs of the holdsnodeRef- TheNodeRefof the record / record folder / active content which will be added to the given holds- See Also:
-
addToHolds
Description copied from interface:HoldServiceAdds the given items to the given list of holds- Specified by:
addToHoldsin interfaceHoldService- Parameters:
holds- List of holds to which the given items will be addednodeRefs- The list of items which will be added to the given holds- See Also:
-
removeFromHold
Description copied from interface:HoldServiceRemoves the record from the given hold- Specified by:
removeFromHoldin interfaceHoldService- Parameters:
hold- TheNodeRefof the holdnodeRef- TheNodeRefof the record / record folder which will be removed from the given hold- See Also:
-
removeFromHold
Description copied from interface:HoldServiceRemoves the given items from the given hold- Specified by:
removeFromHoldin interfaceHoldService- Parameters:
hold- The holdNodeReffrom which the given items will be removednodeRefs- The list of items which will be removed from the given holds- See Also:
-
removeFromHolds
Description copied from interface:HoldServiceRemoves the item from the given list of hold- Specified by:
removeFromHoldsin interfaceHoldService- Parameters:
holds- The listNodeRefs of the holdsnodeRef- TheNodeRefof the record / record folder which will be removed from the given holds- See Also:
-
removeFromHolds
Description copied from interface:HoldServiceRemoves the items from the given holds- Specified by:
removeFromHoldsin interfaceHoldService- Parameters:
holds- List of holdNodeRefs from which the items will be removednodeRefs- List of itemNodeRefs which will be removed from the given holds- See Also:
-
removeFromAllHolds
Description copied from interface:HoldServiceRemoves the givenNodeReffrom all the holds- Specified by:
removeFromAllHoldsin interfaceHoldService- Parameters:
nodeRef- TheNodeRefof item which will be removed from all the holds- See Also:
-
removeFromAllHolds
Description copied from interface:HoldServiceRemoves the given list ofNodeRefs from all the holds- Specified by:
removeFromAllHoldsin interfaceHoldService- Parameters:
nodeRefs- The list of itemNodeRefs which will be removed from all the holds- See Also:
-
invokeBeforeCreateHold
Invoke beforeCreateHold policy- Parameters:
nodeRef- node referencename- hold namereason- hold reason
-
invokeOnCreateHold
Invoke onCreateHold policy- Parameters:
nodeRef- node reference
-
invokeBeforeDeleteHold
Invoke beforeDeleteHold policy- Parameters:
nodeRef- node reference
-
invokeOnDeleteHold
Invoke onDeleteHold policy- Parameters:
holdName- name of the holdclassQNames- hold types and aspects
-
invokeBeforeAddToHold
Invoke beforeAddToHold policy- Parameters:
hold- hold node referencecontentNodeRef- content node reference
-
invokeOnAddToHold
Invoke onAddToHold policy- Parameters:
hold- hold node referencecontentNodeRef- content node reference
-
invokeBeforeRemoveFromHold
Invoke beforeRemoveFromHold policy- Parameters:
hold- hold node referencecontentNodeRef- content node reference
-
invokeOnRemoveFromHold
Invoke onRemoveFromHold policy- Parameters:
hold- hold node referencecontentNodeRef- content node reference
-