org.openmrs.api.impl

Class ObsServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.ObsServiceImpl

All Implemented Interfaces:

ObsService, OpenmrsService

@Transactional
public class ObsServiceImpl
extends BaseOpenmrsService
implements ObsService

Default implementation of the Observation Service

See Also:

ObsService

Field Summary

Fields

Modifier and Type	Field and Description
protected ObsDAO	dao The data access object for the obs service

Constructor Summary

Constructors

Constructor and Description
ObsServiceImpl() Default empty constructor for this obs service

Method Summary

Modifier and Type	Method and Description
Obs	getComplexObs(Integer obsId, String view) Get a complex observation.
ComplexObsHandler	getHandler(Obs obs) Get the ComplexObsHandler associated with a complex observation Returns the ComplexObsHandler.
ComplexObsHandler	getHandler(String key) Get the ComplexObsHandler that has been registered with the given key
Map<String,ComplexObsHandler>	getHandlers() Gets the handlers map registered
Obs	getObs(Integer obsId) Get an observation
Obs	getObsByUuid(String uuid) Get Obs by its UUID
Integer	getObservationCount(List<ConceptName> conceptNames, boolean includeVoided) Gets the number of observations(including voided ones) that are using the specified conceptNames as valueCodedName answers
Integer	getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs) This method fetches the count of observations according to the criteria in the given arguments.
Integer	getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
Integer	getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<Visit> visits, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs) This method fetches observations according to the criteria in the given arguments.
List<Obs>	getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	getObservations(String searchString) This implementation queries the obs table comparing the given searchString with the patient's identifier, encounterId, and obsId
List<Obs>	getObservationsByPerson(Person who) Get all Observations for the given person, sorted by obsDatetime ascending.
List<Obs>	getObservationsByPersonAndConcept(Person who, Concept question) Get all nonvoided observations for the given patient with the given concept as the question concept (conceptId)
Obs	getRevisionObs(Obs initialObs) Get Revision Obs for initial Obs
void	onShutdown() Clean up after this class.
protected boolean	purgeComplexData(Obs obs) Internal method to remove ComplexData when an Obs is purged.
void	purgeObs(Obs obs) Completely remove an observation from the database.
void	purgeObs(Obs obs, boolean cascade) Completely remove an observation from the database.
void	registerHandler(String key, ComplexObsHandler handler) Registers the given handler with the given key If the given String key exists, that handler is overwritten with the given handler
void	registerHandler(String key, String handlerClass) Convenience method for ObsService.registerHandler(String, ComplexObsHandler)
void	removeHandler(String key) Remove the handler associated with the key from list of available handlers
Obs	saveObs(Obs obs, String changeMessage) Save the given obs to the database.
void	setHandlers(Map<String,ComplexObsHandler> newHandlers) Add the given map to this service's handlers.
void	setObsDAO(ObsDAO dao) Set the given dao on this obs service.
Obs	unvoidObs(Obs obs) Unvoids an Obs If the Obs argument is an obsGroup, all group members with the same dateVoided will also be unvoided.
Obs	voidObs(Obs obs, String reason) Voids an Obs If the Obs argument is an obsGroup, all group members will be voided.

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

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

onStartup

Field Detail

dao

protected ObsDAO dao

The data access object for the obs service

Constructor Detail

ObsServiceImpl

public ObsServiceImpl()

Default empty constructor for this obs service

Method Detail

setObsDAO

public void setObsDAO(ObsDAO dao)

Description copied from interface: ObsService

Set the given dao on this obs service. The dao will act as the conduit through with all obs calls get to the database

Specified by:

setObsDAO in interface ObsService

Parameters:

dao - specific ObsDAO to use for this service

See Also:

ObsService.setObsDAO(org.openmrs.api.db.ObsDAO)

onShutdown

public void onShutdown()

Clean up after this class. Set the static var to null so that the classloader can reclaim the space.

Specified by:

onShutdown in interface OpenmrsService

Overrides:

onShutdown in class BaseOpenmrsService

See Also:

BaseOpenmrsService.onShutdown()

saveObs

public Obs saveObs(Obs obs,
                   String changeMessage)
            throws APIException

Description copied from interface: ObsService

Save the given obs to the database. The behavior differs for first-time save, and edit.

When you save a new observation to the database:

• the obs you pass in is saved to the database, and its obsId field is filled in
• the obs you pass in is returned
• the changeMesssage parameter is ignored

When you edit an existing observation:

• the values of the obs you pass to this method are written to the database as new obs
• the newly-created obs is returned (i.e. not the one you passed in)
• the obs you passed is marked as voided, with changeMessage as the void reason
• the newly-created obs points back to the voided one via its previousVersion field

Specified by:

saveObs in interface ObsService

Parameters:

obs - the Obs to save to the database

changeMessage - String explaining why obs is being changed. If obs is a new obs, changeMessage is nullable, or if it is being updated, it would be required

Returns:

Obs that was saved to the database

Throws:

APIException - Should create new file from complex data for new obs Should not overwrite file when updating a complex obs Should void the given obs in the database Should create very basic obs and add new obsId Should allow setting properties on obs Should return a different object when updating an obs Should set creator and dateCreated on new obs Should cascade save to child obs groups Should cascade update to new child obs groups Should link original and updated obs Should set void reason message to changeMessage Should not void an Obs with no changes

See Also:

ObsService.saveObs(org.openmrs.Obs, String)

getObs

@Transactional(readOnly=true)
public Obs getObs(Integer obsId)
                                         throws APIException

Description copied from interface: ObsService

Get an observation

Specified by:

getObs in interface ObsService

Parameters:

obsId - integer obsId of observation desired

Returns:

matching Obs

Throws:

APIException - Should get obs matching given obsId

See Also:

ObsService.getObs(java.lang.Integer)

voidObs

public Obs voidObs(Obs obs,
                   String reason)
            throws APIException

Voids an Obs If the Obs argument is an obsGroup, all group members will be voided.

Specified by:

voidObs in interface ObsService

Parameters:

obs - the Obs to void

reason - the void reason

Throws:

APIException

See Also:

ObsService.voidObs(org.openmrs.Obs, java.lang.String)

unvoidObs

public Obs unvoidObs(Obs obs)
              throws APIException

Unvoids an Obs

If the Obs argument is an obsGroup, all group members with the same dateVoided will also be unvoided.

Specified by:

unvoidObs in interface ObsService

Parameters:

obs - the Obs to unvoid

Returns:

the unvoided Obs

Throws:

APIException

See Also:

ObsService.unvoidObs(org.openmrs.Obs)

purgeObs

public void purgeObs(Obs obs,
                     boolean cascade)
              throws APIException

Description copied from interface: ObsService

Completely remove an observation from the database. This should typically not be called because we don't want to ever lose data. The data really should be voided and then it is not seen in interface any longer (see #voidObs(Obs) for that one)

Specified by:

purgeObs in interface ObsService

Parameters:

obs - the observation to remove from the database

cascade - true/false whether or not to cascade down to other things that link to this observation (like Orders and ObsGroups)

Throws:

APIException

See Also:

ObsService.purgeObs(org.openmrs.Obs, boolean)

purgeObs

public void purgeObs(Obs obs)
              throws APIException

Description copied from interface: ObsService

Completely remove an observation from the database. This should typically not be called because we don't want to ever lose data. The data really should be voided and then it is not seen in interface any longer (see #voidObs(Obs) for that one) If other things link to this obs, an error will be thrown.

Specified by:

purgeObs in interface ObsService

Throws:

APIException

See Also:

ObsService.purgeObs(org.openmrs.Obs)

getObservations

@Transactional(readOnly=true)
public List<Obs> getObservations(List<Person> whom,
                                                               List<Encounter> encounters,
                                                               List<Concept> questions,
                                                               List<Concept> answers,
                                                               List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                               List<Location> locations,
                                                               List<String> sort,
                                                               Integer mostRecentN,
                                                               Integer obsGroupId,
                                                               Date fromDate,
                                                               Date toDate,
                                                               boolean includeVoidedObs)
                                                        throws APIException

Description copied from interface: ObsService

This method fetches observations according to the criteria in the given arguments. All arguments are optional and nullable. If more than one argument is non-null, the result is equivalent to an "and"ing of the arguments. (e.g. if both a location and a fromDate are given, only Obs that are both at that Location and after the fromDate are returned).

Note: If whom has elements, personType is ignored

Note: to get all observations on a certain date, use:
Date fromDate = "2009-08-15";
Date toDate = OpenmrsUtil.lastSecondOfDate(fromDate); List<Obs> obs = getObservations(...., fromDate, toDate, ...);

Specified by:

getObservations in interface ObsService

Parameters:

whom - List<Person> to restrict obs to (optional)

encounters - List<Encounter> to restrict obs to (optional)

questions - List<Concept> to restrict the obs to (optional)

answers - List<Concept> to restrict the valueCoded to (optional)

personTypes - List<PERSON_TYPE> objects to restrict this to. Only used if whom is an empty list (optional)

locations - The org.openmrs.Location objects to restrict to (optional)

sort - list of column names to sort on (obsId, obsDatetime, etc) if null, defaults to obsDatetime (optional)

mostRecentN - restrict the number of obs returned to this size (optional)

obsGroupId - the Obs.getObsGroupId() to this integer (optional)

fromDate - the earliest Obs date to get (optional)

toDate - the latest Obs date to get (optional)

includeVoidedObs - true/false whether to also include the voided obs (required)

Returns:

list of Observations that match all of the criteria given in the arguments

Throws:

APIException

See Also:

ObsService.getObservations(java.util.List, java.util.List, java.util.List, java.util.List, List, List, java.util.List, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date, boolean)

getObservations

@Transactional(readOnly=true)
public List<Obs> getObservations(List<Person> whom,
                                                               List<Encounter> encounters,
                                                               List<Concept> questions,
                                                               List<Concept> answers,
                                                               List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                               List<Location> locations,
                                                               List<String> sort,
                                                               Integer mostRecentN,
                                                               Integer obsGroupId,
                                                               Date fromDate,
                                                               Date toDate,
                                                               boolean includeVoidedObs,
                                                               String accessionNumber)
                                                        throws APIException

Specified by:

getObservations in interface ObsService

Parameters:

whom - List<Person> to restrict obs to (optional)

encounters - List<Encounter> to restrict obs to (optional)

questions - List<Concept> to restrict the obs to (optional)

answers - List<Concept> to restrict the valueCoded to (optional)

personTypes - List<PERSON_TYPE> objects to restrict this to. Only used if whom is an empty list (optional)

locations - The org.openmrs.Location objects to restrict to (optional)

sort - list of column names to sort on (obsId, obsDatetime, etc) if null, defaults to obsDatetime (optional)

mostRecentN - restrict the number of obs returned to this size (optional)

obsGroupId - the Obs.getObsGroupId() to this integer (optional)

fromDate - the earliest Obs date to get (optional)

toDate - the latest Obs date to get (optional)

includeVoidedObs - true/false whether to also include the voided obs (required)

accessionNumber - accession number (optional)

Returns:

list of Observations that match all of the criteria given in the arguments

Throws:

APIException - Should compare dates using lte and gte Should get all obs assigned to given encounters Should get all obs with question concept in given questions parameter Should get all obs with answer concept in given answers parameter Should return all obs whose person is a person only Should return obs whose person is a patient only Should return obs whose person is a user only Should return obs with location in given locations parameter Should sort returned obs by obsDatetime if sort is empty Should sort returned obs by conceptId if sort is concept Should limit number of obs returned to mostReturnN parameter Should return obs whose groupId is given obsGroupId Should not include voided obs Should include voided obs if includeVoidedObs is true Should only return observations with matching accession number

See Also:

ObsService.getObservations(java.util.List, java.util.List, java.util.List, java.util.List, List, List, java.util.List, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date, boolean, java.lang.String)

getObservations

@Transactional(readOnly=true)
public List<Obs> getObservations(List<Person> whom,
                                                               List<Encounter> encounters,
                                                               List<Concept> questions,
                                                               List<Concept> answers,
                                                               List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                               List<Location> locations,
                                                               List<String> sort,
                                                               List<Visit> visits,
                                                               Integer mostRecentN,
                                                               Integer obsGroupId,
                                                               Date fromDate,
                                                               Date toDate,
                                                               boolean includeVoidedObs,
                                                               String accessionNumber)
                                                        throws APIException

Specified by:

getObservations in interface ObsService

visits - List<Visit> to restrict obs to (optional)

Throws:

APIException

See Also:

ObsService.getObservations(java.util.List, java.util.List, java.util.List, java.util.List, List, List, java.util.List, java.util.List, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date, boolean, java.lang.String)

getObservationCount

@Transactional(readOnly=true)
public Integer getObservationCount(List<Person> whom,
                                                                 List<Encounter> encounters,
                                                                 List<Concept> questions,
                                                                 List<Concept> answers,
                                                                 List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                                 List<Location> locations,
                                                                 Integer obsGroupId,
                                                                 Date fromDate,
                                                                 Date toDate,
                                                                 boolean includeVoidedObs)
                                                          throws APIException

Description copied from interface: ObsService

This method fetches the count of observations according to the criteria in the given arguments. All arguments are optional and nullable. If more than one argument is non-null, the result is equivalent to an "and"ing of the arguments. (e.g. if both a location and a fromDate are given, only Obs that are both at that Location and after the fromDate are returned).

Note: If whom has elements, personType is ignored

Note: to get all observations count on a certain date, use:
Date fromDate = "2009-08-15";
Date toDate = OpenmrsUtil.lastSecondOfDate(fromDate); List<Obs> obs = getObservations(...., fromDate, toDate, ...);

Specified by:

getObservationCount in interface ObsService

Parameters:

whom - List<Person> to restrict obs to (optional)

encounters - List<Encounter> to restrict obs to (optional)

questions - List<Concept> to restrict the obs to (optional)

answers - List<Concept> to restrict the valueCoded to (optional)

personTypes - List<PERSON_TYPE> objects to restrict this to. Only used if whom is an empty list (optional)

locations - The org.openmrs.Location objects to restrict to (optional) obsDatetime (optional)

obsGroupId - the Obs.getObsGroupId() to this integer (optional)

fromDate - the earliest Obs date to get (optional)

toDate - the latest Obs date to get (optional)

includeVoidedObs - true/false whether to also include the voided obs (required)

Returns:

list of Observations that match all of the criteria given in the arguments

Throws:

APIException

See Also:

ObsService.getObservationCount(java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.lang.Integer, java.util.Date, java.util.Date, boolean)

getObservationCount

@Transactional(readOnly=true)
public Integer getObservationCount(List<Person> whom,
                                                                 List<Encounter> encounters,
                                                                 List<Concept> questions,
                                                                 List<Concept> answers,
                                                                 List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                                 List<Location> locations,
                                                                 Integer obsGroupId,
                                                                 Date fromDate,
                                                                 Date toDate,
                                                                 boolean includeVoidedObs,
                                                                 String accessionNumber)
                                                          throws APIException

Specified by:

getObservationCount in interface ObsService

Parameters:

whom - List<Person> to restrict obs to (optional)

encounters - List<Encounter> to restrict obs to (optional)

questions - List<Concept> to restrict the obs to (optional)

answers - List<Concept> to restrict the valueCoded to (optional)

personTypes - List<PERSON_TYPE> objects to restrict this to. Only used if whom is an empty list (optional)

locations - The org.openmrs.Location objects to restrict to (optional) obsDatetime (optional)

obsGroupId - the Obs.getObsGroupId() to this integer (optional)

fromDate - the earliest Obs date to get (optional)

toDate - the latest Obs date to get (optional)

includeVoidedObs - true/false whether to also include the voided obs (required)

accessionNumber - accession number (optional)

Returns:

list of Observations that match all of the criteria given in the arguments

Throws:

APIException - Should compare dates using lte and gte Should get the count of all obs assigned to given encounters Should get the count of all obs with question concept in given questions parameter Should get the count of all obs with answer concept in given answers parameter Should return the count of all obs whose person is a person only Should return the count of all obs whose person is a patient only Should return the count of obs whose person is a user only Should return the count of obs with location in given locations parameter Should return the count of obs whose groupId is given obsGroupId Should not include count of voided obs Should include count of voided obs if includeVoidedObs is true Should return count of obs with matching accession number

See Also:

ObsService.getObservationCount(java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.lang.Integer, java.util.Date, java.util.Date, boolean, java.lang.String)

getObservationCount

@Transactional(readOnly=true)
public Integer getObservationCount(List<Person> whom,
                                                                 List<Encounter> encounters,
                                                                 List<Concept> questions,
                                                                 List<Concept> answers,
                                                                 List<OpenmrsConstants.PERSON_TYPE> personTypes,
                                                                 List<Location> locations,
                                                                 List<Visit> visits,
                                                                 Integer obsGroupId,
                                                                 Date fromDate,
                                                                 Date toDate,
                                                                 boolean includeVoidedObs,
                                                                 String accessionNumber)
                                                          throws APIException

Specified by:

getObservationCount in interface ObsService

visits - List<Visit> to restrict obs to (optional)

Throws:

APIException

See Also:

ObsService.getObservationCount(java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.util.List, java.lang.Integer, java.util.Date, java.util.Date, boolean, java.lang.String)

getObservations

@Transactional(readOnly=true)
public List<Obs> getObservations(String searchString)

This implementation queries the obs table comparing the given searchString with the patient's identifier, encounterId, and obsId

Specified by:

getObservations in interface ObsService

Parameters:

searchString - The string to search on

Returns:

observations matching the given string

See Also:

ObsService.getObservations(java.lang.String)

getObservationsByPerson

@Transactional(readOnly=true)
public List<Obs> getObservationsByPerson(Person who)

Description copied from interface: ObsService

Get all Observations for the given person, sorted by obsDatetime ascending. Does not return voided observations.

Specified by:

getObservationsByPerson in interface ObsService

Parameters:

who - the user to match on

Returns:

a List<Obs> object containing all non-voided observations for the specified person

See Also:

ObsService.getObservationsByPerson(org.openmrs.Person)

getObservationsByPersonAndConcept

@Transactional(readOnly=true)
public List<Obs> getObservationsByPersonAndConcept(Person who,
                                                                                 Concept question)
                                                                          throws APIException

Description copied from interface: ObsService

Get all nonvoided observations for the given patient with the given concept as the question concept (conceptId)

Specified by:

getObservationsByPersonAndConcept in interface ObsService

Parameters:

who - person to match on

question - conceptId to match on

Returns:

list of all nonvoided observations matching these criteria

Throws:

APIException

See Also:

ObsService.getObservationsByPersonAndConcept(org.openmrs.Person, org.openmrs.Concept)

getObsByUuid

@Transactional(readOnly=true)
public Obs getObsByUuid(String uuid)
                                               throws APIException

Description copied from interface: ObsService

Get Obs by its UUID

Specified by:

getObsByUuid in interface ObsService

Returns:

obs or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

See Also:

ObsService.getObsByUuid(java.lang.String)

getRevisionObs

@Transactional(readOnly=true)
public Obs getRevisionObs(Obs initialObs)

Description copied from interface: ObsService

Get Revision Obs for initial Obs

Specified by:

getRevisionObs in interface ObsService

Returns:

obs or null

See Also:

ObsService.getRevisionObs(org.openmrs.Obs)

getComplexObs

@Transactional(readOnly=true)
public Obs getComplexObs(Integer obsId,
                                                       String view)
                                                throws APIException

Description copied from interface: ObsService

Get a complex observation. If obs.isComplex() is true, then returns an Obs with its ComplexData. Otherwise returns a simple Obs.

Specified by:

getComplexObs in interface ObsService

Returns:

Obs with a ComplexData

Throws:

APIException

See Also:

ObsService.getComplexObs(Integer, String)

purgeComplexData

protected boolean purgeComplexData(Obs obs)
                            throws APIException

Internal method to remove ComplexData when an Obs is purged.

Throws:

APIException

getHandler

@Transactional(readOnly=true)
public ComplexObsHandler getHandler(Obs obs)
                                                           throws APIException

Description copied from interface: ObsService

Get the ComplexObsHandler associated with a complex observation Returns the ComplexObsHandler. Returns null if the Obs.isComplexObs() is false or there is an error instantiating the handler class.

Specified by:

getHandler in interface ObsService

Parameters:

obs - A complex Obs.

Returns:

ComplexObsHandler for the complex Obs. or null on error.

Throws:

APIException

See Also:

ObsService.getHandler(org.openmrs.Obs)

getHandler

public ComplexObsHandler getHandler(String key)

Description copied from interface: ObsService

Get the ComplexObsHandler that has been registered with the given key

Specified by:

getHandler in interface ObsService

Parameters:

key - that has been registered with a handler class

Returns:

Object representing the handler for the given key

See Also:

ObsService.getHandler(java.lang.String)

setHandlers

public void setHandlers(Map<String,ComplexObsHandler> newHandlers)
                 throws APIException

Description copied from interface: ObsService

Add the given map to this service's handlers. This method registers each ComplexObsHandler to this service. If the given String key exists, that handler is overwritten with the given handler For most situations, this map is set via spring, see the applicationContext-service.xml file to add more handlers.

Specified by:

setHandlers in interface ObsService

Parameters:

newHandlers - Map of class to handler object

Throws:

APIException

See Also:

ObsService.setHandlers(Map), registerHandler(String, ComplexObsHandler)

getHandlers

@Transactional(readOnly=true)
public Map<String,ComplexObsHandler> getHandlers()
                                                                        throws APIException

Description copied from interface: ObsService

Gets the handlers map registered

Specified by:

getHandlers in interface ObsService

Returns:

map of keys to handlers

Throws:

APIException - Should never return null

See Also:

ObsService.getHandlers()

registerHandler

public void registerHandler(String key,
                            ComplexObsHandler handler)
                     throws APIException

Description copied from interface: ObsService

Registers the given handler with the given key If the given String key exists, that handler is overwritten with the given handler

Specified by:

registerHandler in interface ObsService

Parameters:

key - the key name to use for this handler

handler - the class to register with this key

Throws:

APIException

See Also:

ObsService.registerHandler(String, ComplexObsHandler)

registerHandler

public void registerHandler(String key,
                            String handlerClass)
                     throws APIException

Description copied from interface: ObsService

Convenience method for ObsService.registerHandler(String, ComplexObsHandler)

Specified by:

registerHandler in interface ObsService

Parameters:

key - the key name to use for this handler

handlerClass - the class to register with this key

Throws:

APIException

See Also:

ObsService.registerHandler(String, String)

getObservationCount

@Transactional(readOnly=true)
public Integer getObservationCount(List<ConceptName> conceptNames,
                                                                 boolean includeVoided)

Description copied from interface: ObsService

Gets the number of observations(including voided ones) that are using the specified conceptNames as valueCodedName answers

Specified by:

getObservationCount in interface ObsService

Parameters:

conceptNames - the conceptNames to be searched against

includeVoided - whether voided observation should be included

Returns:

The number of observations using the specified conceptNames as valueCodedNames Should return the count of all observations using the specified conceptNames as answers Should include voided observations using the specified conceptNames as answers Should return zero if no observation is using any of the concepNames in the list

See Also:

ObsService.getObservationCount(java.util.List, boolean)

removeHandler

public void removeHandler(String key)

Description copied from interface: ObsService

Remove the handler associated with the key from list of available handlers

Specified by:

removeHandler in interface ObsService

Parameters:

key - the key of the handler to unregister

See Also:

ObsService.removeHandler(java.lang.String)