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

This session provides methods for retrieving SequenceRules.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated bank view: All sequence rule methods in this session operate, retrieve and pertain to sequence rule defined explicitly in the current bank. Using an isolated view is useful for managing SequenceRules with the SequenceRuleAdminSession.
  • federated bank view: All sequence rule methods in this session operate, retrieve and pertain to all sequence rule defined in this bank and any other sequence rule implicitly available in this bank through bank inheritence.
  • active sequence rule view: All sequence rule lookup methods return active sequence rules.
  • any status sequence rule view: sequence rules of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedBankView() and useIsolatedBankView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupSequenceRules
Description

Tests if this user can perform SequenceRules lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSequenceRuleView
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.
MethodusePlenarySequenceRuleView
Description

A complete view of the SequenceRule 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.
MethoduseFederatedBankView
Description

Federates the view for methods in this session. A federated view will include sequence rule in banks which are children of this bank in the bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveSequenceRuleView
Description

Only active sequence rules are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSequenceRuleView
Description

All active and inactive sequence rules are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSequenceRule
Description

Gets the SequenceRule specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SequenceRule may have a different Id than requested, such as the case where a duplicate Id was assigned to a SequenceRule and retained for compatibility.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdsequenceRuleId Id of the SequenceRule
Returnosid.assessment.authoring.SequenceRulethe sequence rule
ErrorsNOT_FOUND sequenceRuleId not found
NULL_ARGUMENT sequenceRuleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSequenceRulesByIds
Description

Gets a SequenceRuleList corresponding to the given IdList.

In plenary mode, the returned list contains all of the sequence rule specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SequenceRules may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdListsequenceRuleIdsthe list of Ids to retrieve
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT sequenceRuleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesByGenusType
Description

Gets a SequenceRuleList corresponding to the given sequence rule genus Type which does not include sequence rule of genus types derived from the specified Type.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.type.TypesequenceRuleGenusTypea sequence rule genus type
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT sequenceRuleGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesByParentGenusType
Description

Gets a SequenceRuleList corresponding to the given sequence rule genus Type and include any additional sequence rule with genus types derived from the specified Type.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.type.TypesequenceRuleGenusTypea sequence rule genus type
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT sequenceRuleGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesByRecordType
Description

Gets a SequenceRuleList containing the given sequence rule record Type.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.type.TypesequenceRuleRecordTypea sequence rule record type
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT sequenceRuleRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesForAssessmentPart
Description

Gets a SequenceRuleList for the given source assessment part.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdassessmentPartIdan assessment part Id
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT assessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesForNextAssessmentPart
Description

Gets a SequenceRuleList for the given target assessment part.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdnextAssessmentPartIdan assessment part Id
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT nextAssessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesForAssessmentParts
Description

Gets a SequenceRuleList for the given source and target assessment parts.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdassessmentPartIdsource assessment part Id
osid.id.IdnextAssessmentPartIdtarget assessment part Id
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT assessmentPartId or nextAssessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesForAssessment
Description

Gets a SequenceRuleList for an entire assessment.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Parametersosid.id.IdassessmentIdan assessment Id
Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRules
Description

Gets all SequenceRules.

In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session.

In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.

Returnosid.assessment.authoring.SequenceRuleListthe returned SequenceRule list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.