OSID Logo
OSID Specifications
assessment authoring package
Version 3.1.0
Interfaceosid.assessment.authoring.SequenceRuleEnablerBankSession
Implementsosid.OsidSession
Used Byosid.assessment.authoring.AssessmentAuthoringManager
osid.assessment.authoring.AssessmentAuthoringProxyManager
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
Compliancemandatory This 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.

Compliancemandatory This 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.

Compliancemandatory This 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.IdList list of related sequence rule enabler Ids
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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.SequenceRuleEnablerList list of related sequence rule enablers
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetSequenceRuleEnablerIdsByBanks
Description

Gets the list of SequenceRuleEnablerIds corresponding to a list of Banks.

Parametersosid.id.IdListbankIds list of bank Ids
Returnosid.id.IdList list of sequence rule enabler Ids
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetSequenceRuleEnablersByBanks
Description

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

Parametersosid.id.IdListbankIds list of bank Ids
Returnosid.assessment.authoring.SequenceRuleEnablerList list of sequence rule enablers
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetBankIdsBySequenceRuleEnabler
Description

Gets the Bank Ids mapped to a SequenceRuleEnabler.

Parametersosid.id.IdsequenceRuleEnablerId Id of a SequenceRuleEnabler
Returnosid.id.IdList list of banks
ErrorsNOT_FOUND sequenceRuleEnablerId is not found
NULL_ARGUMENT sequenceRuleEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetBanksBySequenceRuleEnabler
Description

Gets the Banks mapped to a SequenceRuleEnabler.

Parametersosid.id.IdsequenceRuleEnablerId Id of a SequenceRuleEnabler
Returnosid.assessment.BankList list of banks
ErrorsNOT_FOUND sequenceRuleEnablerId is not found
NULL_ARGUMENT sequenceRuleEnablerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.