OSID - osid.profile.ProfileItemSearchSession Service Interface Definition

Interface	osid.profile.ProfileItemSearchSession
Implements	`osid.profile.ProfileItemQuerySession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session provides methods for searching `ProfileItems` . The search query is constructed using the `ProfileItemQuery` . The profile item record `Type` also specifies the query record for the profile item query. `getProfileItemsByQuery()` is the basic search method and returns a list of `ProfileItems` . A more advanced search may be performed with `getProfileItemsBySearch()` .It accepts a `ProfileItemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProfileItemsBySearch()` returns an `ProfileItemSearchResults` that can be used to access the resulting `ProfileItemList` or be used to perform a search within the result set through `ProfileItemSearch` . This session defines views that offer differing behaviors for searching. federated profile view: searches include profile item in profiles of which this profile is an ancestor in the profile hierarchy isolated profile view: searches are restricted to profile items in this profile Profile items may have a profie item query record indicated by their respective record types. The profile item query record is accessed via the `ProfileItemQuery` .
Method	getProfileItemSearch
Description	Gets a profile item search.
Return	`osid.profile.ProfileItemSearch`		the profile item search
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemSearchOrder
Description	Gets a profile item search order. The `ProfileItemSearchOrder` is supplied to a `ProfileItemSearch` to specify the ordering of results.
Return	`osid.profile.ProfileItemSearchOrder`		the profile item search order
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.profile.ProfileItemQuery`	`profileItemQuery`	the profile item query
Parameters	`osid.profile.ProfileItemSearch`	`profileItemSearch`	the profile item search
Return	`osid.profile.ProfileItemSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`profileItemQuery` or `profileItemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileItemSearch` or `profileItemQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemQueryFromInspector
Description	Gets a profile item query from an inspector. The inspector is available from an `ProfileItemSearchResults` .
Parameters	`osid.profile.ProfileItemQueryInspector`	`profileItemQueryInspector`	a profile item query inspector
Return	`osid.profile.ProfileItemQuery`		the profile item query
Errors	NULL_ARGUMENT		`profileItemQueryInspector` is `null`
Errors	UNSUPPORTED		`profileItemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.