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

This session provides methods for searching among ProfileEntryEnabler objects. The search query is constructed using the ProfileEntryEnablerQuery.

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

Profile entry enablers may have a profile entry enabler query record indicated by their respective record types. The profile entry enabler query record is accessed via the ProfileEntryEnablerQuery.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchProfileEntryEnablers
Description

Tests if this user can perform ProfileEntryEnabler lookups. 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 not offer lookup 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 entry enablers in profiles which are children of this broker in the profile hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedProfileView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetProfileEntryEnablerQuery
Description

Gets a profile entry enabler query.

Returnosid.profile.rules.ProfileEntryEnablerQuerythe profile entry enabler query
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablersByQuery
Description

Gets a list of ProfileEntryEnablers matching the given profile entry enabler query.

Parametersosid.profile.rules.ProfileEntryEnablerQueryprofileEntryEnablerQuerythe profile entry enabler query
Returnosid.profile.rules.ProfileEntryEnablerListthe returned ProfileEntryEnablerList
ErrorsNULL_ARGUMENT profileEntryEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.