OSID - osid.profile.rules.ProfileEntryEnablerSearchSession Service Interface Definition

Interface	osid.profile.rules.ProfileEntryEnablerSearchSession
Implements	`osid.profile.rules.ProfileEntryEnablerQuerySession`
Used By	`osid.profile.rules.ProfileRulesManager`
Used By	`osid.profile.rules.ProfileRulesProxyManager`
Description	This session provides methods for searching among `ProfileEntryEnabler` objects. The search query is constructed using the `ProfileEntryEnableryQuery` . `getProfileEntryEnablersByQuery()` is the basic search method and returns a list of `ProfileEntryEnablers` . A more advanced search may be performed with `getProfileEntryEnablersBySearch()` . It accepts a `ProfileEntryEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProfileEntryEnablersBySearch()` returns a `ProfileEntryEnablerSearchResults` that can be used to access the resulting `ProfileEntryEnablerList` or be used to perform a search within the result set through `ProfileEntryEnablerSearch` . This session defines views that offer differing behaviors for searching. federated profile view: searches include profile entry enablers in profiles of which this profile is an ancestor in the profile hierarchy isolated profile view: searches are restricted to profile entry enablers in this profile `ProfileEntryEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ProfileEntryEnablerQuery` .
Method	getProfileEntryEnablerSearch
Description	Gets a profile entry enabler search.
Return	`osid.profile.rules.ProfileEntryEnablerSearch`		the profile entry enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablerSearchOrder
Description	Gets a profile entry enabler search order. The `ProfileEntryEnablerSearchOrder` is supplied to a `ProfileEntryEnablerSearch` to specify the ordering of results.
Return	`osid.profile.rules.ProfileEntryEnablerSearchOrder`		the profile entry enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.profile.rules.ProfileEntryEnablerQuery`	`profileEntryEnablerQuery`	the profile entry enabler query
Parameters	`osid.profile.rules.ProfileEntryEnablerSearch`	`profileEntryEnablerSearch`	the profile entry enabler search
Return	`osid.profile.rules.ProfileEntryEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`profileEntryEnablerQuery` or `profileEntryEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryEnablerQuery` or `profileEntryEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablerQueryFromInspector
Description	Gets a profile entry enabler query from an inspector. The inspector is available from a `ProfileEntryEnablerSearchResults` .
Parameters	`osid.profile.rules.ProfileEntryEnablerQueryInspector`	`profileEntryEnablerQueryInspector`	a profile entry enabler query inspector
Return	`osid.profile.rules.ProfileEntryEnablerQuery`		the profile entry enabler query
Errors	NULL_ARGUMENT		`profileEntryEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`profileEntryEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.