OSID - osid.personnel.PersonSearchSession Service Interface Definition

Interface	osid.personnel.PersonSearchSession
Implements	`osid.personnel.PersonQuerySession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
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 an 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.
Method	getPersonSearch
Description	Gets a person search.
Return	`osid.personnel.PersonSearch`		the person search
Compliance	`mandatory`		This method must be implemented.
Method	getPersonSearchOrder
Description	Gets a person search order. The `PersonSearchOrder` is supplied to a `PersonSearch` to specify the ordering of results.
Return	`osid.personnel.PersonSearchOrder`		the person search order
Compliance	`mandatory`		This method must be implemented.
Method	getPersonsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.personnel.PersonQuery`	`personQuery`	the person query
Parameters	`osid.personnel.PersonSearch`	`personSearch`	the person search
Return	`osid.personnel.PersonSearchResults`		the search results
Errors	NULL_ARGUMENT		`personQuery` or `personSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`personQuery` or `personSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPersonQueryFromInspector
Description	Gets a person query from an inspector. The inspector is available from a `PersonSearchResults` .
Parameters	`osid.personnel.PersonQueryInspector`	`personQueryInspector`	a person query inspector
Return	`osid.personnel.PersonQuery`		the person query
Errors	NULL_ARGUMENT		`personQueryInspector` is `null`
Errors	UNSUPPORTED		`personQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.