OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivityUnitLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving activity units. An ActivityUnit is derived from a Course and maps to an offering time and registered students.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated course catalog view: All activity unit methods in this session operate, retrieve and pertain to activity units defined explicitly in the current course catalog. Using an isolated view is useful for managing ActivityUnits with the ActivityUnitAdminSession.
  • federated course catalog view: All activity unit lookup methods in this session operate, retrieve and pertain to all activity units defined in this course catalog and any other activity units implicitly available in this course catalog through course catalog inheritence.
  • active activity unit view: All activity unit lookup methods return activity units which are active.
  • any active activity unit view: Activity units of any active or inactive status are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup 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 ActivityUnit.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupActivityUnits
Description

Tests if this user can perform ActivityUnit 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 not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActivityUnitView
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.
MethodusePlenaryActivityUnitView
Description

A complete view of the ActivityUnit 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.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveActivityUnitView
Description

Only active activity units are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusActivityUnitView
Description

All activity units of any active or inactive status are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetActivityUnit
Description

Gets the ActivityUnit specified by its Id.

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

In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.

Parametersosid.id.IdactivityUnitIdthe Id of the ActivityUnit to retrieve
Returnosid.course.ActivityUnitthe returned ActivityUnit
ErrorsNOT_FOUNDno ActivityUnit found with the given Id
NULL_ARGUMENT activityUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsByIds
Description

Gets an ActivityUnitList corresponding to the given IdList.

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

In active mode, activity units are returned that are currently active. In any status mode, active and inactive activity units are returned.

Parametersosid.id.IdListactivityUnitIdsthe list of Ids to retrieve
Returnosid.course.ActivityUnitListthe returned ActivityUnit list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT activityUnitIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsByGenusType
Description

Gets an ActivityUnitList corresponding to the given activity unit genus Type which does not include activity units of types derived from the specified Type .

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.

Parametersosid.type.TypeactivityUnitGenusTypean activity unit genus type
Returnosid.course.ActivityUnitListthe returned ActivityUnit list
ErrorsNULL_ARGUMENT activityUnitGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsByParentGenusType
Description

Gets an ActivityUnitList corresponding to the given activity unit genus Type and include any additional activity units with genus types derived from the specified Type.

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.

Parametersosid.type.TypeactivityUnitGenusTypean activity unit genus type
Returnosid.course.ActivityUnitListthe returned ActivityUnit list
ErrorsNULL_ARGUMENT activityUnitGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsByRecordType
Description

Gets an ActivityUnitList containing the given activity unit record Type.

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.

Parametersosid.type.TypeactivityUnitRecordTypean activity unit record type
Returnosid.course.ActivityUnitListthe returned ActivityUnit list
ErrorsNULL_ARGUMENT activityUnitRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsForCourse
Description

Gets an ActivityUnitList for the given course.

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.

Parametersosid.id.IdcourseIda course Id
Returnosid.course.ActivityUnitListthe returned ActivityUnit list
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnits
Description

Gets all ActivityUnits.

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.

Returnosid.course.ActivityUnitLista list of ActivityUnits
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.