OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.OrganizationSearchSession
Implementsosid.personnel.OrganizationQuerySession
Description

This session provides methods for searching Organization objects. The search query is constructed using the OrganizationQuery. The organization record Type also specifies the record for the organization query.

getOrganizationsByQuery() is the basic search method and returns a list of Organization elements. A more advanced search may be performed with getOrganizationsBySearch(). It accepts an OrganizationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOrganizationsBySearch() returns an OrganizationSearchResults that can be used to access the resulting OrganizationList or be used to perform a search within the result set through OrganizationSearch.

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include organizations in realms of which this realm is a ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to organizations in this realm

Organizations may have a query record indicated by their respective record types. The query record is accessed via the OrganizationQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetOrganizationSearch
Description

Gets an organization search.

Returnosid.personnel.OrganizationSearchthe organization search
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationSearchOrder
Description

Gets an organization search order. The OrganizationSearchOrder is supplied to an OrganizationSearch to specify the ordering of results.

Returnosid.personnel.OrganizationSearchOrderthe organization search order
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationsBySearch
Description

Gets the search results matching the given search.

Parametersosid.personnel.OrganizationQueryorganizationQuerythe organization query
osid.personnel.OrganizationSearchorganizationSearchthe organization search
Returnosid.personnel.OrganizationSearchResultsthe search results
ErrorsNULL_ARGUMENT organizationQuery or organizationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED organizationQuery or organizationSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationQueryFromInspector
Description

Gets an organization query from an inspector. The inspector is available from an OrganizationSearchResults.

Parametersosid.personnel.OrganizationQueryInspectororganizationQueryInspectoran organization query inspector
Returnosid.personnel.OrganizationQuerythe organization query
ErrorsNULL_ARGUMENT organizationQueryInspector is null
UNSUPPORTED organizationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.