com.sas.hls.organization
Interface OrganizationService


public interface OrganizationService

This service provides the methods required to get information about organizations defined in SAS Drug Development.


Method Summary
 Organization getOrganizationByIdentifier(String identifier)
          Get the representation of an organization, given its identifier.
 Organization getOrganizationByName(String name)
          Get the full client representation of an organization, given its name.
 OrganizationDescriptor getOrganizationDescriptorByIdentifier(String identifier)
          Get the light-weight client representation of an organization, given its identifier.
 OrganizationDescriptor getOrganizationDescriptorByName(String name)
          Get the light-weight client representation of an organization, given its name..
 List<OrganizationDescriptor> getOrganizationDescriptors()
          Get a list of light-weight representations of all organizations currently defined.
 List<Organization> getOrganizations()
          Get the list of all organizations currently defined in the system.
 

Method Detail

getOrganizationByName

Organization getOrganizationByName(String name)
                                   throws OrganizationNotFoundException
Get the full client representation of an organization, given its name.

Parameters:
name - The name of the organization desired.
Returns:
The full client representation of the organization.
Throws:
OrganizationNotFoundException - The specified organization was not found.

getOrganizationDescriptorByIdentifier

OrganizationDescriptor getOrganizationDescriptorByIdentifier(String identifier)
                                                             throws OrganizationNotFoundException
Get the light-weight client representation of an organization, given its identifier.

Parameters:
identifier - The identifier of the organization descriptor desired.
Returns:
The light-weight client representation of the organization.
Throws:
OrganizationNotFoundException - The specified organization was not found.

getOrganizationByIdentifier

Organization getOrganizationByIdentifier(String identifier)
                                         throws OrganizationNotFoundException
Get the representation of an organization, given its identifier.

Parameters:
identifier - The identifier of the organization descriptor desired.
Returns:
The light-weight client representation of the organization.
Throws:
OrganizationNotFoundException - The specified organization was not found.

getOrganizationDescriptorByName

OrganizationDescriptor getOrganizationDescriptorByName(String name)
                                                       throws OrganizationNotFoundException
Get the light-weight client representation of an organization, given its name..

Parameters:
name - The name of the organization descriptor desired.
Returns:
The light-weight client representation of the organization.
Throws:
OrganizationNotFoundException - The specified organization was not found.

getOrganizations

List<Organization> getOrganizations()
Get the list of all organizations currently defined in the system.

Returns:
A list all organizations currently defined in the system.

getOrganizationDescriptors

List<OrganizationDescriptor> getOrganizationDescriptors()
Get a list of light-weight representations of all organizations currently defined.

Returns:
A list of all organization descriptors currently defined.


Copyright (c) 2013, SAS Institute Inc., Cary, NC, USA