OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileEntrySearchSession
Implementsosid.profile.ProfileEntryQuerySession
Description

This session provides methods for searching ProfileEntry objects. 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 a ancestor in the profile hierarchy
  • isolated profile view: searches are restricted to entries in this Profile
MethodgetProfileEntrySearch
Description

Gets a profile entry search.

Returnosid.profile.ProfileEntrySearchthe profile entry search
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntrySearchOrder
Description

Gets a profile entry search order. The ProfileEntrySearchOrder is supplied to an ProfileEntrySearch to specify the ordering of results.

Returnosid.profile.ProfileEntrySearchOrderthe profile entry search order
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntriesBySearch
Description

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

Parametersosid.profile.ProfileEntryQueryprofileEntryQuerythe profile entry query
osid.profile.ProfileEntrySearchprofileEntrySearchthe profile entry search
Returnosid.profile.ProfileEntrySearchResultsthe returned search results
ErrorsNULL_ARGUMENT profileEntryQuery or profileEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryQuery or profileEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryQueryFromInspector
Description

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

Parametersosid.profile.ProfileEntryQueryInspectorprofileEntryQueryInspectora profile entry query inspector
Returnosid.profile.ProfileEntryQuerythe profile entry query
ErrorsNULL_ARGUMENT profileEntryQueryInspector is null
UNSUPPORTED pofileEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.