OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileItemSearchSession
Implementsosid.profile.ProfileItemQuerySession
Description

This session provides methods for searching ProfileItem objects. The search query is constructed using the ProfileItemQuery. The profile item record Type also specifies the query record for the profile item query.

getProfileItemsByQuery() is the basic search method and returns a list of ProfileItems. A more advanced search may be performed with getProfileItemsBySearch(). It accepts a ProfileItemSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProfileItemsBySearch() returns an ProfileItemSearchResults that can be used to access the resulting ProfileItemList or be used to perform a search within the result set through ProfileItemSearch.

This session defines views that offer differing behaviors for searching.

  • federated profile view: searches include profile item in profiles of which this profile is a ancestor in the profile hierarchy
  • isolated profile view: searches are restricted to profile items in this profile

Profile items may have a profie item query record indicated by their respective record types. The profile item query record is accessed via the ProfileItemQuery.

MethodgetProfileItemSearch
Description

Gets a profile item search.

Returnosid.profile.ProfileItemSearchthe profile item search
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemSearchOrder
Description

Gets a profile item search order. The ProfileItemSearchOrder is supplied to a ProfileItemSearch to specify the ordering of results.

Returnosid.profile.ProfileItemSearchOrderthe profile item search order
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemsBySearch
Description

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

Parametersosid.profile.ProfileItemQueryprofileItemQuerythe profile item query
osid.profile.ProfileItemSearchprofileItemSearchthe profile item search
Returnosid.profile.ProfileItemSearchResultsthe returned search results
ErrorsNULL_ARGUMENT profileItemQuery or profileItemSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileItemSearch or profileItemQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemQueryFromInspector
Description

Gets a profile item query from an inspector. The inspector is available from an ProfileItemSearchResults.

Parametersosid.profile.ProfileItemQueryInspectorprofileItemQueryInspectora profile item query inspector
Returnosid.profile.ProfileItemQuerythe profile item query
ErrorsNULL_ARGUMENT profileItemQueryInspector is null
UNSUPPORTED profileItemQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.