org.openmrs.reporting
Interface ReportObjectService

All Superinterfaces:
OpenmrsService
All Known Implementing Classes:
ReportObjectServiceImpl

Deprecated. see reportingcompatibility module

@Transactional
@Deprecated
public interface ReportObjectService
extends OpenmrsService


Method Summary
 java.lang.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)
 java.util.List<PatientFilter> getAllPatientFilters()
          Deprecated. Auto generated method comment
 java.util.List<PatientSearch> getAllPatientSearches()
          Deprecated. Get all patient searches in the database
 java.util.List<java.lang.String> getAllReportObjectClasses()
          Deprecated. Auto generated method comment
 java.util.List<AbstractReportObject> getAllReportObjects()
          Deprecated. Get all report objects stored in the system
 java.util.List<CohortSearchHistory> getAllSearchHistories()
          Deprecated. Get all search histories stored in the database
 java.lang.String getDefaultReportObjectValidator()
          Deprecated. Auto generated method comment
 PatientFilter getPatientFilterById(java.lang.Integer filterId)
          Deprecated. Auto generated method comment
 PatientFilter getPatientFilterByName(java.lang.String filterName)
          Deprecated. Auto generated method comment
 PatientSearch getPatientSearch(java.lang.Integer searchId)
          Deprecated. Get patient search object by internal id or null if none found
 PatientSearch getPatientSearch(java.lang.String name)
          Deprecated. Get a patient search matching the name exactly or null if none found
 AbstractReportObject getReportObject(java.lang.Integer reportObjectId)
          Deprecated. Get the report object by internal id
 java.lang.String getReportObjectClassBySubType(java.lang.String subType)
          Deprecated.  
 java.util.List<AbstractReportObject> getReportObjectsByType(java.lang.String reportObjectType)
          Deprecated. Get report objects by type that was stored.
 java.util.List<java.lang.String> getReportObjectSubTypes(java.lang.String type)
          Deprecated. Get the current list of different sub types stored in the system
 java.util.List<java.lang.String> getReportObjectTypes()
          Deprecated. Get the current list of different reportObjectTypes stored in the system
 java.lang.String getReportObjectValidatorByClass(java.lang.String currentClassName)
          Deprecated. Auto generated method comment
 java.util.List<CohortSearchHistory> getSearchHistories()
          Deprecated. use getAllSearchHistories()
 CohortSearchHistory getSearchHistory(java.lang.Integer id)
          Deprecated. Get a CohortSearchHistory by internal id or null if none found
 boolean isSubTypeOfType(java.lang.String type, java.lang.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

@Transactional(readOnly=true)
java.util.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

@Transactional(readOnly=true)
AbstractReportObject getReportObject(java.lang.Integer reportObjectId)
                                     throws APIException
Deprecated. 
Get the report object by internal id

Parameters:
reportObjectId -
Returns:
AbstractReportObject by internal id
Throws:
APIException

getReportObjectsByType

@Transactional(readOnly=true)
java.util.List<AbstractReportObject> getReportObjectsByType(java.lang.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

@Transactional(readOnly=true)
PatientFilter getPatientFilterById(java.lang.Integer filterId)
                                   throws APIException
Deprecated. 
Auto generated method comment

Parameters:
filterId -
Returns:
PatientFilter by filter ID
Throws:
APIException

getPatientFilterByName

@Transactional(readOnly=true)
PatientFilter getPatientFilterByName(java.lang.String filterName)
                                     throws APIException
Deprecated. 
Auto generated method comment

Parameters:
filterName -
Returns:
PatientFilter by filter name
Throws:
APIException

getAllPatientFilters

@Transactional(readOnly=true)
java.util.List<PatientFilter> getAllPatientFilters()
                                                   throws APIException
Deprecated. 
Auto generated method comment

Returns:
List of all Patient Filters
Throws:
APIException

createReportObject

java.lang.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

@Transactional(readOnly=true)
java.util.List<java.lang.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

@Transactional(readOnly=true)
java.util.List<java.lang.String> getReportObjectSubTypes(java.lang.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(java.lang.String type,
                        java.lang.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

@Transactional(readOnly=true)
java.lang.String getReportObjectClassBySubType(java.lang.String subType)
                                               throws APIException
Deprecated. 
Throws:
APIException

getAllReportObjectClasses

@Transactional(readOnly=true)
java.util.List<java.lang.String> getAllReportObjectClasses()
                                                           throws APIException
Deprecated. 
Auto generated method comment

Returns:
List of all ReportObjectClasses
Throws:
APIException

getReportObjectValidatorByClass

@Transactional(readOnly=true)
java.lang.String getReportObjectValidatorByClass(java.lang.String currentClassName)
                                                 throws APIException
Deprecated. 
Auto generated method comment

Parameters:
currentClassName -
Returns:
String of Reported Object Validator by the currentClassName
Throws:
APIException

getDefaultReportObjectValidator

@Transactional(readOnly=true)
java.lang.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:
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

@Transactional(readOnly=true)
CohortSearchHistory getSearchHistory(java.lang.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

@Transactional(readOnly=true)
java.util.List<CohortSearchHistory> getSearchHistories()
                                                       throws APIException
Deprecated. use getAllSearchHistories()

Throws:
APIException

getAllSearchHistories

@Transactional(readOnly=true)
java.util.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

@Transactional(readOnly=true)
PatientSearch getPatientSearch(java.lang.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

@Transactional(readOnly=true)
java.util.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

@Transactional(readOnly=true)
PatientSearch getPatientSearch(java.lang.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

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change