Skip to content

Commit

Permalink
TRUNK-6189: Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ibacher committed Oct 20, 2023
1 parent eadc438 commit 8e623ba
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions api/src/main/java/org/openmrs/api/ProviderService.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,13 @@ public interface ProviderService extends OpenmrsService {
* @return a list of provider objects.
* <strong>Should</strong> get all providers
*/

@Authorized( { PrivilegeConstants.GET_PROVIDERS })
public List<Provider> getAllProviders();

/**
* Gets all Provider
* Gets all providers
*
* @param includeRetired - whether or not to include retired Provider
* @param includeRetired - if true, retired providers are also included
* <strong>Should</strong> get all providers that are unretired
*/
@Authorized( { PrivilegeConstants.GET_PROVIDERS })
Expand Down Expand Up @@ -225,21 +224,21 @@ public List<Provider> getProviders(String query, Integer start, Integer length,
public ProviderAttributeType getProviderAttributeType(Integer providerAttributeTypeId);

/**
* Get a provider attribute type by it's uuid
* Get a provider attribute type by its uuid
*
* @param uuid the uuid of the provider attribute type
* @return the provider attribute type for the given uuid
* <strong>Should</strong> get the provider attribute type by it's uuid
* <strong>Should</strong> get the provider attribute type by its uuid
*/
public ProviderAttributeType getProviderAttributeTypeByUuid(String uuid);

/**
* Get a provider attribute type by it's name
* Get a provider attribute type by its name
*
* @param name the name of the provider attribute type
* @return the provider attribute type for the given name
* <strong>Should</strong> get the provider attribute type by it's name
* @since 2.7.0
* <strong>Should</strong> get the provider attribute type by its name
* @since 2.7.0, 2.6.3
*/
@Authorized({PrivilegeConstants.GET_PROVIDER_ATTRIBUTE_TYPES})
public ProviderAttributeType getProviderAttributeTypeByName(String name);
Expand All @@ -254,11 +253,11 @@ public List<Provider> getProviders(String query, Integer start, Integer length,
public ProviderAttribute getProviderAttribute(Integer providerAttributeID);

/**
* Get a provider attribute by it's providerAttributeUuid
* Get a provider attribute by its providerAttributeUuid
*
* @param uuid the provider attribute uuid of the providerAttribute
* @return the provider attribute for the given providerAttributeUuid
* <strong>Should</strong> get the provider attribute by it's providerAttributeUuid
* <strong>Should</strong> get the provider attribute by its providerAttributeUuid
*/
public ProviderAttribute getProviderAttributeByUuid(String uuid);

Expand Down

0 comments on commit 8e623ba

Please sign in to comment.