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

This session provides methods for searching among ActivityUnit objects. The search query is constructed using the ActivityUnitQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include activity units in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to activity units in this course catalog

Activity units may have a query record indicated by their respective record types. The query record is accessed via the ActivityUnitQuery.

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.
MethodcanSearchActivityUnits
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 search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include activity units in course catalog which are children of this course 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 lookups to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodgetActivityUnitQuery
Description

Gets an activity unit query.

Returnosid.course.ActivityUnitQuerythe activity unit query
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitsByQuery
Description

Gets a list of ActivityUnits matching the given activity unit query.

Parametersosid.course.ActivityUnitQueryactivityUnitQuerythe activity unit query
Returnosid.course.ActivityUnitListthe returned ActivityUnitList
ErrorsNULL_ARGUMENT activityUnitQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED activityUnitQuery is not of this service
CompliancemandatoryThis method must be implemented.