OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerSearchSession
Implementsosid.profile.rules.ProfileEntryEnablerQuerySession
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.

MethodgetProfileEntryEnablerSearch
Description

Gets a profile entry enabler search.

Returnosid.profile.rules.ProfileEntryEnablerSearchthe profile entry enabler search
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerSearchOrder
Description

Gets a profile entry enabler search order. The ProfileEntryEnablerSearchOrder is supplied to a ProfileEntryEnablerSearch to specify the ordering of results.

Returnosid.profile.rules.ProfileEntryEnablerSearchOrderthe profile entry enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.profile.rules.ProfileEntryEnablerQueryprofileEntryEnablerQuerythe profile entry enabler query
osid.profile.rules.ProfileEntryEnablerSearchprofileEntryEnablerSearchthe profile entry enabler search
Returnosid.profile.rules.ProfileEntryEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT profileEntryEnablerQuery or profileEntryEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryEnablerQuery or profileEntryEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerQueryFromInspector
Description

Gets a profile entry enabler query from an inspector. The inspector is available from a ProfileEntryEnablerSearchResults.

Parametersosid.profile.rules.ProfileEntryEnablerQueryInspectorprofileEntryEnablerQueryInspectora profile entry enabler query inspector
Returnosid.profile.rules.ProfileEntryEnablerQuerythe profile entry enabler query
ErrorsNULL_ARGUMENT profileEntryEnablerQueryInspector is null
UNSUPPORTED profileEntryEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.