OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonSearchSession
Implementsosid.personnel.PersonQuerySession
Description

This session provides methods for searching Person objects. The search query is constructed using the PersonQuery. The person record Type also specifies the record for the person query.

getPersonsByQuery() is the basic search method and returns a list of Person elements. A more advanced search may be performed with getPersonsBySearch(). It accepts a PersonSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPersonsBySearch() returns a PersonSearchResults that can be used to access the resulting PersonList or be used to perform a search within the result set through PersonSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetPersonSearch
Description

Gets a person search.

Returnosid.personnel.PersonSearchthe person search
CompliancemandatoryThis method must be implemented.
MethodgetPersonSearchOrder
Description

Gets a person search order. The PersonSearchOrder is supplied to a PersonSearch to specify the ordering of results.

Returnosid.personnel.PersonSearchOrderthe person search order
CompliancemandatoryThis method must be implemented.
MethodgetPersonsBySearch
Description

Gets the search results matching the given search.

Parametersosid.personnel.PersonQuerypersonQuerythe person query
osid.personnel.PersonSearchpersonSearchthe person search
Returnosid.personnel.PersonSearchResultsthe search results
ErrorsNULL_ARGUMENT personQuery or personSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED personQuery or personSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPersonQueryFromInspector
Description

Gets a person query from an inspector. The inspector is available from a PersonSearchResults.

Parametersosid.personnel.PersonQueryInspectorpersonQueryInspectora person query inspector
Returnosid.personnel.PersonQuerythe person query
ErrorsNULL_ARGUMENT personQueryInspector is null
UNSUPPORTED personQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.