Package org.alfresco.module.org_alfresco_module_rm.dataset

Class DataSetServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.dataset.DataSetServiceImpl

All Implemented Interfaces:

DataSetService, RecordsManagementCustomModel, RecordsManagementModel

public class DataSetServiceImpl
extends Object
implements DataSetService, RecordsManagementModel

Field Summary

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_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
DataSetServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	existsDataSet(String dataSetId)	Checks if a data set exists with the given data set id
Map<String,DataSet>	getDataSets()	Gets the details of all available data sets.
Map<String,DataSet>	getDataSets(NodeRef filePlan, boolean excludeLoaded)	Gets the details of all available data sets for a file plan depending on the parameter "excludeLoaded".
Map<String,DataSet>	getLoadedDataSets(NodeRef filePlan)	Gets the details of all loaded data sets for a specified file plan
boolean	isLoadedDataSet(NodeRef filePlan, String dataSetId)	Checks if a data set with the id "dataSetId" has been loaded into the specified file plan
void	loadDataSet(NodeRef filePlan, String dataSetId)	Loads the data set with the specified id into the specified file plan
void	register(DataSet dataSet)	Register a data set implementation with the service
void	setAuthorityService(AuthorityService authorityService)	Set authority service
void	setDispositionService(DispositionService dispositionService)	Set disposition service
void	setFilePlanRoleService(FilePlanRoleService filePlanRoleService)
void	setFilePlanService(FilePlanService filePlanService)	Set file plan service
void	setImporterService(ImporterService importerService)	Set importer service
void	setNodeService(NodeService nodeService)	Set node service
void	setPermissionService(PermissionService permissionService)	Set permission service
void	setRecordFolderService(RecordFolderService recordFolderService)	Set record folder service
void	setRecordsManagementSearchBehaviour(RecordsManagementSearchBehaviour recordsManagementSearchBehaviour)	Set records management search behaviour
void	setSearchService(SearchService searchService)	Set search service

Methods inherited from class java.lang.Object

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

Constructor Details

DataSetServiceImpl

public DataSetServiceImpl()

Method Details

setImporterService

public void setImporterService(ImporterService importerService)

Set importer service

Parameters:

importerService - the importer service

setSearchService

public void setSearchService(SearchService searchService)

Set search service

Parameters:

searchService - the search service

setNodeService

public void setNodeService(NodeService nodeService)

Set node service

Parameters:

nodeService - the node service

setFilePlanService

public void setFilePlanService(FilePlanService filePlanService)

Set file plan service

Parameters:

filePlanService - the file plan service

setPermissionService

public void setPermissionService(PermissionService permissionService)

Set permission service

Parameters:

permissionService - the permission service

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Set authority service

Parameters:

authorityService - the authority service

setFilePlanRoleService

public void setFilePlanRoleService(FilePlanRoleService filePlanRoleService)

Parameters:

filePlanRoleService - file plan role service

setRecordsManagementSearchBehaviour

public void setRecordsManagementSearchBehaviour(RecordsManagementSearchBehaviour recordsManagementSearchBehaviour)

Set records management search behaviour

Parameters:

recordsManagementSearchBehaviour - the records management search behaviour

setDispositionService

public void setDispositionService(DispositionService dispositionService)

Set disposition service

Parameters:

dispositionService - the disposition service

setRecordFolderService

public void setRecordFolderService(RecordFolderService recordFolderService)

Set record folder service

Parameters:

recordFolderService - the record folder service

register

public void register(DataSet dataSet)

Description copied from interface: DataSetService

Register a data set implementation with the service

Specified by:

register in interface DataSetService

Parameters:

dataSet - the data set

See Also:

• DataSetService.register(org.alfresco.module.org_alfresco_module_rm.dataset.DataSet)

getDataSets

public Map<String,DataSet> getDataSets()

Description copied from interface: DataSetService

Gets the details of all available data sets.

Specified by:

getDataSets in interface DataSetService

Returns:

the Map<String, DataSet> with details of all available data sets

See Also:

• DataSetService.getDataSets()

getDataSets

public Map<String,DataSet> getDataSets(NodeRef filePlan,
 boolean excludeLoaded)

Description copied from interface: DataSetService

Gets the details of all available data sets for a file plan depending on the parameter "excludeLoaded".

Specified by:

getDataSets in interface DataSetService

Parameters:

filePlan - the file plan for which the details should be retrieved

excludeLoaded - if true only data sets will be retrieved which has not been loaded

Returns:

Map<String, DataSet> with details of the available data sets for a specified file plan depending on the parameter "excludeLoaded". The result could also be an empty map

See Also:

• DataSetService.getDataSets(NodeRef, boolean)

loadDataSet

public void loadDataSet(NodeRef filePlan,
 String dataSetId)

Description copied from interface: DataSetService

Loads the data set with the specified id into the specified file plan

Specified by:

loadDataSet in interface DataSetService

Parameters:

filePlan - the file plan which the data set will load into

dataSetId - the id of the data set which will be imported

See Also:

• DataSetService.loadDataSet(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)

existsDataSet

public boolean existsDataSet(String dataSetId)

Description copied from interface: DataSetService

Checks if a data set exists with the given data set id

Specified by:

existsDataSet in interface DataSetService

Parameters:

dataSetId - the id of the data set which will be checked

Returns:

true if the data set exists, false otherwise

See Also:

• DataSetService.existsDataSet(java.lang.String)

getLoadedDataSets

public Map<String,DataSet> getLoadedDataSets(NodeRef filePlan)

Description copied from interface: DataSetService

Gets the details of all loaded data sets for a specified file plan

Specified by:

getLoadedDataSets in interface DataSetService

Parameters:

filePlan - the file plan for which the loaded data sets should be retrieved

Returns:

Map<String, DataSet> details of all loaded data sets or an empty map if there has not been any data sets loaded for the specified file plan

See Also:

• DataSetService.getLoadedDataSets(org.alfresco.service.cmr.repository.NodeRef)

isLoadedDataSet

public boolean isLoadedDataSet(NodeRef filePlan,
 String dataSetId)

Description copied from interface: DataSetService

Checks if a data set with the id "dataSetId" has been loaded into the specified file plan

Specified by:

isLoadedDataSet in interface DataSetService

Parameters:

filePlan - the file plan for which the check should be done

dataSetId - the id of the data set which should be checked if it has been loaded to the file plan

Returns:

true if the data set with the specified id has been loaded into the specified file plan, false otherwise

See Also:

• DataSetService.isLoadedDataSet(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)