Interface | osid.assessment.authoring.SequenceRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
Method | getBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBank | ||
Description |
Gets the | ||
Return | osid.assessment.Bank | the bank | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSequenceRules | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSequenceRuleView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySequenceRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBankView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSequenceRuleView | ||
Description |
Only active sequence rules are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSequenceRuleView | ||
Description |
All active and inactive sequence rules are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSequenceRule | ||
Description |
Gets the In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.Id | sequenceRuleId | Id of the SequenceRule |
Return | osid.assessment.authoring.SequenceRule | the sequence rule | |
Errors | NOT_FOUND | sequenceRuleId not found | |
NULL_ARGUMENT | sequenceRuleId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSequenceRulesByIds | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.IdList | sequenceRuleIds | the list of Ids to retrieve |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NOT_FOUND | a Id was not found | |
NULL_ARGUMENT | sequenceRuleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesByGenusType | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.type.Type | sequenceRuleGenusType | a sequence rule genus type |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | sequenceRuleGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesByParentGenusType | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.type.Type | sequenceRuleGenusType | a sequence rule genus type |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | sequenceRuleGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesByRecordType | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.type.Type | sequenceRuleRecordType | a sequence rule record type |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | sequenceRuleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesForAssessmentPart | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.Id | assessmentPartId | an assessment part Id |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | assessmentPartId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesForNextAssessmentPart | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.Id | nextAssessmentPartId | an assessment part Id |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | nextAssessmentPartId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesForAssessmentParts | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.Id | assessmentPartId | source assessment part Id |
osid.id.Id | nextAssessmentPartId | target assessment part Id | |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | assessmentPartId or nextAssessmentPartId is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRulesForAssessment | ||
Description |
Gets a In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned. | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | NULL_ARGUMENT | assessmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSequenceRules | ||
Description |
Gets all 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. | ||
Return | osid.assessment.authoring.SequenceRuleList | the returned SequenceRule list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |