OSID - osid.profile.ProfileSearchSession Service Interface Definition

Interface	osid.profile.ProfileSearchSession
Implements	`osid.profile.ProfileQuerySession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session provides methods for searching among `Profiles`. The search query is constructed using the `ProfileQuery`. `getProfilesByQuery()` is the basic search method and returns a list of `Profile` objects.A more advanced search may be performed with `getProfilesBySearch()`.It accepts a `ProfileSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProfilesBySearch()` returns a `ProfileSearchResults` that can be used to access the resulting `ProfileList` or be used to perform a search within the result set through `ProfileSearch`. Profiles may have a profile query record indicated by their respective record types. The profile query record is accessed via the `ProfileQuery`.
Method	getProfileSearch
Description	Gets a profile search.
Return	`osid.profile.ProfileSearch`		a profile search
Compliance	`mandatory`		This method must be implemented.
Method	getProfileSearchOrder
Description	Gets a profile search order. The `ProfileSearchOrder` is supplied to a `ProfileSearch` to specify the ordering of results.
Return	`osid.profile.ProfileSearchOrder`		the profile search order
Compliance	`mandatory`		This method must be implemented.
Method	getProfilesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.profile.ProfileQuery`	`profileQuery`	the profile query
Parameters	`osid.profile.ProfileSearch`	`profileSearch`	the profile search
Return	`osid.profile.ProfileSearchResults`		the search results
Errors	NULL_ARGUMENT		`profileQuery` or `profileSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileQuery` or `profileSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileQueryFromInspector
Description	Gets a profile query from an inspector. The inspector is available from an `ProfileSearchResults`.
Parameters	`osid.profile.ProfileQueryInspector`	`profileQueryInspector`	a profile query inspector
Return	`osid.profile.ProfileQuery`		the profile query
Errors	NULL_ARGUMENT		`profileQueryInspector` is `null`
Errors	UNSUPPORTED		`profileQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.