OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleEnablerBankSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve SequenceRuleEnabler to Bank mappings. a SequenceRuleEnabler may appear in multiple Bank objects. Each bank may have its own authorizations governing who is allowed to look at it.

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

Tests if this user can perform lookups of sequence rule enabler/bank 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.
MethoduseComparativeSequenceRuleEnablerBankView
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.
MethodusePlenarySequenceRuleEnablerBankView
Description

A complete view of the SequenceRuleEnabler and Bank 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.
MethodgetSequenceRuleEnablerIdsByBank
Description

Gets the list of SequenceRuleEnablerIds associated with an Bank.

Parametersosid.id.IdbankId Id of the Bank
Returnosid.id.IdListlist of related sequence rule enabler Ids
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersByBank
Description

Gets the list of sequence rule enablers associated with an Bank.

Parametersosid.id.IdbankId Id of the Bank
Returnosid.assessment.authoring.SequenceRuleEnablerListlist of related sequence rule enablers
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablerIdsByBanks
Description

Gets the list of SequenceRuleEnabler Ids corresponding to a list of Banks.

Parametersosid.id.IdListbankIdslist of bank Ids
Returnosid.id.IdListlist of sequence rule enabler Ids
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersByBanks
Description

Gets the list of sequence rule enablers corresponding to a list of Banks.

Parametersosid.id.IdListbankIdslist of bank Ids
Returnosid.assessment.authoring.SequenceRuleEnablerListlist of sequence rule enablers
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBankIdsBySequenceRuleEnabler
Description

Gets the Bank Ids mapped to a SequenceRuleEnabler.

Parametersosid.id.IdsequenceRuleEnablerId Id of a SequenceRuleEnabler
Returnosid.id.IdListlist of banks
ErrorsNOT_FOUND sequenceRuleEnablerId is not found
NULL_ARGUMENT sequenceRuleEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBanksBySequenceRuleEnabler
Description

Gets the Banks mapped to a SequenceRuleEnabler.

Parametersosid.id.IdsequenceRuleEnablerId Id of a SequenceRuleEnabler
Returnosid.assessment.BankListlist of banks
ErrorsNOT_FOUND sequenceRuleEnablerId is not found
NULL_ARGUMENT sequenceRuleEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.