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

This session manages queries and sequencing to create "smart" dynamic profiles. A ProfileEntryEnablerQuery can be retrieved from this session and mapped to this Profile to create a virtual collection of profile entry enablers. The profile entry enablers may be sequenced using the ProfileEntryEnablerSearchOrder from this session.

This Profile has a default query that matches any profile entry enabler and a default search order that specifies no sequencing. The queries may be examined using a ProfileEntryEnablerQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartProfiles
Description

Tests if this user can manage smart profiles. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart profile management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerQuery
Description

Gets a profile entry enabler query.

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

Gets a profile entry enabler search order.

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

Applies a profile entry enabler query to this profile.

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

Gets a profile entry enabler query inspector for this profile.

Returnosid.profile.rules.ProfileEntryEnablerQueryInspectorthe profile entry enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProfileEntryEnablerSequencing
Description

Applies a profile entry enabler search order to this profile.

Parametersosid.profile.rules.ProfileEntryEnablerSearchOrderprofileEntryEnablerSearchOrderthe profile entry enabler search order
ErrorsNULL_ARGUMENT profileEntryEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED profileEntryEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerQueryFromInspector
Description

Gets a profile entry enabler query from an inspector.

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.