org.openmrs.reporting

Interface ReportObjectService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ReportObjectServiceImpl

Deprecated.

see reportingcompatibility module

@Deprecated
public interface ReportObjectService
extends OpenmrsService

Method Summary

Methods

Modifier and Type	Method and Description
Integer	createReportObject(AbstractReportObject reportObject) Deprecated. use saveReportObject(AbstractReportObject)
void	createSearchHistory(CohortSearchHistory history) Deprecated. use saveSearchHistory(CohortSearchHistory)
void	deleteReport(AbstractReportObject reportObject) Deprecated. use purgeReportObject(AbstractReportObject)
void	deleteSearchHistory(CohortSearchHistory history) Deprecated. use purgeSearchHistory(CohortSearchHistory)
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. use getAllSearchHistories()
CohortSearchHistory	getSearchHistory(Integer id) 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. use saveReportObject(AbstractReportObject)

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setReportObjectDAO

void setReportObjectDAO(ReportObjectDAO dao)

Deprecated.

Used by spring to set the data access class to use

Parameters:

dao -

getAllReportObjects

List<AbstractReportObject> getAllReportObjects()
                                               throws APIException

Deprecated.

Get all report objects stored in the system

Returns:

List of all report objects stored in the system

Throws:

APIException

getReportObject

AbstractReportObject getReportObject(Integer reportObjectId)
                                     throws APIException

Deprecated.

Get the report object by internal id

Parameters:

reportObjectId -

Returns:

AbstractReportObject by internal id

Throws:

APIException

getReportObjectsByType

List<AbstractReportObject> getReportObjectsByType(String reportObjectType)
                                                  throws APIException

Deprecated.

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

Parameters:

reportObjectType - String representing the type of the object

Returns:

List of a specific type

Throws:

APIException

getPatientFilterById

PatientFilter getPatientFilterById(Integer filterId)
                                   throws APIException

Deprecated.

Auto generated method comment

Parameters:

filterId -

Returns:

PatientFilter by filter ID

Throws:

APIException

getPatientFilterByName

PatientFilter getPatientFilterByName(String filterName)
                                     throws APIException

Deprecated.

Auto generated method comment

Parameters:

filterName -

Returns:

PatientFilter by filter name

Throws:

APIException

getAllPatientFilters

List<PatientFilter> getAllPatientFilters()
                                         throws APIException

Deprecated.

Auto generated method comment

Returns:

List of all Patient Filters

Throws:

APIException

createReportObject

Integer createReportObject(AbstractReportObject reportObject)
                           throws APIException

Deprecated. use saveReportObject(AbstractReportObject)

Throws:

APIException

deleteReport

void deleteReport(AbstractReportObject reportObject)
                  throws APIException

Deprecated. use purgeReportObject(AbstractReportObject)

Throws:

APIException

purgeReportObject

void purgeReportObject(AbstractReportObject reportObject)
                       throws APIException

Deprecated.

Completely delete the given reportObject from the database

Parameters:

reportObject -

Throws:

APIException

updateReportObject

void updateReportObject(AbstractReportObject reportObject)
                        throws APIException

Deprecated. use saveReportObject(AbstractReportObject)

Throws:

APIException

saveReportObject

AbstractReportObject saveReportObject(AbstractReportObject reportObject)
                                      throws APIException

Deprecated.

Save the given report object to the database

Parameters:

reportObject -

Returns:

AbstractReportObject that was saved

Throws:

APIException

getReportObjectTypes

List<String> getReportObjectTypes()
                                  throws APIException

Deprecated.

Get the current list of different reportObjectTypes stored in the system

Returns:

List of different reportObjectTypes stored in the system

Throws:

APIException

getReportObjectSubTypes

List<String> getReportObjectSubTypes(String type)
                                     throws APIException

Deprecated.

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

Returns:

String of different sub types stored in the system

Throws:

APIException

isSubTypeOfType

boolean isSubTypeOfType(String type,
                      String subType)
                        throws APIException

Deprecated.

Auto generated method comment

Parameters:

type -

subType -

Returns:

true if the subType is from a particular type

Throws:

APIException

getReportObjectClassBySubType

String getReportObjectClassBySubType(String subType)
                                     throws APIException

Deprecated.

Throws:

APIException

getAllReportObjectClasses

List<String> getAllReportObjectClasses()
                                       throws APIException

Deprecated.

Auto generated method comment

Returns:

List of all ReportObjectClasses

Throws:

APIException

getReportObjectValidatorByClass

String getReportObjectValidatorByClass(String currentClassName)
                                       throws APIException

Deprecated.

Auto generated method comment

Parameters:

currentClassName -

Returns:

String of Reported Object Validator by the currentClassName

Throws:

APIException

getDefaultReportObjectValidator

String getDefaultReportObjectValidator()
                                       throws APIException

Deprecated.

Auto generated method comment

Returns:

String with the default Report Object Validator

Throws:

APIException

createSearchHistory

void createSearchHistory(CohortSearchHistory history)
                         throws APIException

Deprecated. use saveSearchHistory(CohortSearchHistory)

Throws:

APIException

saveSearchHistory

CohortSearchHistory saveSearchHistory(CohortSearchHistory history)
                                      throws APIException

Deprecated.

TODO: why is this method in this service?

Parameters:

history -

Returns:

CohortSearchHistory of the saved Search History of a Cohort

Throws:

APIException

Expected Behavior:

Should save history successfully

deleteSearchHistory

void deleteSearchHistory(CohortSearchHistory history)
                         throws APIException

Deprecated. use purgeSearchHistory(CohortSearchHistory)

Throws:

APIException

purgeSearchHistory

void purgeSearchHistory(CohortSearchHistory history)
                        throws APIException

Deprecated.

Completely delete this method from the database

Parameters:

history -

Throws:

APIException

getSearchHistory

CohortSearchHistory getSearchHistory(Integer id)
                                     throws APIException

Deprecated.

Get a CohortSearchHistory by internal id or null if none found

Parameters:

id -

Returns:

CohortSearchHistory by internal id. null if not found

Throws:

APIException

getSearchHistories

List<CohortSearchHistory> getSearchHistories()
                                             throws APIException

Deprecated. use getAllSearchHistories()

Throws:

APIException

getAllSearchHistories

List<CohortSearchHistory> getAllSearchHistories()
                                                throws APIException

Deprecated.

Get all search histories stored in the database

Returns:

List of all search histories stored in the database

Throws:

APIException

getPatientSearch

PatientSearch getPatientSearch(Integer searchId)
                               throws APIException

Deprecated.

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

Parameters:

searchId -

Returns:

PatientSearch by internal id. null if not found

Throws:

APIException

getAllPatientSearches

List<PatientSearch> getAllPatientSearches()
                                          throws APIException

Deprecated.

Get all patient searches in the database

Returns:

List of all patient searches on the database

Throws:

APIException

getPatientSearch

PatientSearch getPatientSearch(String name)
                               throws APIException

Deprecated.

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

Parameters:

name -

Returns:

PatientSearch by name. null if not found

Throws:

APIException