org.openmrs.api.impl

Class ProviderServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.ProviderServiceImpl

All Implemented Interfaces:

OpenmrsService, ProviderService

@Transactional
public class ProviderServiceImpl
extends BaseOpenmrsService
implements ProviderService

Default implementation of the ProviderService. This class should not be used on its own. The current OpenMRS implementation should be fetched from the Context.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
ProviderServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<ProviderAttributeType>	getAllProviderAttributeTypes() Gets all provider attribute types including retired provider attribute types.
List<ProviderAttributeType>	getAllProviderAttributeTypes(boolean includeRetired) Gets all provider attribute types optionally including retired provider attribute types.
List<Provider>	getAllProviders() Gets all providers. includes retired Provider.This method delegates to the #getAllProviders(boolean) method
List<Provider>	getAllProviders(boolean includeRetired) Gets all providers
Integer	getCountOfProviders(String query)
Integer	getCountOfProviders(String query, boolean includeRetired) Gets the count of providers with a person name or identifier or name that matches the specified query
Provider	getProvider(Integer providerId) Gets a provider by its provider id
ProviderAttribute	getProviderAttribute(Integer providerAttributeID) Get a provider attribute by it's providerAttributeID
ProviderAttribute	getProviderAttributeByUuid(String uuid) Get a provider attribute by its providerAttributeUuid
ProviderAttributeType	getProviderAttributeType(Integer providerAttributeTypeId) Gets a provider attribute type by it's id
ProviderAttributeType	getProviderAttributeTypeByName(String name) Get a provider attribute type by its name
ProviderAttributeType	getProviderAttributeTypeByUuid(String uuid) Get a provider attribute type by its uuid
Provider	getProviderByIdentifier(String identifier) Gets a provider with a matching identifier, this method performs a case insensitive search
Provider	getProviderByUuid(String uuid)
List<Provider>	getProviders(String query, Integer start, Integer length, Map<ProviderAttributeType,Object> attributeValues)
List<Provider>	getProviders(String query, Integer start, Integer length, Map<ProviderAttributeType,Object> attributeValues, boolean includeRetired)
Collection<Provider>	getProvidersByPerson(Person person) Gets the Providers for the given person.
Collection<Provider>	getProvidersByPerson(Person person, boolean includeRetired) Gets the Providers for the given person including or excluding retired.
Provider	getUnknownProvider() Gets the unknown provider account, i.e. the provider account that matches the uuid specified as the value for the global property OpenmrsConstants.GP_UNKNOWN_PROVIDER_UUID
boolean	isProviderIdentifierUnique(Provider provider) Checks if the identifier for the specified provider is unique
void	purgeProvider(Provider provider) Deletes a given Provider
void	purgeProviderAttributeType(ProviderAttributeType providerAttributeType) Deletes a provider attribute type
void	retireProvider(Provider provider, String reason) Retires a given Provider
ProviderAttributeType	retireProviderAttributeType(ProviderAttributeType providerAttributeType, String reason) Retire a provider attribute type
Provider	saveProvider(Provider provider)
ProviderAttributeType	saveProviderAttributeType(ProviderAttributeType providerAttributeType) Save the provider attribute type
void	setProviderDAO(ProviderDAO dao) Sets the data access object for Concepts.
Provider	unretireProvider(Provider provider) Unretire a given Provider
ProviderAttributeType	unretireProviderAttributeType(ProviderAttributeType providerAttributeType) Un-Retire a provider attribute type

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

ProviderServiceImpl

public ProviderServiceImpl()

Method Detail

setProviderDAO

public void setProviderDAO(ProviderDAO dao)

Sets the data access object for Concepts. The dao is used for saving and getting concepts to/from the database

Parameters:

dao - The data access object to use

getAllProviders

@Transactional(readOnly=true)
public List<Provider> getAllProviders()

Description copied from interface: ProviderService

Gets all providers. includes retired Provider.This method delegates to the #getAllProviders(boolean) method

Specified by:

getAllProviders in interface ProviderService

Returns:

a list of provider objects. Should get all providers

See Also:

ProviderService.getAllProviders()

getAllProviders

@Transactional(readOnly=true)
public List<Provider> getAllProviders(boolean includeRetired)

Description copied from interface: ProviderService

Gets all providers

Specified by:

getAllProviders in interface ProviderService

Parameters:

includeRetired - - if true, retired providers are also included Should get all providers that are unretired

See Also:

ProviderService.getAllProviders(boolean)

retireProvider

public void retireProvider(Provider provider,
                           String reason)

Description copied from interface: ProviderService

Retires a given Provider

Specified by:

retireProvider in interface ProviderService

Parameters:

provider - provider to retire

reason - reason why the provider is retired Should retire a provider

See Also:

ProviderService.retireProvider(org.openmrs.Provider, java.lang.String)

unretireProvider

public Provider unretireProvider(Provider provider)

Description copied from interface: ProviderService

Unretire a given Provider

Specified by:

unretireProvider in interface ProviderService

Parameters:

provider - provider to unretire Should unretire a provider

See Also:

ProviderService.unretireProvider(org.openmrs.Provider)

purgeProvider

public void purgeProvider(Provider provider)

Description copied from interface: ProviderService

Deletes a given Provider

Specified by:

purgeProvider in interface ProviderService

Parameters:

provider - provider to be deleted Should delete a provider

See Also:

ProviderService.purgeProvider(org.openmrs.Provider)

getProvider

@Transactional(readOnly=true)
public Provider getProvider(Integer providerId)

Description copied from interface: ProviderService

Gets a provider by its provider id

Specified by:

getProvider in interface ProviderService

Parameters:

providerId - the provider id

Returns:

the provider by it's id Should get provider given ID

See Also:

ProviderService.getProvider(java.lang.Integer)

saveProvider

public Provider saveProvider(Provider provider)

Specified by:

saveProvider in interface ProviderService

Returns:

the Provider object after saving it in the database Should save a Provider with Person alone Should not save a Provider person being null

See Also:

ProviderService.saveProvider(org.openmrs.Provider)

getProviderByUuid

@Transactional(readOnly=true)
public Provider getProviderByUuid(String uuid)

Specified by:

getProviderByUuid in interface ProviderService

Returns:

the Provider object having the given uuid Should get provider given Uuid

See Also:

ProviderService.getProviderByUuid(java.lang.String)

getProvidersByPerson

@Transactional(readOnly=true)
public Collection<Provider> getProvidersByPerson(Person person,
                                                                               boolean includeRetired)

Description copied from interface: ProviderService

Gets the Providers for the given person including or excluding retired.

Specified by:

getProvidersByPerson in interface ProviderService

Returns:

providers or empty collection Should return all providers by person including retired if includeRetired is true Should return all providers by person and exclude retired if includeRetired is false Should fail if person is null

See Also:

ProviderService.getProvidersByPerson(org.openmrs.Person, boolean )

getProvidersByPerson

@Transactional(readOnly=true)
public Collection<Provider> getProvidersByPerson(Person person)

Description copied from interface: ProviderService

Gets the Providers for the given person.

Specified by:

getProvidersByPerson in interface ProviderService

Returns:

providers or empty collection Should return providers for given person Should fail if person is null

See Also:

ProviderService.getProvidersByPerson(org.openmrs.Person)

getCountOfProviders

@Transactional(readOnly=true)
public Integer getCountOfProviders(String query)

Specified by:

getCountOfProviders in interface ProviderService

Returns:

Count-Integer Should exclude retired providers

See Also:

ProviderService.getCountOfProviders(java.lang.String)

getCountOfProviders

public Integer getCountOfProviders(String query,
                                   boolean includeRetired)

Description copied from interface: ProviderService

Gets the count of providers with a person name or identifier or name that matches the specified query

Specified by:

getCountOfProviders in interface ProviderService

Parameters:

query - the text to match

includeRetired - specifies whether retired providers should be include or not

Returns:

Count-Integer Should fetch number of provider matching given query Should include retired providers if includeRetired is set to true

See Also:

ProviderService.getCountOfProviders(java.lang.String, boolean)

getProviders

@Transactional(readOnly=true)
public List<Provider> getProviders(String query,
                                                                 Integer start,
                                                                 Integer length,
                                                                 Map<ProviderAttributeType,Object> attributeValues,
                                                                 boolean includeRetired)

Specified by:

getProviders in interface ProviderService

Returns:

the list of Providers given the query , current page and page length Should fetch provider with given identifier with case in sensitive Should fetch provider with given name with case in sensitive Should fetch provider by matching query string with any unVoided PersonName's Given Name Should fetch provider by matching query string with any unVoided PersonName's middleName Should fetch provider by matching query string with any unVoided Person's familyName Should not fetch provider if the query string matches with any voided Person name for that Provider Should get all visits with given attribute values Should not find any visits if none have given attribute values Should return all providers if query is empty Should find provider by identifier

See Also:

ProviderService.getProviders(String, Integer, Integer, java.util.Map, boolean)

getProviders

@Transactional(readOnly=true)
public List<Provider> getProviders(String query,
                                                                 Integer start,
                                                                 Integer length,
                                                                 Map<ProviderAttributeType,Object> attributeValues)

Specified by:

getProviders in interface ProviderService

Returns:

the list of Providers given the query , current page and page length Should fetch provider with given identifier with case in sensitive Should fetch provider with given name with case in sensitive Should fetch provider by matching query string with any unVoided PersonName's Given Name Should fetch provider by matching query string with any unVoided PersonName's middleName Should fetch provider by matching query string with any unVoided Person's familyName Should not fetch provider if the query string matches with any voided Person name for that Provider Should get all visits with given attribute values Should not find any visits if none have given attribute values Should return all providers if query is empty Should return retired providers

See Also:

ProviderService.getProviders(String, Integer, Integer, java.util.Map)

getAllProviderAttributeTypes

@Transactional(readOnly=true)
public List<ProviderAttributeType> getAllProviderAttributeTypes()

Description copied from interface: ProviderService

Gets all provider attribute types including retired provider attribute types. This method delegates to the #getAllProviderAttributeTypes(boolean) method

Specified by:

getAllProviderAttributeTypes in interface ProviderService

Returns:

a list of provider attribute type objects. Should get all provider attribute types including retired by default

See Also:

ProviderService.getAllProviderAttributeTypes()

getAllProviderAttributeTypes

@Transactional(readOnly=true)
public List<ProviderAttributeType> getAllProviderAttributeTypes(boolean includeRetired)

Description copied from interface: ProviderService

Gets all provider attribute types optionally including retired provider attribute types.

Specified by:

getAllProviderAttributeTypes in interface ProviderService

Parameters:

includeRetired - boolean value to indicate whether to include retired records or not

Returns:

a list of provider attribute type objects. Should get all provider attribute types excluding retired Should get all provider attribute types including retired

See Also:

ProviderService.getAllProviderAttributeTypes(boolean)

getProviderAttributeType

@Transactional(readOnly=true)
public ProviderAttributeType getProviderAttributeType(Integer providerAttributeTypeId)

Description copied from interface: ProviderService

Gets a provider attribute type by it's id

Specified by:

getProviderAttributeType in interface ProviderService

Parameters:

providerAttributeTypeId - the provider attribute type id

Returns:

the provider type attribute by it's id Should get provider attribute type for the given id

See Also:

ProviderService.getProviderAttributeType(java.lang.Integer)

getProviderAttributeTypeByUuid

@Transactional(readOnly=true)
public ProviderAttributeType getProviderAttributeTypeByUuid(String uuid)

Description copied from interface: ProviderService

Get a provider attribute type by its uuid

Specified by:

getProviderAttributeTypeByUuid in interface ProviderService

Parameters:

uuid - the uuid of the provider attribute type

Returns:

the provider attribute type for the given uuid Should get the provider attribute type by its uuid

See Also:

ProviderService.getProviderAttributeTypeByUuid(java.lang.String)

getProviderAttributeTypeByName

@Transactional(readOnly=true)
public ProviderAttributeType getProviderAttributeTypeByName(String name)

Description copied from interface: ProviderService

Get a provider attribute type by its name

Specified by:

getProviderAttributeTypeByName in interface ProviderService

Parameters:

name - the name of the provider attribute type

Returns:

the provider attribute type for the given name Should get the provider attribute type by its name

See Also:

ProviderService.getProviderAttributeTypeByName(String)

getProviderAttribute

@Transactional(readOnly=true)
public ProviderAttribute getProviderAttribute(Integer providerAttributeID)

Description copied from interface: ProviderService

Get a provider attribute by it's providerAttributeID

Specified by:

getProviderAttribute in interface ProviderService

Parameters:

providerAttributeID - the provider attribute ID of the providerAttribute

Returns:

the provider attribute for the given providerAttributeID Should get the provider attribute by it's providerAttributeID

See Also:

ProviderService.getProviderAttribute(java.lang.Integer)

getProviderAttributeByUuid

@Transactional(readOnly=true)
public ProviderAttribute getProviderAttributeByUuid(String uuid)

Description copied from interface: ProviderService

Get a provider attribute by its providerAttributeUuid

Specified by:

getProviderAttributeByUuid in interface ProviderService

Parameters:

uuid - the provider attribute uuid of the providerAttribute

Returns:

the provider attribute for the given providerAttributeUuid Should get the provider attribute by its providerAttributeUuid

See Also:

ProviderService.getProviderAttributeByUuid(String)

saveProviderAttributeType

public ProviderAttributeType saveProviderAttributeType(ProviderAttributeType providerAttributeType)

Description copied from interface: ProviderService

Save the provider attribute type

Specified by:

saveProviderAttributeType in interface ProviderService

Parameters:

providerAttributeType - the provider attribute type to be saved

Returns:

the saved provider attribute type Should save the provider attribute type

See Also:

ProviderService.saveProviderAttributeType(org.openmrs.ProviderAttributeType)

retireProviderAttributeType

public ProviderAttributeType retireProviderAttributeType(ProviderAttributeType providerAttributeType,
                                                         String reason)

Description copied from interface: ProviderService

Retire a provider attribute type

Specified by:

retireProviderAttributeType in interface ProviderService

Parameters:

providerAttributeType - the provider attribute type to be retired

reason - for retiring the provider attribute type

Returns:

the retired provider attribute type Should retire provider type attribute

See Also:

ProviderService.retireProviderAttributeType(org.openmrs.ProviderAttributeType, java.lang.String)

unretireProviderAttributeType

public ProviderAttributeType unretireProviderAttributeType(ProviderAttributeType providerAttributeType)

Description copied from interface: ProviderService

Un-Retire a provider attribute type

Specified by:

unretireProviderAttributeType in interface ProviderService

Parameters:

providerAttributeType - the provider type attribute to unretire

Returns:

the unretire provider attribute type Should unretire a provider attribute type

See Also:

ProviderService.unretireProviderAttributeType(org.openmrs.ProviderAttributeType)

purgeProviderAttributeType

public void purgeProviderAttributeType(ProviderAttributeType providerAttributeType)

Description copied from interface: ProviderService

Deletes a provider attribute type

Specified by:

purgeProviderAttributeType in interface ProviderService

Parameters:

providerAttributeType - provider attribute type to be deleted Should delete a provider attribute type

See Also:

ProviderService.purgeProviderAttributeType(org.openmrs.ProviderAttributeType)

isProviderIdentifierUnique

@Transactional(readOnly=true)
public boolean isProviderIdentifierUnique(Provider provider)
                                                                 throws APIException

Description copied from interface: ProviderService

Checks if the identifier for the specified provider is unique

Specified by:

isProviderIdentifierUnique in interface ProviderService

Parameters:

provider - the provider whose identifier to check

Returns:

true if the identifier is unique otherwise false

Throws:

APIException - Should return false if the identifier is a duplicate Should return true if the identifier is null Should return true if the identifier is a blank string

See Also:

ProviderService.isProviderIdentifierUnique(Provider)

getProviderByIdentifier

@Transactional(readOnly=true)
public Provider getProviderByIdentifier(String identifier)

Description copied from interface: ProviderService

Gets a provider with a matching identifier, this method performs a case insensitive search

Specified by:

getProviderByIdentifier in interface ProviderService

Parameters:

identifier - the identifier to match against

Returns:

a Provider Should get a provider matching the specified identifier ignoring case

See Also:

ProviderService.getProviderByIdentifier(java.lang.String)

getUnknownProvider

@Transactional(readOnly=true)
public Provider getUnknownProvider()

Description copied from interface: ProviderService

Gets the unknown provider account, i.e. the provider account that matches the uuid specified as the value for the global property OpenmrsConstants.GP_UNKNOWN_PROVIDER_UUID

Specified by:

getUnknownProvider in interface ProviderService

Returns:

a Provider

See Also:

ProviderService.getUnknownProvider()