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

This session provides methods to retrieve ProfileEntryEnabler to ProfileEntry mappings. A Profile with multiple ProfileEntryEnablers means any positive rule evaluation across the enablers result in an enabled ProfileEntry.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated profile view: All methods in this session operate, retrieve and pertain profile entry enablers defined explicitly in the current profile
  • federated profile view: All methods in this session operate, retrieve and pertain to all profile entry enablers defined in this profile and any other profile entry enablers implicitly available in this profile through profile inheritence.
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.
MethodcanLookupProfileEntryEnablerRules
Description

Tests if this user can perform lookups of profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProfileEntryEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProfileEntryEnablerRuleView
Description

A complete view of the ProfileEntryEnabler and ProfileEntry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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 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 lookups to this profile only.

CompliancemandatoryThis method is must be implemented.
MethodgetProfileEntryEnablerIdsForProfileEntry
Description

Gets the ProfileEntryEnabler Id associated with a ProfileEntry.

Parametersosid.id.Id profileEntryId Id of the ProfileEntry
Returnosid.id.IdListthe profile entry enabler Ids
ErrorsNOT_FOUND profileEntryId is not found
NULL_ARGUMENT profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablersForProfileEntry
Description

Gets the ProfileEntryEnabler associated with a ProfileEntry.

Parametersosid.id.IdprofileEntryId Id of the ProfileEntry
Returnosid.profile.rules.ProfileEntryEnablerListthe profile entry enablers
ErrorsNOT_FOUND profileEntryId is not found
NULL_ARGUMENT profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryIdsForProfileEntryEnabler
Description

Gets the ProfileEntry Ids mapped to a ProfileEntryEnabler.

Parametersosid.id.IdprofileEntryEnablerId Id of a ProfileEntryEnabler
Returnosid.id.IdListlist of profile entry Ids
ErrorsNOT_FOUND profileEntryEnablerId is not found
NULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntriesForProfileEntryEnabler
Description

Gets the ProfileEntries mapped to a ProfileEntryEnabler.

Parametersosid.id.IdprofileEntryEnablerId Id of a ProfileEntryEnabler
Returnosid.profile.ProfileEntryListlist of profile entries
ErrorsNOT_FOUND profileEntryEnablerId is not found
NULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.