AdministrationService (OpenMRS-trunk API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openmrs.api
Interface AdministrationService

All Superinterfaces:: OpenmrsService

All Known Implementing Classes:: AdministrationServiceImpl

@Transactional public interface AdministrationService
extends OpenmrsService
extends OpenmrsService

Contains methods pertaining to doing some administrative tasks in OpenMRS Use:

   List globalProperties = Context.getAdministrationService().getGlobalProperties();

See Also:: Context

Method Summary
`void`	`addGlobalProperty(GlobalProperty gp)`
`void`	`addGlobalProperty(java.lang.String propertyName, java.lang.String propertyValue)` Deprecated. use `saveGlobalProperty(GlobalProperty)`
`void`	`addGlobalPropertyListener(GlobalPropertyListener listener)` Allows code to be notified when a global property is created/edited/deleted.
`void`	`createConceptClass(ConceptClass cc)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptClass(ConceptClass)`
`void`	`createConceptDatatype(ConceptDatatype cd)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptDatatype(ConceptDatatype)`
`void`	`createConceptProposal(ConceptProposal cp)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptProposal(ConceptProposal)`
`void`	`createEncounterType(EncounterType encounterType)` Deprecated. use `EncounterService.saveEncounterType(EncounterType)`
`void`	`createFieldType(FieldType fieldType)` Deprecated. use `FormService.saveFieldType(FieldType)`
`void`	`createLocation(Location location)` Deprecated. @see `LocationService.saveLocation(Location)`
`void`	`createMimeType(MimeType mimeType)` Deprecated. @see `ObsService.saveMimeType(MimeType)`
`void`	`createPatientIdentifierType(PatientIdentifierType patientIdentifierType)` Deprecated. replaced by `PatientService.savePatientIdentifierType(PatientIdentifierType)`
`void`	`createPrivilege(Privilege privilege)` Deprecated. @see `UserService.savePrivilege(Privilege)`
`void`	`createReport(Report report)` Create a new Report
`void`	`createReportObject(AbstractReportObject reportObject)` Create a new Report Object
`void`	`createRole(Role role)` Deprecated. @see `UserService.saveRole(Role)`
`void`	`createTribe(Tribe tribe)` Deprecated. tribe will be moved to patient attribute
`void`	`deleteConceptClass(ConceptClass cc)` Deprecated. use `org.openmrs.api.ConceptService.retireConceptClass(ConceptClass)` or `org.openmrs.api.ConcepService.purgeConceptClass(ConceptClass)`
`void`	`deleteConceptDatatype(ConceptDatatype cd)` Deprecated. use `org.openmrs.api.ConceptService.retireConceptDatatype(ConceptDatatype)` or `org.openmrs.api.deleteConceptDatatype(ConceptDatatype)`
`void`	`deleteEncounterType(EncounterType encounterType)` Deprecated. use `EncounterService.purgeEncounterType(EncounterType)`
`void`	`deleteFieldType(FieldType fieldType)` Deprecated. use `FormService.purgeFieldType(FieldType)`
`void`	`deleteGlobalProperty(java.lang.String propertyName)` Deprecated. use `purgeGlobalProperty(GlobalProperty)`
`void`	`deleteLocation(Location location)` Deprecated. @see `LocationService.purgeLocation(Location)`
`void`	`deleteMimeType(MimeType mimeType)` Deprecated. @see `ObsService.purgeMimeType(MimeType)`
`void`	`deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)` Deprecated. replaced by `PatientService.purgePatientIdentifierType(PatientIdentifierType)`
`void`	`deletePrivilege(Privilege privilege)` Deprecated. @see `UserService.purgePrivilege(Privilege)`
`void`	`deleteReport(Report report)` Delete Report
`void`	`deleteReportObject(java.lang.Integer reportObjectId)` Delete Report Object
`void`	`deleteRole(Role role)` Deprecated. @see `UserService.purgeRole(Role)`
`void`	`deleteTribe(Tribe tribe)` Deprecated. tribe will be moved to patient attribute
`java.util.List<java.util.List<java.lang.Object>>`	`executeSQL(java.lang.String sql, boolean selectOnly)` Runs the `sql` on the database.
`java.util.List<GlobalProperty>`	`getAllGlobalProperties()` Get a list of all global properties in the system
`java.util.List<DataEntryStatistic>`	`getDataEntryStatistics(java.util.Date fromDate, java.util.Date toDate, java.lang.String encounterUserColumn, java.lang.String orderUserColumn, java.lang.String groupBy)` Creates a list of data entry stats from `fromDate` to `toDate` EncounterUserColumn is a column in the encounter table like `creator`, `provider`, etc (defaults to creator) EncounterUserColumn is a column in the encounter table like `creator`, `orderer`, etc (defaults to orderer)
`java.util.List<GlobalProperty>`	`getGlobalProperties()` Deprecated. use `getAllGlobalProperties()`
`java.lang.String`	`getGlobalProperty(java.lang.String propertyName)` Gets the global property that has the given `propertyName` If propertyName is not found in the list of Global Properties currently in the database, a null value is returned This method should not have any authorization check
`java.lang.String`	`getGlobalProperty(java.lang.String propertyName, java.lang.String defaultValue)` Gets the global property that has the given `propertyName` If propertyName is not found in the list of Global Properties currently in the database, a `defaultValue` is returned This method should not have any authorization check
`java.util.Collection<?>`	`getMRNGeneratorLog()` To be deprecated when the mrn generator module is completed
`java.util.SortedMap<java.lang.String,java.lang.String>`	`getSystemVariables()` Get a listing or important variables used in openmrs
`void`	`mapConceptProposalToConcept(ConceptProposal cp, Concept mappedConcept)` Deprecated. moved to `org.openmrs.api.ConceptService.mapConceptProposalToConcept(ConceptProposal, Concept)`
`void`	`mrnGeneratorLog(java.lang.String site, java.lang.Integer start, java.lang.Integer count)` To be deprecated when mrn generator module is completed
`void`	`purgeGlobalProperty(GlobalProperty globalProperty)` Completely remove the given global property from the database
`void`	`rejectConceptProposal(ConceptProposal cp)` Deprecated. moved to `org.openmrs.api.ConceptServicerejectConceptProposal(ConceptProposal)`
`void`	`removeGlobalPropertyListener(GlobalPropertyListener listener)` Removes a GlobalPropertyListener previously registered by `#addGlobalPropertyListener(String, GlobalPropertyListener)`
`void`	`retireTribe(Tribe tribe)` Deprecated. tribe will be moved to patient attribute
`java.util.List<GlobalProperty>`	`saveGlobalProperties(java.util.List<GlobalProperty> props)` Save the given list of global properties to the database overwriting all values with the given values.
`GlobalProperty`	`saveGlobalProperty(GlobalProperty gp)` Save the given global property to the database
`void`	`setAdministrationDAO(AdministrationDAO dao)` Used by Spring to set the specific/chosen database access implementation
`void`	`setGlobalProperties(java.util.List<GlobalProperty> props)` Deprecated. use `saveGlobalProperties(List)`
`void`	`setGlobalProperty(GlobalProperty gp)` Deprecated. use `saveGlobalProperty(GlobalProperty)`
`void`	`setGlobalProperty(java.lang.String propertyName, java.lang.String propertyValue)` Deprecated. use #saveGlobalProperty(GlobalProperty)
`void`	`unretireTribe(Tribe tribe)` Deprecated. tribe will be moved to patient attribute
`void`	`updateConceptClass(ConceptClass cc)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptClass(ConceptClass)`
`void`	`updateConceptDatatype(ConceptDatatype cd)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptDatatype(ConceptDatatype)`
`void`	`updateConceptProposal(ConceptProposal cp)` Deprecated. use `org.openmrs.api.ConceptService.saveConceptProposal(ConceptProposal)`
`void`	`updateConceptSetDerived()` Deprecated. moved to `org.openmrs.api.ConceptService.updateConceptSetDerived()`
`void`	`updateConceptSetDerived(Concept concept)` Deprecated. moved to `org.openmrs.api.ConceptService.updateConceptSetDerived(Concept)`;
`void`	`updateConceptWord(Concept concept)` Deprecated. moved to `org.openmrs.api.ConceptService.updateConceptWord(Concept)`
`void`	`updateConceptWords()` Deprecated. moved to `org.openmrs.api.ConceptService.updateConceptWords()`
`void`	`updateConceptWords(java.lang.Integer conceptIdStart, java.lang.Integer conceptIdEnd)` Deprecated. moved to `org.openmrs.api.ConceptService.updateConceptWords(Integer, Integer)`
`void`	`updateEncounterType(EncounterType encounterType)` Deprecated. use `EncounterService.saveEncounterType(EncounterType)`
`void`	`updateFieldType(FieldType fieldType)` Deprecated. use `FormService.saveFieldType(FieldType)`
`void`	`updateLocation(Location location)` Deprecated. @see `LocationService.saveLocation(Location)`
`void`	`updateMimeType(MimeType mimeType)` Deprecated. @see `ObsService.saveMimeType(MimeType)`
`void`	`updatePatientIdentifierType(PatientIdentifierType patientIdentifierType)` Deprecated. replaced by `PatientService.savePatientIdentifierType(PatientIdentifierType)`
`void`	`updatePrivilege(Privilege privilege)` Deprecated. @see `UserService.savePrivilege(Privilege)`
`void`	`updateReport(Report report)` Update Report
`void`	`updateReportObject(AbstractReportObject reportObject)` Update Report Object
`void`	`updateRole(Role role)` Deprecated. @see `UserService.saveRole(Role)`
`void`	`updateTribe(Tribe tribe)` Deprecated. tribe will be moved to patient attribute

Methods inherited from interface org.openmrs.api.OpenmrsService
`onShutdown, onStartup`

Method Detail

setAdministrationDAO

void setAdministrationDAO(AdministrationDAO dao)

Used by Spring to set the specific/chosen database access implementation

Parameters:: dao - The dao implementation to use

createEncounterType

void createEncounterType(EncounterType encounterType)
                         throws APIException

Deprecated. use EncounterService.saveEncounterType(EncounterType)

Throws:: APIException

updateEncounterType

void updateEncounterType(EncounterType encounterType)
                         throws APIException

Deprecated. use EncounterService.saveEncounterType(EncounterType)

Throws:: APIException

deleteEncounterType

void deleteEncounterType(EncounterType encounterType)
                         throws APIException

Deprecated. use EncounterService.purgeEncounterType(EncounterType)

Throws:: APIException

createPatientIdentifierType

void createPatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                 throws APIException

Deprecated. replaced by PatientService.savePatientIdentifierType(PatientIdentifierType)

Throws:: APIException
See Also:: PatientService.savePatientIdentifierType(PatientIdentifierType)

updatePatientIdentifierType

void updatePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                 throws APIException

Deprecated. replaced by PatientService.savePatientIdentifierType(PatientIdentifierType)

Throws:: APIException
See Also:: PatientService.savePatientIdentifierType(PatientIdentifierType)

deletePatientIdentifierType

void deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                 throws APIException

Deprecated. replaced by PatientService.purgePatientIdentifierType(PatientIdentifierType)

Throws:: APIException
See Also:: PatientService.purgePatientIdentifierType(PatientIdentifierType)