OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.InputEnablerRuleLookupSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve InputEnabler to Input mappings. An Input with multiple InputEnablers means any positive rule evaluation across the enablers result in an effective Input.

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 system view: All methods in this session operate, retrieve and pertain input enablers defined explicitly in the current system
  • federated system view: All methods in this session operate, retrieve and pertain to all input enablers defined in this system and any other input enablers implicitly available in this system through system inheritence.
MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupInputEnablerRules
Description

Tests if this user can perform lookups of input enabler/input 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.
MethoduseComparativeInputEnablerRuleView
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.
MethodusePlenaryInputEnablerRuleView
Description

A complete view of the InputEnabler and Input 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.
MethoduseFederatedSystemView
Description

Federates the view for methods in this session. A federated view will include input enablers in systems which are children of this system in the system hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetInputEnablerIdsForInput
Description

Gets the InputEnabler Id associated with an Input.

Parametersosid.id.IdinputId Id of the Input
Returnosid.id.IdListthe input enabler Ids
ErrorsNOT_FOUND inputId is not found
NULL_ARGUMENT inputId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablersForInput
Description

Gets the InputEnabler associated with an Input.

Parametersosid.id.IdinputId Id of the Input
Returnosid.control.rules.InputEnablerListthe input enablers
ErrorsNOT_FOUND inputId is not found
NULL_ARGUMENT inputId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInputIdsForInputEnabler
Description

Gets the Input Ids mapped to an InputEnabler.

Parametersosid.id.IdinputEnablerId Id of an InputEnabler
Returnosid.id.IdListlist of input Ids
ErrorsNOT_FOUND inputEnablerId is not found
NULL_ARGUMENT inputEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInputsForInputEnabler
Description

Gets the Inputs mapped to an InputEnabler.

Parametersosid.id.IdinputEnablerId Id of an InputEnabler
Returnosid.control.InputListlist of inputs
ErrorsNOT_FOUND inputEnablerId is not found
NULL_ARGUMENT inputEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.