org.osid.course

Interface ActivityUnitLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ActivityUnitLookupSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupActivityUnits() Tests if this user can perform ActivityUnit lookups.
ActivityUnit	getActivityUnit(Id activityUnitId) Gets the ActivityUnit specified by its Id.
ActivityUnitList	getActivityUnits() Gets all ActivityUnits.
ActivityUnitList	getActivityUnitsByGenusType(Type activityUnitGenusType) Gets an ActivityUnitList corresponding to the given activity unit genus Type which does not include activity units of types derived from the specified Type .
ActivityUnitList	getActivityUnitsByIds(IdList activityUnitIds) Gets an ActivityUnitList corresponding to the given IdList.
ActivityUnitList	getActivityUnitsByParentGenusType(Type activityUnitGenusType) 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.
ActivityUnitList	getActivityUnitsByRecordType(Type activityUnitRecordType) Gets an ActivityUnitList containing the given activity unit record Type.
ActivityUnitList	getActivityUnitsForCourse(Id courseId) Gets an ActivityUnitList for the given course.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	useActiveActivityUnitView() Only active activity units are returned by methods in this session.
void	useAnyStatusActivityUnitView() All activity units of any active or inactive status are returned by methods in this session.
void	useComparativeActivityUnitView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenaryActivityUnitView() A complete view of the ActivityUnit returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupActivityUnits

boolean canLookupActivityUnits()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActivityUnitView

void useComparativeActivityUnitView()

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.

usePlenaryActivityUnitView

void usePlenaryActivityUnitView()

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.

Compliance:

mandatory - This method is must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

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.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

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.

useActiveActivityUnitView

void useActiveActivityUnitView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusActivityUnitView

void useAnyStatusActivityUnitView()

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

Compliance:

mandatory - This method is must be implemented.

getActivityUnit

ActivityUnit getActivityUnit(Id activityUnitId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

activityUnitId - the Id of the ActivityUnit to retrieve

Returns:

the returned ActivityUnit

Throws:

NotFoundException - no ActivityUnit found with the given Id

NullArgumentException - activityUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitsByIds

ActivityUnitList getActivityUnitsByIds(IdList activityUnitIds)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

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.

Parameters:

activityUnitIds - the list of Ids to retrieve

Returns:

the returned ActivityUnit list

Throws:

NotFoundException - an Id was not found

NullArgumentException - activityUnitIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitsByGenusType

ActivityUnitList getActivityUnitsByGenusType(Type activityUnitGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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.

Parameters:

activityUnitGenusType - an activity unit genus type

Returns:

the returned ActivityUnit list

Throws:

NullArgumentException - activityUnitGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitsByParentGenusType

ActivityUnitList getActivityUnitsByParentGenusType(Type activityUnitGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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.

Parameters:

activityUnitGenusType - an activity unit genus type

Returns:

the returned ActivityUnit list

Throws:

NullArgumentException - activityUnitGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitsByRecordType

ActivityUnitList getActivityUnitsByRecordType(Type activityUnitRecordType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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.

Parameters:

activityUnitRecordType - an activity unit record type

Returns:

the returned ActivityUnit list

Throws:

NullArgumentException - activityUnitRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnitsForCourse

ActivityUnitList getActivityUnitsForCourse(Id courseId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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.

Parameters:

courseId - a course Id

Returns:

the returned ActivityUnit list

Throws:

NullArgumentException - courseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityUnits

ActivityUnitList getActivityUnits()
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Returns:

a list of ActivityUnits

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.