Interface | osid.course.ActivityUnitLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving activity units.
An This lookup session defines several views:
The methods Activity units may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupActivityUnits | ||
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 | useComparativeActivityUnitView | ||
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 | usePlenaryActivityUnitView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include activity units in catalogs which are children of this catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveActivityUnitView | ||
Description |
Only active activity units are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusActivityUnitView | ||
Description |
All activity units of any active or inactive status are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActivityUnit | ||
Description |
Gets the In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.id.Id | activityUnitId | the Id of the ActivityUnit to retrieve |
Return | osid.course.ActivityUnit | the returned ActivityUnit | |
Errors | NOT_FOUND | no ActivityUnit found with the given Id | |
NULL_ARGUMENT | activityUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitsByIds | ||
Description |
Gets an In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.id.IdList | activityUnitIds | the list of Ids to retrieve |
Return | osid.course.ActivityUnitList | the returned ActivityUnit list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | activityUnitIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitsByGenusType | ||
Description |
Gets an In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.type.Type | activityUnitGenusType | an activity unit genus type |
Return | osid.course.ActivityUnitList | the returned ActivityUnit list | |
Errors | NULL_ARGUMENT | activityUnitGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitsByParentGenusType | ||
Description |
Gets an In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.type.Type | activityUnitGenusType | an activity unit genus type |
Return | osid.course.ActivityUnitList | the returned ActivityUnit list | |
Errors | NULL_ARGUMENT | activityUnitGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitsByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.type.Type | activityUnitRecordType | an activity unit record type |
Return | osid.course.ActivityUnitList | the returned ActivityUnit list | |
Errors | NULL_ARGUMENT | activityUnitRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitsForCourse | ||
Description |
Gets an In plenary mode, the returned list contains all known activity units or an error results. Otherwise, the returned list may contain only those activity units that are accessible through this session. In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Parameters | osid.id.Id | courseId | a course Id |
Return | osid.course.ActivityUnitList | the returned ActivityUnit list | |
Errors | NULL_ARGUMENT | courseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnits | ||
Description |
Gets all In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned. | ||
Return | osid.course.ActivityUnitList | a list of ActivityUnits | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |