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

This session provides methods for retrieving SequenceRuleEnablers.

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 enabler methods in this session operate, retrieve and pertain to sequence rule enablers defined explicitly in the current bank. Using an isolated view is useful for managing SequenceRuleEnablers with the SequenceRuleEnablerAdminSession.
  • federated bank view: All sequence rule enabler methods in this session operate, retrieve and pertain to all sequence rule enablers defined in this bank and any other sequence rule enablers implicitly available in this bank through bank inheritence.
  • active sequence rule enabler view: All sequence rule enabler lookup methods return active sequence rule enablers.
  • any active sequence rule enabler view: sequence rule enablers 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.
MethodcanLookupSequenceRuleEnablers
Description

Tests if this user can perform SequenceRuleEnablers 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.
MethoduseComparativeSequenceRuleEnablerView
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.
MethodusePlenarySequenceRuleEnablerView
Description

A complete view of the SequenceRuleEnabler 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 enablers 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.
MethoduseActiveSequenceRuleEnablerView
Description

Only active sequence rule enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSequenceRuleEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetSequenceRuleEnabler
Description

Gets the SequenceRuleEnabler specified by its Id.

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

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

Parametersosid.id.IdsequenceRuleEnablerId Id of the SequenceRuleEnabler
Returnosid.assessment.authoring.SequenceRuleEnablerthe sequence rule enabler
ErrorsNOT_FOUND sequenceRuleEnablerId not found
NULL_ARGUMENT sequenceRuleEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSequenceRuleEnablersByIds
Description

Gets a SequenceRuleEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the sequence rule enablers 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 SequenceRuleEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListsequenceRuleEnablerIdsthe list of Ids to retrieve
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT sequenceRuleEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersByGenusType
Description

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

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

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

Parametersosid.type.TypesequenceRuleEnablerGenusTypea sequence rule enabler genus type
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsNULL_ARGUMENT sequenceRuleEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersByParentGenusType
Description

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

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

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

Parametersosid.type.TypesequenceRuleEnablerGenusTypea sequence rule enabler genus type
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsNULL_ARGUMENT sequenceRuleEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersByRecordType
Description

Gets a SequenceRuleEnablerList containing the given sequence rule enabler record Type.

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

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

Parametersosid.type.TypesequenceRuleEnablerRecordTypea sequence rule enabler record type
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsNULL_ARGUMENT sequenceRuleEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersOnDate
Description

Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.

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

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

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersOnDateWithAgent
Description

Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

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

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

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.assessment.authoring.SequenceRuleEnablerListthe returned SequenceRuleEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablers
Description

Gets all SequenceRuleEnablers.

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

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

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