ProviderService (OpenMRS 2.7.0-SNAPSHOT API)

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ProviderServiceImpl
```
@Handler(supports=Provider.class)
public interface ProviderService
extends OpenmrsService
```
This service contains methods relating to providers.

Since:

1.9

Method Summary

All Methods Instance Methods Abstract Methods
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.
`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> attributes)`
`List<Provider>`	`getProviders(String query, Integer start, Integer length, Map<ProviderAttributeType,Object> attributes, 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.
`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
`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
```
@Authorized(value="Get Providers")
List<Provider> getAllProviders()
```
    Gets all providers. includes retired Provider.This method delegates to the #getAllProviders(boolean) method
    
    Returns:
    
    a list of provider objects. Should get all providers
  - getAllProviders
```
@Authorized(value="Get Providers")
List<Provider> getAllProviders(boolean includeRetired)
```
    Gets all providers
    
    Parameters:
    
    includeRetired - - if true, retired providers are also included Should get all providers that are unretired
  - retireProvider
```
@Authorized(value="Manage Providers")
void retireProvider(Provider provider,
                                                          String reason)
```
    Retires a given Provider
    
    Parameters:
    
    provider - provider to retire
    
    reason - reason why the provider is retired Should retire a provider
  - unretireProvider
```
@Authorized(value="Manage Providers")
Provider unretireProvider(Provider provider)
```
    Unretire a given Provider
    
    Parameters:
    
    provider - provider to unretire Should unretire a provider
  - purgeProvider
```
@Authorized(value="Purge Providers")
void purgeProvider(Provider provider)
```
    Deletes a given Provider
    
    Parameters:
    
    provider - provider to be deleted Should delete a provider
  - getProvider
```
@Authorized(value="Get Providers")
Provider getProvider(Integer providerId)
```
    Gets a provider by its provider id
    
    Parameters:
    
    providerId - the provider id
    
    Returns:
    
    the provider by it's id Should get provider given ID
  - saveProvider
```
@Authorized(value="Manage Providers")
Provider saveProvider(Provider provider)
```
    Parameters:
    
    provider -
    
    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
  - getProviderByUuid
```
@Authorized(value="Get Providers")
Provider getProviderByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    the Provider object having the given uuid Should get provider given Uuid
  - getProvidersByPerson
```
@Authorized(value="Get Providers")
Collection<Provider> getProvidersByPerson(Person person)
```
    Gets the Providers for the given person.
    
    Parameters:
    
    person -
    
    Returns:
    
    providers or empty collection Should return providers for given person Should fail if person is null
  - getProvidersByPerson
```
@Authorized(value="Get Providers")
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 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
    
    Since:
    
    1.10, 1.9.1
  - getProviders
```
@Authorized(value="Get Providers")
List<Provider> getProviders(String query,
                                                               Integer start,
                                                               Integer length,
                                                               Map<ProviderAttributeType,Object> attributes,
                                                               boolean includeRetired)
```
    Parameters:
    
    query -
    
    start -
    
    length -
    
    attributes -
    
    includeRetired -
    
    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
  - getProviders
```
@Authorized(value="Get Providers")
List<Provider> getProviders(String query,
                                                               Integer start,
                                                               Integer length,
                                                               Map<ProviderAttributeType,Object> attributes)
```
    Parameters:
    
    query -
    
    start -
    
    length -
    
    attributes -
    
    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
  - getCountOfProviders
```
@Authorized(value="Get Providers")
Integer getCountOfProviders(String query)
```
    Parameters:
    
    query -
    
    Returns:
    
    Count-Integer Should exclude retired providers
  - getCountOfProviders
```
@Authorized(value="Get Providers")
Integer getCountOfProviders(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 Should fetch number of provider matching given query Should include retired providers if includeRetired is set to true
    
    Since:
    
    1.9.4
  - getAllProviderAttributeTypes
```
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. Should get all provider attribute types including retired by default
  - getAllProviderAttributeTypes
```
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. Should get all provider attribute types excluding retired Should get all provider attribute types including retired
  - getProviderAttributeType
```
ProviderAttributeType getProviderAttributeType(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 Should get provider attribute type for the given id
  - getProviderAttributeTypeByUuid
```
ProviderAttributeType getProviderAttributeTypeByUuid(String uuid)
```
    Get a provider attribute type by its uuid
    
    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
  - getProviderAttributeTypeByName
```
@Authorized(value="Get Provider Attribute Types")
ProviderAttributeType getProviderAttributeTypeByName(String name)
```
    Get a provider attribute type by its name
    
    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
    
    Since:
    
    2.7.0, 2.6.3
  - getProviderAttribute
```
ProviderAttribute getProviderAttribute(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 Should get the provider attribute by it's providerAttributeID
  - getProviderAttributeByUuid
```
ProviderAttribute getProviderAttributeByUuid(String uuid)
```
    Get a provider attribute by its providerAttributeUuid
    
    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
  - 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 Should save the provider attribute type
  - retireProviderAttributeType
```
ProviderAttributeType retireProviderAttributeType(ProviderAttributeType providerAttributeType,
                                                  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 Should retire provider type attribute
  - 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 Should unretire a provider attribute type
  - purgeProviderAttributeType
```
void purgeProviderAttributeType(ProviderAttributeType providerAttributeType)
```
    Deletes a provider attribute type
    
    Parameters:
    
    providerAttributeType - provider attribute type to be deleted Should delete a provider attribute type
  - isProviderIdentifierUnique
```
@Authorized(value="Get 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 - 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
  - getProviderByIdentifier
```
@Authorized(value="Get Providers")
Provider getProviderByIdentifier(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 Should get a provider matching the specified identifier ignoring case
  - getUnknownProvider
```
@Authorized(value="Get 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 Should get the unknown provider account

Interface ProviderService

Method Summary

Methods inherited from interface org.openmrs.api.OpenmrsService

Method Detail

getAllProviders

getAllProviders

retireProvider

unretireProvider

purgeProvider

getProvider

saveProvider

getProviderByUuid

getProvidersByPerson

getProvidersByPerson

getProviders

getProviders

getCountOfProviders

getCountOfProviders

getAllProviderAttributeTypes

getAllProviderAttributeTypes

getProviderAttributeType

getProviderAttributeTypeByUuid

getProviderAttributeTypeByName

getProviderAttribute

getProviderAttributeByUuid

saveProviderAttributeType

retireProviderAttributeType

unretireProviderAttributeType

purgeProviderAttributeType

isProviderIdentifierUnique

getProviderByIdentifier

getUnknownProvider