org.openmrs.api

Interface ProviderService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ProviderServiceImpl

@Transactional
 @Handler(supports=Provider.class)
public interface ProviderService
extends OpenmrsService

This service contains methods relating to providers.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
java.util.List<ProviderAttributeType>	getAllProviderAttributeTypes() Gets all provider attribute types including retired provider attribute types.
java.util.List<ProviderAttributeType>	getAllProviderAttributeTypes(boolean includeRetired) Gets all provider attribute types optionally including retired provider attribute types.
java.util.List<Provider>	getAllProviders() Gets all providers.
java.util.List<Provider>	getAllProviders(boolean includeRetired) Gets all Provider
java.lang.Integer	getCountOfProviders(java.lang.String query)
java.lang.Integer	getCountOfProviders(java.lang.String query, boolean includeRetired) Gets the count of providers with a person name or identifier or name that matches the specified query
Provider	getProvider(java.lang.Integer providerId) Gets a provider by its provider id
ProviderAttribute	getProviderAttribute(java.lang.Integer providerAttributeID) Get a provider attribute by it's providerAttributeID
ProviderAttribute	getProviderAttributeByUuid(java.lang.String uuid) Get a provider attribute by it's providerAttributeUuid
ProviderAttributeType	getProviderAttributeType(java.lang.Integer providerAttributeTypeId) Gets a provider attribute type by it's id
ProviderAttributeType	getProviderAttributeTypeByUuid(java.lang.String uuid) Get a provider attribute type by it's uuid
Provider	getProviderByIdentifier(java.lang.String identifier) Gets a provider with a matching identifier, this method performs a case insensitive search
Provider	getProviderByUuid(java.lang.String uuid)
java.util.List<Provider>	getProviders(java.lang.String query, java.lang.Integer start, java.lang.Integer length, java.util.Map<ProviderAttributeType,java.lang.Object> attributes)
java.util.List<Provider>	getProviders(java.lang.String query, java.lang.Integer start, java.lang.Integer length, java.util.Map<ProviderAttributeType,java.lang.Object> attributes, boolean includeRetired)
java.util.Collection<Provider>	getProvidersByPerson(Person person) Gets the Providers for the given person.
java.util.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.
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, java.lang.String reason) Retires a given Provider
ProviderAttributeType	retireProviderAttributeType(ProviderAttributeType providerAttributeType, java.lang.String reason) Retire a provider attribute type
Provider	saveProvider(Provider provider)
ProviderAttributeType	saveProviderAttributeType(ProviderAttributeType providerAttributeType) Save the provider attribute type
Provider	unretireProvider(Provider provider) Unretire a given Provider
ProviderAttributeType	unretireProviderAttributeType(ProviderAttributeType providerAttributeType) Un-Retire a provider attribute type

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getAllProviders

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.util.List<Provider> getAllProviders()

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

Returns:

a list of provider objects.

getAllProviders

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.util.List<Provider> getAllProviders(boolean includeRetired)

Gets all Provider

Parameters:

includeRetired - - whether or not to include retired Provider

retireProvider

@Authorized(value="Manage Providers")
void retireProvider(Provider provider,
                                                          java.lang.String reason)

Retires a given Provider

Parameters:

Provider - provider to retire

String - reason why the provider is retired

unretireProvider

@Authorized(value="Manage Providers")
Provider unretireProvider(Provider provider)

Unretire a given Provider

Parameters:

Provider - provider to unretire

purgeProvider

@Authorized(value="Purge Providers")
void purgeProvider(Provider provider)

Deletes a given Provider

Parameters:

Provider - provider to be deleted

getProvider

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
Provider getProvider(java.lang.Integer providerId)

Gets a provider by its provider id

Parameters:

providerId - the provider id

Returns:

the provider by it's id

saveProvider

@Authorized(value="Manage Providers")
Provider saveProvider(Provider provider)

Parameters:

provider -

Returns:

the Provider object after saving it in the database

getProviderByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
Provider getProviderByUuid(java.lang.String uuid)

Parameters:

string -

Returns:

the Provider object having the given uuid

getProvidersByPerson

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.util.Collection<Provider> getProvidersByPerson(Person person)

Gets the Providers for the given person.

Parameters:

person -

Returns:

providers or empty collection

getProvidersByPerson

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.util.Collection<Provider> getProvidersByPerson(Person person,
                                                                                                                       boolean includeRetired)

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

Parameters:

person -

includeRetired -

Returns:

providers or empty collection

Since:

1.10, 1.9.1

getProviders

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.util.List<Provider> getProviders(java.lang.String query,
                                                                                                         java.lang.Integer start,
                                                                                                         java.lang.Integer length,
                                                                                                         java.util.Map<ProviderAttributeType,java.lang.Object> attributes,
                                                                                                         boolean includeRetired)

Parameters:

query -

start -

length -

attributes -

includeRetired -

Returns:

the list of Providers given the query , current page and page length

getProviders

@Authorized(value="View Providers")
java.util.List<Provider> getProviders(java.lang.String query,
                                                                          java.lang.Integer start,
                                                                          java.lang.Integer length,
                                                                          java.util.Map<ProviderAttributeType,java.lang.Object> attributes)

Parameters:

query -

start -

length -

attributes -

Returns:

the list of Providers given the query , current page and page length

getCountOfProviders

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
java.lang.Integer getCountOfProviders(java.lang.String query)

Parameters:

query -

Returns:

Count-Integer

getCountOfProviders

@Authorized(value="View Providers")
java.lang.Integer getCountOfProviders(java.lang.String query,
                                                                          boolean includeRetired)

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

Parameters:

query - the text to match

includeRetired - specifies whether retired providers should be include or not

Returns:

Count-Integer

Since:

1.9.4

getAllProviderAttributeTypes

@Transactional(readOnly=true)
java.util.List<ProviderAttributeType> getAllProviderAttributeTypes()

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

Returns:

a list of provider attribute type objects.

getAllProviderAttributeTypes

@Transactional(readOnly=true)
java.util.List<ProviderAttributeType> getAllProviderAttributeTypes(boolean includeRetired)

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

Parameters:

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

Returns:

a list of provider attribute type objects.

getProviderAttributeType

ProviderAttributeType getProviderAttributeType(java.lang.Integer providerAttributeTypeId)

Gets a provider attribute type by it's id

Parameters:

providerAttributeTypeId - the provider attribute type id

Returns:

the provider type attribute by it's id

getProviderAttributeTypeByUuid

ProviderAttributeType getProviderAttributeTypeByUuid(java.lang.String uuid)

Get a provider attribute type by it's uuid

Parameters:

uuid - the uuid of the provider attribute type

Returns:

the provider attribute type for the given uuid

getProviderAttribute

ProviderAttribute getProviderAttribute(java.lang.Integer providerAttributeID)

Get a provider attribute by it's providerAttributeID

Parameters:

providerAttributeID - the provider attribute ID of the providerAttribute

Returns:

the provider attribute for the given providerAttributeID

getProviderAttributeByUuid

ProviderAttribute getProviderAttributeByUuid(java.lang.String uuid)

Get a provider attribute by it's providerAttributeUuid

Parameters:

uuid - the provider attribute uuid of the providerAttribute

Returns:

the provider attribute for the given providerAttributeUuid

saveProviderAttributeType

ProviderAttributeType saveProviderAttributeType(ProviderAttributeType providerAttributeType)

Save the provider attribute type

Parameters:

providerAttributeType - the provider attribute type to be saved

Returns:

the saved provider attribute type

retireProviderAttributeType

ProviderAttributeType retireProviderAttributeType(ProviderAttributeType providerAttributeType,
                                                  java.lang.String reason)

Retire a provider attribute type

Parameters:

providerAttributeType - the provider attribute type to be retired

reason - for retiring the provider attribute type

Returns:

the retired provider attribute type

unretireProviderAttributeType

ProviderAttributeType unretireProviderAttributeType(ProviderAttributeType providerAttributeType)

Un-Retire a provider attribute type

Parameters:

providerAttributeType - the provider type attribute to unretire

Returns:

the unretire provider attribute type

purgeProviderAttributeType

void purgeProviderAttributeType(ProviderAttributeType providerAttributeType)

Deletes a provider attribute type

Parameters:

providerAttributeType - provider attribute type to be deleted

isProviderIdentifierUnique

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
boolean isProviderIdentifierUnique(Provider provider)
                                                                                               throws APIException

Checks if the identifier for the specified provider is unique

Parameters:

provider - the provider whose identifier to check

Returns:

true if the identifier is unique otherwise false

Throws:

APIException

getProviderByIdentifier

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
Provider getProviderByIdentifier(java.lang.String identifier)

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

Parameters:

identifier - the identifier to match against

Returns:

a Provider

getUnknownProvider

@Transactional(readOnly=true)
 @Authorized(value="View Providers")
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

Returns:

a Provider

Since:

1.10