OSID - osid.personnel.RealmSearchSession Service Interface Definition

Interface	osid.personnel.RealmSearchSession
Implements	`osid.personnel.RealmQuerySession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session provides methods for searching `Realm` objects. The search query is constructed using the `RealmQuery` . The realm record `Type` also specifies the realm query record for the realm query. `getRealmsByQuery()` is the basic search method and returns a list of `Realm` elements. A more advanced search may be performed with `getRealmsBySearch()` . It accepts a `RealmSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRealmsBySearch()` returns a `RealmSearchResults` that can be used to access the resulting `RealmList` or be used to perform a search within the result set through `RealmSearch` . Realms may have a query record indicated by their respective record types. The query record is accessed via the `RealmQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getRealmSearch
Description	Gets a realm search.
Return	`osid.personnel.RealmSearch`		the realm search
Compliance	`mandatory`		This method must be implemented.
Method	getRealmSearchOrder
Description	Gets a realm search order. The `RealmSearchOrder` is supplied to a `RealmSearch` to specify the ordering of results.
Return	`osid.personnel.RealmSearchOrder`		the realm search order
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.personnel.RealmQuery`	`realmQuery`	the realm query
Parameters	`osid.personnel.RealmSearch`	`realmSearch`	the realm search
Return	`osid.personnel.RealmSearchResults`		the search results
Errors	NULL_ARGUMENT		`realmQuery` or `realmSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`realmQuery` or `realmSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQueryFromInspector
Description	Gets a realm query from an inspector. The inspector is available from a `RealmSearchResults` .
Parameters	`osid.personnel.RealmQueryInspector`	`realmQueryInspector`	a realm query inspector
Return	`osid.personnel.RealmQuery`		the realm query
Errors	NULL_ARGUMENT		`realmQueryInspector` is `null`
Errors	UNSUPPORTED		`irealmQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.