org.openmrs.reporting.impl

Class ReportObjectServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.reporting.impl.ReportObjectServiceImpl

All Implemented Interfaces:

OpenmrsService, ReportObjectService

Deprecated.

see reportingcompatibility module

@Deprecated
public class ReportObjectServiceImpl
extends BaseOpenmrsService
implements ReportObjectService

Constructor Summary

Constructors

Constructor and Description
ReportObjectServiceImpl() Deprecated. Default constructor

Method Summary

Modifier and Type	Method and Description
Integer	createReportObject(AbstractReportObject reportObject) Deprecated.
void	createSearchHistory(CohortSearchHistory history) Deprecated.
void	deleteReport(AbstractReportObject reportObject) Deprecated.
void	deleteSearchHistory(CohortSearchHistory history) Deprecated.
List<PatientFilter>	getAllPatientFilters() Deprecated. Auto generated method comment
List<PatientSearch>	getAllPatientSearches() Deprecated. Get all patient searches in the database
List<String>	getAllReportObjectClasses() Deprecated. Auto generated method comment
List<AbstractReportObject>	getAllReportObjects() Deprecated. Get all report objects stored in the system
List<CohortSearchHistory>	getAllSearchHistories() Deprecated. Get all search histories stored in the database
String	getDefaultReportObjectValidator() Deprecated. Auto generated method comment
PatientFilter	getPatientFilterById(Integer filterId) Deprecated. Auto generated method comment
PatientFilter	getPatientFilterByName(String filterName) Deprecated. Auto generated method comment
PatientSearch	getPatientSearch(Integer searchId) Deprecated. Get patient search object by internal id or null if none found
PatientSearch	getPatientSearch(String name) Deprecated. Get a patient search matching the name exactly or null if none found
AbstractReportObject	getReportObject(Integer reportObjectId) Deprecated. Get the report object by internal id
String	getReportObjectClassBySubType(String subType) Deprecated.
List<AbstractReportObject>	getReportObjectsByType(String reportObjectType) Deprecated. Get report objects by type that was stored.
List<String>	getReportObjectSubTypes(String type) Deprecated. Get the current list of different sub types stored in the system
List<String>	getReportObjectTypes() Deprecated. Get the current list of different reportObjectTypes stored in the system
String	getReportObjectValidatorByClass(String currentClassName) Deprecated. Auto generated method comment
List<CohortSearchHistory>	getSearchHistories() Deprecated.
CohortSearchHistory	getSearchHistory(Integer reportObjectId) Deprecated. Get a CohortSearchHistory by internal id or null if none found
boolean	isSubTypeOfType(String type, String subType) Deprecated. Auto generated method comment
void	purgeReportObject(AbstractReportObject reportObject) Deprecated. Completely delete the given reportObject from the database
void	purgeSearchHistory(CohortSearchHistory history) Deprecated. Completely delete this method from the database
AbstractReportObject	saveReportObject(AbstractReportObject reportObject) Deprecated. Save the given report object to the database
CohortSearchHistory	saveSearchHistory(CohortSearchHistory history) Deprecated. TODO: why is this method in this service?
void	setReportObjectDAO(ReportObjectDAO dao) Deprecated. Used by spring to set the data access class to use
void	updateReportObject(AbstractReportObject reportObject) Deprecated.

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

ReportObjectServiceImpl

public ReportObjectServiceImpl()

Deprecated.

Default constructor

Method Detail

setReportObjectDAO

public void setReportObjectDAO(ReportObjectDAO dao)

Deprecated.

Description copied from interface: ReportObjectService

Used by spring to set the data access class to use

Specified by:

setReportObjectDAO in interface ReportObjectService

See Also:

ReportObjectService.setReportObjectDAO(org.openmrs.reporting.db.ReportObjectDAO)

getAllReportObjects

public List<AbstractReportObject> getAllReportObjects()

Deprecated.

Description copied from interface: ReportObjectService

Get all report objects stored in the system

Specified by:

getAllReportObjects in interface ReportObjectService

Returns:

List of all report objects stored in the system

See Also:

ReportObjectService.getAllReportObjects()

getReportObject

public AbstractReportObject getReportObject(Integer reportObjectId)
                                     throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Get the report object by internal id

Specified by:

getReportObject in interface ReportObjectService

Returns:

AbstractReportObject by internal id

Throws:

APIException

See Also:

ReportObjectService.getReportObject(java.lang.Integer)

getReportObjectsByType

public List<AbstractReportObject> getReportObjectsByType(String reportObjectType)
                                                  throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Get report objects by type that was stored. Report objects are basically just xml blobs, so this parameter lets you specify which type of blob to get Current possibilities are "Search History", Patient Search, Data Export, etc

Specified by:

getReportObjectsByType in interface ReportObjectService

Parameters:

reportObjectType - String representing the type of the object

Returns:

List of a specific type

Throws:

APIException

See Also:

ReportObjectService.getReportObjectsByType(java.lang.String)

getPatientSearch

public PatientSearch getPatientSearch(Integer searchId)
                               throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Get patient search object by internal id or null if none found

Specified by:

getPatientSearch in interface ReportObjectService

Returns:

PatientSearch by internal id. null if not found

Throws:

APIException

See Also:

ReportObjectService.getPatientSearch(java.lang.Integer)

getAllPatientSearches

public List<PatientSearch> getAllPatientSearches()
                                          throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Get all patient searches in the database

Specified by:

getAllPatientSearches in interface ReportObjectService

Returns:

List of all patient searches on the database

Throws:

APIException

See Also:

ReportObjectService.getAllPatientSearches()

getPatientSearch

public PatientSearch getPatientSearch(String name)
                               throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Get a patient search matching the name exactly or null if none found

Specified by:

getPatientSearch in interface ReportObjectService

Returns:

PatientSearch by name. null if not found

Throws:

APIException

See Also:

ReportObjectService.getPatientSearch(java.lang.String)

getPatientFilterById

public PatientFilter getPatientFilterById(Integer filterId)
                                   throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getPatientFilterById in interface ReportObjectService

Returns:

PatientFilter by filter ID

Throws:

APIException

See Also:

ReportObjectService.getPatientFilterById(java.lang.Integer)

getPatientFilterByName

public PatientFilter getPatientFilterByName(String filterName)
                                     throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getPatientFilterByName in interface ReportObjectService

Returns:

PatientFilter by filter name

Throws:

APIException

See Also:

ReportObjectService.getPatientFilterByName(java.lang.String)

getAllPatientFilters

public List<PatientFilter> getAllPatientFilters()
                                         throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getAllPatientFilters in interface ReportObjectService

Returns:

List of all Patient Filters

Throws:

APIException

See Also:

ReportObjectService.getAllPatientFilters()

createReportObject

public Integer createReportObject(AbstractReportObject reportObject)
                           throws APIException

Deprecated.

Specified by:

createReportObject in interface ReportObjectService

Throws:

APIException

See Also:

ReportObjectService.createReportObject(org.openmrs.reporting.AbstractReportObject)

saveReportObject

public AbstractReportObject saveReportObject(AbstractReportObject reportObject)
                                      throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Save the given report object to the database

Specified by:

saveReportObject in interface ReportObjectService

Returns:

AbstractReportObject that was saved

Throws:

APIException

See Also:

ReportObjectService.saveReportObject(org.openmrs.reporting.AbstractReportObject)

deleteReport

public void deleteReport(AbstractReportObject reportObject)
                  throws APIException

Deprecated.

Specified by:

deleteReport in interface ReportObjectService

Throws:

APIException

See Also:

ReportObjectService.deleteReport(org.openmrs.reporting.AbstractReportObject)

purgeReportObject

public void purgeReportObject(AbstractReportObject reportObject)
                       throws APIException

Deprecated.

Description copied from interface: ReportObjectService

Completely delete the given reportObject from the database

Specified by:

purgeReportObject in interface ReportObjectService

Throws:

APIException

See Also:

ReportObjectService.purgeReportObject(org.openmrs.reporting.AbstractReportObject)

updateReportObject

public void updateReportObject(AbstractReportObject reportObject)
                        throws APIException

Deprecated.

Specified by:

updateReportObject in interface ReportObjectService

Throws:

APIException

See Also:

ReportObjectService.updateReportObject(org.openmrs.reporting.AbstractReportObject)

getReportObjectTypes

public List<String> getReportObjectTypes()

Deprecated.

Description copied from interface: ReportObjectService

Get the current list of different reportObjectTypes stored in the system

Specified by:

getReportObjectTypes in interface ReportObjectService

Returns:

List of different reportObjectTypes stored in the system

See Also:

ReportObjectService.getReportObjectTypes()

getReportObjectSubTypes

public List<String> getReportObjectSubTypes(String type)

Deprecated.

Description copied from interface: ReportObjectService

Get the current list of different sub types stored in the system

Specified by:

getReportObjectSubTypes in interface ReportObjectService

Returns:

String of different sub types stored in the system

See Also:

ReportObjectService.getReportObjectSubTypes(java.lang.String)

isSubTypeOfType

public boolean isSubTypeOfType(String type,
                               String subType)

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

isSubTypeOfType in interface ReportObjectService

Returns:

true if the subType is from a particular type

See Also:

ReportObjectService.isSubTypeOfType(java.lang.String, java.lang.String)

getReportObjectClassBySubType

public String getReportObjectClassBySubType(String subType)

Deprecated.

Specified by:

getReportObjectClassBySubType in interface ReportObjectService

See Also:

ReportObjectService.getReportObjectClassBySubType(java.lang.String)

getAllReportObjectClasses

public List<String> getAllReportObjectClasses()

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getAllReportObjectClasses in interface ReportObjectService

Returns:

List of all ReportObjectClasses

See Also:

ReportObjectService.getAllReportObjectClasses()

getReportObjectValidatorByClass

public String getReportObjectValidatorByClass(String currentClassName)

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getReportObjectValidatorByClass in interface ReportObjectService

Returns:

String of Reported Object Validator by the currentClassName

See Also:

ReportObjectService.getReportObjectValidatorByClass(java.lang.String)

getDefaultReportObjectValidator

public String getDefaultReportObjectValidator()

Deprecated.

Description copied from interface: ReportObjectService

Auto generated method comment

Specified by:

getDefaultReportObjectValidator in interface ReportObjectService

Returns:

String with the default Report Object Validator

See Also:

ReportObjectService.getDefaultReportObjectValidator()

createSearchHistory

public void createSearchHistory(CohortSearchHistory history)

Deprecated.

Specified by:

createSearchHistory in interface ReportObjectService

See Also:

ReportObjectService.createSearchHistory(org.openmrs.cohort.CohortSearchHistory)

saveSearchHistory

public CohortSearchHistory saveSearchHistory(CohortSearchHistory history)

Deprecated.

Description copied from interface: ReportObjectService

TODO: why is this method in this service?

Specified by:

saveSearchHistory in interface ReportObjectService

Returns:

CohortSearchHistory of the saved Search History of a Cohort

See Also:

ReportObjectService.saveSearchHistory(org.openmrs.cohort.CohortSearchHistory)

deleteSearchHistory

public void deleteSearchHistory(CohortSearchHistory history)

Deprecated.

Specified by:

deleteSearchHistory in interface ReportObjectService

See Also:

ReportObjectService.deleteSearchHistory(org.openmrs.cohort.CohortSearchHistory)

purgeSearchHistory

public void purgeSearchHistory(CohortSearchHistory history)

Deprecated.

Description copied from interface: ReportObjectService

Completely delete this method from the database

Specified by:

purgeSearchHistory in interface ReportObjectService

See Also:

ReportObjectService.purgeSearchHistory(org.openmrs.cohort.CohortSearchHistory)

getSearchHistory

public CohortSearchHistory getSearchHistory(Integer reportObjectId)

Deprecated.

Description copied from interface: ReportObjectService

Get a CohortSearchHistory by internal id or null if none found

Specified by:

getSearchHistory in interface ReportObjectService

Returns:

CohortSearchHistory by internal id. null if not found

See Also:

ReportObjectService.getSearchHistory(java.lang.Integer)

getSearchHistories

public List<CohortSearchHistory> getSearchHistories()

Deprecated.

Specified by:

getSearchHistories in interface ReportObjectService

See Also:

ReportObjectService.getSearchHistories()

getAllSearchHistories

public List<CohortSearchHistory> getAllSearchHistories()

Deprecated.

Description copied from interface: ReportObjectService

Get all search histories stored in the database

Specified by:

getAllSearchHistories in interface ReportObjectService

Returns:

List of all search histories stored in the database

See Also:

ReportObjectService.getAllSearchHistories()