OSID - osid.profile.ProfileEntrySearchSession Service Interface Definition

Interface	osid.profile.ProfileEntrySearchSession
Implements	`osid.profile.ProfileEntryQuerySession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session provides methods for searching `ProfileEntries` . The search query is constructed using the `ProfileEntryQuery` . `getProfileEntriesByQuery()` is the basic search method and returns a list of `ProfileEntries` . A more advanced search may be performed with `getProfileEntriesBySearch()` .It accepts an `ProfileEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProfileEntriesBySearch()` returns an `ProfileEntrySearchResults` that can be used to access the resulting `ProfileEntryList` or be used to perform a search within the result set through `ProfileEntrySearch` . This session defines views that offer differing behaviors for searching. federated profile view: searches include profile entries in `Profiles` of which this profile is an ancestor in the profile hierarchy isolated profile view: searches are restricted to entries in this `Profile`
Method	getProfileEntrySearch
Description	Gets a profile entry search.
Return	`osid.profile.ProfileEntrySearch`		the profile entry search
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntrySearchOrder
Description	Gets a profile entry search order. The `ProfileEntrySearchOrder` is supplied to an `ProfileEntrySearch` to specify the ordering of results.
Return	`osid.profile.ProfileEntrySearchOrder`		the profile entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.profile.ProfileEntryQuery`	`profileEntryQuery`	the profile entry query
Parameters	`osid.profile.ProfileEntrySearch`	`profileEntrySearch`	the profile entry search
Return	`osid.profile.ProfileEntrySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`profileEntryQuery` or `profileEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryQuery` or `profileEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryQueryFromInspector
Description	Gets a profile entry query from an inspector. The inspector is available from an `PofileEntrySearchResults` .
Parameters	`osid.profile.ProfileEntryQueryInspector`	`profileEntryQueryInspector`	a profile entry query inspector
Return	`osid.profile.ProfileEntryQuery`		the profile entry query
Errors	NULL_ARGUMENT		`profileEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`pofileEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.