Interface | osid.learning.ObjectiveRequisiteSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving objective
requisites. A requisite is a set of This session defines views that offer differing behaviors when retrieving multiple objects.
Objectives may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
Method | getObjectiveBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the ObjectiveBank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBank | ||
Description |
Gets the | ||
Return | osid.learning.ObjectiveBank | the ObjectiveBank associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupObjectivePrerequisites | ||
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 | useComparativeObjectiveView | ||
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 | usePlenaryObjectiveView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedObjectiveBankView | ||
Description |
Federates the view for methods in this session. A federated view will include objectives in objective banks which are children of this objective bank in the objective bank hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedObjectiveBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this objective bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRequisiteObjectives | ||
Description |
Gets a list of | ||
Parameters | osid.id.Id | objectiveId | Id of the Objective |
Return | osid.learning.ObjectiveList | the returned requisite Objectives | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | objectiveId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAllRequisiteObjectives | ||
Description |
Gets a list of | ||
Parameters | osid.id.Id | objectiveId | Id of the Objective |
Return | osid.learning.ObjectiveList | the returned Objective list | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | objectiveId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDependentObjectives | ||
Description |
Gets a list of | ||
Parameters | osid.id.Id | objectiveId | Id of the Objective |
Return | osid.learning.ObjectiveList | the returned Objective list | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | objectiveId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isObjectiveRequired | ||
Description |
Tests if an objective is required before proceeding with an objective. One objective may indirectly depend on another objective by way of one or more other objectives. | ||
Parameters | osid.id.Id | objectiveId | Id of the dependent Objective |
osid.id.Id | requiredObjectiveId | Id of the required Objective | |
Return | boolean | true if objectiveId depends on
requiredObjectiveId, false otherwise | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | objectiveId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEquivalentObjectives | ||
Description |
Gets a list of | ||
Parameters | osid.id.Id | objectiveId | Id of the Objective |
Return | osid.learning.ObjectiveList | the returned Objective list | |
Errors | NOT_FOUND | objectiveId not found | |
NULL_ARGUMENT | objectiveId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |