Package org.alfresco.module.org_alfresco_module_rm.freeze

Class FreezeServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.freeze.FreezeServiceImpl

All Implemented Interfaces:

FreezeService, RecordsManagementCustomModel, RecordsManagementModel, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class FreezeServiceImpl
extends ServiceBaseImpl
implements FreezeService, RecordsManagementModel

Freeze Service Implementation

Since:

2.1

Author:

Roy Wetherall, Tuna Aksoy

Field Summary

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.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
FreezeServiceImpl()

Method Summary

Modifier and Type	Method	Description
NodeRef	freeze(String reason, Set<NodeRef> nodeRefs)	Deprecated.
NodeRef	freeze(String reason, NodeRef nodeRef)	Deprecated.
void	freeze(NodeRef hold, Set<NodeRef> nodeRefs)	Deprecated.
void	freeze(NodeRef hold, NodeRef nodeRef)	Deprecated.
protected FilePlanService	getFilePlanService()
Date	getFreezeDate(NodeRef nodeRef)	Gets the date of the freeze for the given node, null if the node is not frozen
String	getFreezeInitiator(NodeRef nodeRef)	Gets the initiator of the freeze for the given node, null if the node is not frozen
Set<NodeRef>	getFrozen(NodeRef hold)	Deprecated.
Set<NodeRef>	getHolds(NodeRef filePlan)
protected HoldService	getHoldService()
String	getReason(NodeRef hold)	Deprecated.
boolean	hasFrozenChildren(NodeRef nodeRef)	Checks whether or not the given node has frozen children
boolean	isFrozen(NodeRef nodeRef)	Indicates whether the passed node reference is frozen.
boolean	isFrozenOrHasFrozenChildren(NodeRef nodeRef)	Helper method to determine if a node is frozen or has frozen children
void	relinquish(NodeRef hold)	Deprecated.
void	setFilePlanService(FilePlanService filePlanService)
void	setHoldService(HoldService holdService)
void	setRecordFolderService(RecordFolderService recordFolderService)
void	setRecordService(RecordService recordService)
void	unFreeze(Set<NodeRef> nodeRefs)	Deprecated.
void	unFreeze(NodeRef nodeRef)	Deprecated.
void	updateReason(NodeRef hold, String reason)	Deprecated.

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

Methods inherited from interface org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService

isHold

Constructor Details

FreezeServiceImpl

public FreezeServiceImpl()

Method Details

setRecordFolderService

public void setRecordFolderService(RecordFolderService recordFolderService)

Parameters:

recordFolderService - record folder service

setRecordService

public void setRecordService(RecordService recordService)

Parameters:

recordService - record service

getFilePlanService

protected FilePlanService getFilePlanService()

Returns:

File plan service

getHoldService

protected HoldService getHoldService()

Returns:

Hold service

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

Parameters:

filePlanService - file plan service

setHoldService

public void setHoldService(HoldService holdService)

Parameters:

holdService - hold service

isFrozen

public boolean isFrozen(NodeRef nodeRef)

Description copied from interface: FreezeService

Indicates whether the passed node reference is frozen.

Specified by:

isFrozen in interface FreezeService

Parameters:

nodeRef - node reference

Returns:

boolean true if frozen, false otherwise

See Also:

• FreezeService.isFrozen(org.alfresco.service.cmr.repository.NodeRef)

getFrozen

@Deprecated
public Set<NodeRef> getFrozen(NodeRef hold)

Deprecated.

Specified by:

getFrozen in interface FreezeService

See Also:

• FreezeService.getFrozen(org.alfresco.service.cmr.repository.NodeRef)

freeze

@Deprecated
public NodeRef freeze(String reason,
 NodeRef nodeRef)

Deprecated.

Specified by:

freeze in interface FreezeService

See Also:

• FreezeService.freeze(java.lang.String, org.alfresco.service.cmr.repository.NodeRef)

freeze

@Deprecated
public void freeze(NodeRef hold,
 NodeRef nodeRef)

Deprecated.

Specified by:

freeze in interface FreezeService

See Also:

• FreezeService.freeze(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)

freeze

@Deprecated
public NodeRef freeze(String reason,
 Set<NodeRef> nodeRefs)

Deprecated.

Specified by:

freeze in interface FreezeService

See Also:

• FreezeService.freeze(java.lang.String, java.util.Set)

freeze

@Deprecated
public void freeze(NodeRef hold,
 Set<NodeRef> nodeRefs)

Deprecated.

Specified by:

freeze in interface FreezeService

See Also:

• FreezeService.freeze(org.alfresco.service.cmr.repository.NodeRef, java.util.Set)

unFreeze

@Deprecated
public void unFreeze(NodeRef nodeRef)

Deprecated.

Specified by:

unFreeze in interface FreezeService

See Also:

• FreezeService.unFreeze(org.alfresco.service.cmr.repository.NodeRef)

unFreeze

@Deprecated
public void unFreeze(Set<NodeRef> nodeRefs)

Deprecated.

Specified by:

unFreeze in interface FreezeService

See Also:

• FreezeService.unFreeze(java.util.Set)

relinquish

@Deprecated
public void relinquish(NodeRef hold)

Deprecated.

Specified by:

relinquish in interface FreezeService

See Also:

• FreezeService.relinquish(org.alfresco.service.cmr.repository.NodeRef)

getReason

@Deprecated
public String getReason(NodeRef hold)

Deprecated.

Specified by:

getReason in interface FreezeService

See Also:

• FreezeService.getReason(org.alfresco.service.cmr.repository.NodeRef)

updateReason

@Deprecated
public void updateReason(NodeRef hold,
 String reason)

Deprecated.

Specified by:

updateReason in interface FreezeService

See Also:

• FreezeService.updateReason(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

getHolds

public Set<NodeRef> getHolds(NodeRef filePlan)

Specified by:

getHolds in interface FreezeService

See Also:

• HoldService.getHolds(NodeRef)

hasFrozenChildren

public boolean hasFrozenChildren(NodeRef nodeRef)

Description copied from interface: FreezeService

Checks whether or not the given node has frozen children

Specified by:

hasFrozenChildren in interface FreezeService

Parameters:

nodeRef - The nodeRef for which will be checked if it has frozen children

Returns:

true if the given nodeRef has frozen children, false otherwise

See Also:

• FreezeService.hasFrozenChildren(org.alfresco.service.cmr.repository.NodeRef)

getFreezeDate

public Date getFreezeDate(NodeRef nodeRef)

Description copied from interface: FreezeService

Gets the date of the freeze for the given node, null if the node is not frozen

Specified by:

getFreezeDate in interface FreezeService

Parameters:

nodeRef - The nodeRef for which the date check will be performed

Returns:

Date The of the freeze or null

See Also:

• FreezeService.getFreezeDate(org.alfresco.service.cmr.repository.NodeRef)

getFreezeInitiator

public String getFreezeInitiator(NodeRef nodeRef)

Description copied from interface: FreezeService

Gets the initiator of the freeze for the given node, null if the node is not frozen

Specified by:

getFreezeInitiator in interface FreezeService

Parameters:

nodeRef - The nodeRef for which the initiator check will be performed

Returns:

String The initiator of the freeze or null

See Also:

• FreezeService.getFreezeInitiator(org.alfresco.service.cmr.repository.NodeRef)

isFrozenOrHasFrozenChildren

public boolean isFrozenOrHasFrozenChildren(NodeRef nodeRef)

Helper method to determine if a node is frozen or has frozen children

Specified by:

isFrozenOrHasFrozenChildren in interface FreezeService

Parameters:

nodeRef - Node to be checked

Returns:

true if the node is frozen or has frozen children, false otherwise