Package org.alfresco.module.org_alfresco_module_rm.recordfolder

Class RecordFolderServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.recordfolder.RecordFolderServiceImpl

All Implemented Interfaces:

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

public class RecordFolderServiceImpl
extends ServiceBaseImpl
implements RecordFolderService, RecordsManagementModel

Record Folder Service Implementation

Since:

2.1

Author:

Roy Wetherall

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

Method Summary

Modifier and Type	Method	Description
void	closeRecordFolder(NodeRef nodeRef)	Closes the record folder.
NodeRef	createRecordFolder(NodeRef rmContainer, String name)	Create a record folder in the rm container.
NodeRef	createRecordFolder(NodeRef rmContainer, String name, Map<QName,Serializable> properties)	Create a record folder in the rm container.
NodeRef	createRecordFolder(NodeRef rmContainer, String name, QName type)	Create a record folder in the rm container.
NodeRef	createRecordFolder(NodeRef rmContainer, String name, QName type, Map<QName,Serializable> properties)	Create a record folder in the rm container.
List<NodeRef>	getRecordFolders(NodeRef record)	Get all the record folders that a record is filed into.
boolean	isRecordFolderClosed(NodeRef nodeRef)	Indicates whether a record folder is closed or not.
boolean	isRecordFolderDeclared(NodeRef nodeRef)	Indicates whether the contents of a record folder are all declared.
void	setDispositionService(DispositionService dispositionService)
void	setFilePlanService(FilePlanService filePlanService)
void	setRecordService(RecordService recordService)
void	setupRecordFolder(NodeRef nodeRef)	Sets up the a record folder from a standard folder.

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.recordfolder.RecordFolderService

isRecordFolder

Constructor Details

RecordFolderServiceImpl

public RecordFolderServiceImpl()

Method Details

setDispositionService

public void setDispositionService(DispositionService dispositionService)

Parameters:

dispositionService - disposition service

setRecordService

public void setRecordService(RecordService recordService)

Parameters:

recordService - record service

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

Parameters:

filePlanService - file plan service

setupRecordFolder

public void setupRecordFolder(NodeRef nodeRef)

Description copied from interface: RecordFolderService

Sets up the a record folder from a standard folder.

Specified by:

setupRecordFolder in interface RecordFolderService

Parameters:

nodeRef - node reference of the folder to setup

See Also:

• RecordFolderService.setupRecordFolder(org.alfresco.service.cmr.repository.NodeRef)

isRecordFolderDeclared

public boolean isRecordFolderDeclared(NodeRef nodeRef)

Description copied from interface: RecordFolderService

Indicates whether the contents of a record folder are all declared.

Specified by:

isRecordFolderDeclared in interface RecordFolderService

Parameters:

nodeRef - node reference (record folder)

Returns:

boolean true if record folder contents are declared, false otherwise

See Also:

• RecordFolderService.isRecordFolderDeclared(NodeRef)

isRecordFolderClosed

public boolean isRecordFolderClosed(NodeRef nodeRef)

Description copied from interface: RecordFolderService

Indicates whether a record folder is closed or not.

Specified by:

isRecordFolderClosed in interface RecordFolderService

Parameters:

nodeRef - node reference (record folder)

Returns:

boolean true if record folder is closed, false otherwise

See Also:

• RecordFolderService.isRecordFolderClosed(NodeRef)

createRecordFolder

public NodeRef createRecordFolder(NodeRef rmContainer,
 String name,
 QName type)

Description copied from interface: RecordFolderService

Create a record folder in the rm container. The record folder will take the name and type provided.

Specified by:

createRecordFolder in interface RecordFolderService

Parameters:

rmContainer - records management container

name - name

type - type

Returns:

NodeRef node reference of record folder

createRecordFolder

public NodeRef createRecordFolder(NodeRef rmContainer,
 String name,
 QName type,
 Map<QName,Serializable> properties)

Description copied from interface: RecordFolderService

Create a record folder in the rm container. The record folder will take the name, type and properties provided.

Specified by:

createRecordFolder in interface RecordFolderService

Parameters:

rmContainer - records management container

name - name

type - type

properties - properties

Returns:

NodeRef node reference of record folder

See Also:

• RecordFolderService.createRecordFolder(NodeRef, String, QName, Map)

createRecordFolder

public NodeRef createRecordFolder(NodeRef rmContainer,
 String name)

Description copied from interface: RecordFolderService

Create a record folder in the rm container. The record folder will take the name provided. Type defaults to rm:recordFolder.

Specified by:

createRecordFolder in interface RecordFolderService

Parameters:

rmContainer - records management container

name - name

Returns:

NodeRef node reference of record folder

See Also:

• RecordFolderService.createRecordFolder(NodeRef, String)

createRecordFolder

public NodeRef createRecordFolder(NodeRef rmContainer,
 String name,
 Map<QName,Serializable> properties)

Description copied from interface: RecordFolderService

Create a record folder in the rm container. The record folder will take the name and properties provided. Type defaults to rm:recordFolder.

Specified by:

createRecordFolder in interface RecordFolderService

Parameters:

rmContainer - records management container

name - name

properties - properties

Returns:

NodeRef node reference of record folder

See Also:

• RecordFolderService.createRecordFolder(NodeRef, String, Map)

getRecordFolders

public List<NodeRef> getRecordFolders(NodeRef record)

Description copied from interface: RecordFolderService

Get all the record folders that a record is filed into.

Specified by:

getRecordFolders in interface RecordFolderService

Parameters:

record - the record node reference

Returns:

List list of folder record node references

See Also:

• RecordFolderService.getRecordFolders(org.alfresco.service.cmr.repository.NodeRef)

closeRecordFolder

public void closeRecordFolder(NodeRef nodeRef)

Description copied from interface: RecordFolderService

Closes the record folder. If the given node reference is a record the parent will be retrieved and processed.

Specified by:

closeRecordFolder in interface RecordFolderService

Parameters:

nodeRef - the record folder node reference

See Also:

• RecordFolderService.closeRecordFolder(NodeRef)