org.osid.course.registration

Interface ActivityBundleLookupSession

All Superinterfaces:

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

public interface ActivityBundleLookupSession
extends OsidSession

This session defines methods for retrieving activity bundles. An ActivityBundle is a set of Activities in which a student can be registered.

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 bundle methods in this session operate, retrieve and pertain to activity bundles defined explicitly in the current course catalog. Using an isolated view is useful for managing ActivityBundles with the ActivityBundleAdminSession.
• federated course catalog view: All activity bundle lookup methods in this session operate, retrieve and pertain to all activity bundles defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupActivityBundles() Tests if this user can perform ActivityBundle lookups.
ActivityBundle	getActivityBundle(Id activityBundleId) Gets the ActivityBundle specified by its Id.
ActivityBundleList	getActivityBundles() Gets all ActivityBundles.
ActivityBundleList	getActivityBundlesByActivity(Id activityId) Gets an ActivityBundleList for a given activity.
ActivityBundleList	getActivityBundlesByGenusType(Type activityBundleGenusType) Gets an ActivityBundleList corresponding to the given activity bundle genus Type which does not include activity bundles of types derived from the specified Type.
ActivityBundleList	getActivityBundlesByIds(IdList activityBundleIds) Gets an ActivityBundleList corresponding to the given IdList.
ActivityBundleList	getActivityBundlesByParentGenusType(Type activityBundleGenusType) Gets an ActivityBundleList corresponding to the given course genus Type and include any additional activity bundles with genus types derived from the specified Type.
ActivityBundleList	getActivityBundlesByRecordType(Type activityBundleRecordType) Gets an ActivityBundleList containing the given activity bundle record Type.
ActivityBundleList	getActivityBundlesForCourseOffering(Id courseOfferingId) Gets an ActivityBundleList for a given course offering .
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	useComparativeActivityBundleView() 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	usePlenaryActivityBundleView() A complete view of the ActivityBundle 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.

canLookupActivityBundles

boolean canLookupActivityBundles()

Tests if this user can perform ActivityBundle 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.

useComparativeActivityBundleView

void useComparativeActivityBundleView()

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.

usePlenaryActivityBundleView

void usePlenaryActivityBundleView()

A complete view of the ActivityBundle 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 bundles 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.

getActivityBundle

ActivityBundle getActivityBundle(Id activityBundleId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

activityBundleId - the Id of the ActivityBundle to retrieve

Returns:

the returned ActivityBundle

Throws:

NotFoundException - no ActivityBundle found with the given Id

NullArgumentException - activityBundleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByIds

ActivityBundleList getActivityBundlesByIds(IdList activityBundleIds)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets an ActivityBundleList corresponding to the given IdList. In plenary mode, the returned list contains all of the activity bundles 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 ActivityBundles may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

activityBundleIds - the list of Ids to retrieve

Returns:

the returned ActivityBundle list

Throws:

NotFoundException - an Id was not found

NullArgumentException - activityBundleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByGenusType

ActivityBundleList getActivityBundlesByGenusType(Type activityBundleGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets an ActivityBundleList corresponding to the given activity bundle genus Type which does not include activity bundles of types derived from the specified Type. In plenary mode, the returned list contains all known activity bundles or an error results. Otherwise, the returned list may contain only those activity bundles that are accessible through this session.

Parameters:

activityBundleGenusType - an activity bundle genus type

Returns:

the returned ActivityBundle list

Throws:

NullArgumentException - activityBundleGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByParentGenusType

ActivityBundleList getActivityBundlesByParentGenusType(Type activityBundleGenusType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets an ActivityBundleList corresponding to the given course genus Type and include any additional activity bundles with genus types derived from the specified Type. In plenary mode, the returned list contains all known activity bundles or an error results. Otherwise, the returned list may contain only those activity bundles that are accessible through this session.

Parameters:

activityBundleGenusType - an activity bundle genus type

Returns:

the returned ActivityBundle list

Throws:

NullArgumentException - activityBundleGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByRecordType

ActivityBundleList getActivityBundlesByRecordType(Type activityBundleRecordType)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets an ActivityBundleList containing the given activity bundle record Type. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those activity bundles that are accessible through this session.

Parameters:

activityBundleRecordType - an activity bundle record type

Returns:

the returned ActivityBundle list

Throws:

NullArgumentException - activityBundleRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesForCourseOffering

ActivityBundleList getActivityBundlesForCourseOffering(Id courseOfferingId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets an ActivityBundleList for a given course offering . In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those activity bundles that are accessible through this session.

Parameters:

courseOfferingId - a course offering Id

Returns:

the returned ActivityBundle list

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundlesByActivity

ActivityBundleList getActivityBundlesByActivity(Id activityId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets an ActivityBundleList for a given activity. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those activity bundles that are accessible through this session.

Parameters:

activityId - an activity Id

Returns:

the returned ActivityBundle list

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivityBundles

ActivityBundleList getActivityBundles()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets all ActivityBundles. In plenary mode, the returned list contains all known activity bundles or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session.

Returns:

a list of ActivityBundles

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.