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

This session provides methods for searching ProfileEntry objects. The search query is constructed using the ProfileEntryQuery.

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
MethodgetProfileId
Description

Gets the Profile Id associated with this session.

Returnosid.id.Idthe Profile Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProfile
Description

Gets the Profile associated with this session.

Returnosid.profile.Profilethe Profile associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchProfileEntries
Description

Tests if this user can perform profile entry searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedProfileView
Description

Federates the view for methods in this session. A federated view will include profile entries in profiles which are children of this profile in the profile hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedProfileView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this profile only.

CompliancemandatoryThis method is must be implemented.
MethoduseImplicitProfileEntryView
Description

Sets the view for methods in this session to implicit profile entry. An implicit view will include entries derived from other profile entries as a result of the ProfileItem or Resource hierarchies. This method is the opposite of explicitProfileEntryView().

CompliancemandatoryThis method is must be implemented.
MethoduseExplicitProfileEntryView
Description

Sets the view for methods in this session to explicit proffile entries. An explicit view includes only those entries that were explicitly defined and not implied. This method is the opposite of implicitProfileEntryView().

CompliancemandatoryThis method is must be implemented.
MethodgetProfileEntryQuery
Description

Gets a profile entry query.

Returnosid.profile.ProfileEntryQuerythe profile entry query
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntriesByQuery
Description

Gets a list of ProfileEntries matching the given query

Parametersosid.profile.ProfileEntryQueryprofileEntryQuerythe profile entry query
Returnosid.profile.ProfileEntryListthe returned ProfileEntryList
ErrorsNULL_ARGUMENT profileEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryQuery is not of this service
CompliancemandatoryThis method must be implemented.