org.alfresco.module.org_alfresco_module_rm.report

Class ReportServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl

org.alfresco.module.org_alfresco_module_rm.report.ReportServiceImpl

All Implemented Interfaces:

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

public class ReportServiceImpl
extends ServiceBaseImpl
implements ReportService

Report service implementation.

Since:

2.1

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
protected RecordService	recordService record service

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.module.org_alfresco_module_rm.model.RecordsManagementModel

ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, 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_NOTIFICATION_ISSUED, 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
ReportServiceImpl()

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	fileReport(org.alfresco.service.cmr.repository.NodeRef nodeRef, Report report) File report in the given destination.
Report	generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef) Generate a report of the given type and reported upon node reference.
Report	generateReport(org.alfresco.service.namespace.QName reportType, org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef, String mimetype) Generate a report for a specified mimetype.
Set<org.alfresco.service.namespace.QName>	getReportTypes() Get a list of the available report types.
void	registerReportGenerator(ReportGenerator reportGenerator) Register a report generator with the report service.
void	setRecordService(RecordService recordService)

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

Methods inherited from class java.lang.Object

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

Field Detail

recordService

protected RecordService recordService

record service

Constructor Detail

ReportServiceImpl

public ReportServiceImpl()

Method Detail

setRecordService

public void setRecordService(RecordService recordService)

Parameters:

recordService - record service

registerReportGenerator

public void registerReportGenerator(ReportGenerator reportGenerator)

Description copied from interface: ReportService

Register a report generator with the report service.

Specified by:

registerReportGenerator in interface ReportService

Parameters:

reportGenerator - report generator

See Also:

ReportService.registerReportGenerator(org.alfresco.module.org_alfresco_module_rm.report.ReportGenerator)

getReportTypes

public Set<org.alfresco.service.namespace.QName> getReportTypes()

Description copied from interface: ReportService

Get a list of the available report types.

Specified by:

getReportTypes in interface ReportService

Returns:

Set<QName> list of the available report types

See Also:

ReportService.getReportTypes()

generateReport

public Report generateReport(org.alfresco.service.namespace.QName reportType,
                             org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef)

Description copied from interface: ReportService

Generate a report of the given type and reported upon node reference.

Specified by:

generateReport in interface ReportService

Parameters:

reportType - report type

reportedUponNodeRef - reported upon node reference

Returns:

Report generated report

See Also:

ReportService.generateReport(QName, NodeRef)

generateReport

public Report generateReport(org.alfresco.service.namespace.QName reportType,
                             org.alfresco.service.cmr.repository.NodeRef reportedUponNodeRef,
                             String mimetype)

Description copied from interface: ReportService

Generate a report for a specified mimetype.

Specified by:

generateReport in interface ReportService

Parameters:

reportType - report type

reportedUponNodeRef - report upon node reference

mimetype - report mimetype

Returns:

Report generated report

See Also:

ReportService.generateReport(QName, NodeRef, String)

fileReport

public org.alfresco.service.cmr.repository.NodeRef fileReport(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                              Report report)

Description copied from interface: ReportService

File report in the given destination. If the given node reference is a file plan node reference the report will be filed in the unfiled records container.

Specified by:

fileReport in interface ReportService

Parameters:

nodeRef - node reference

report - report

Returns:

NodeRef node reference of the filed report

See Also:

org.alfresco.module.org_alfresco_module_rm.report.ReportService#fileReport(org.alfresco.module.org_alfresco_module_rm.report.Report)