org.osid.course

Interface ActivityLookupSession

All Superinterfaces:

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

public interface ActivityLookupSession
extends OsidSession

This session provides methods for retrieving Activity objects. The Activity represents a time period in which courses are offered.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated course catalog view: All activity methods in this session operate, retrieve and pertain to activities defined explicitly in the current course catalog. Using an isolated view is useful for managing Activities with the ActivityAdminSession.
• federated course catalog view: All activity methods in this session operate, retrieve and pertain to all activities defined in this course catalog and any other activities implicitly available in this course catalog through course catalog inheritence.
• effective activity view: All course offering lookup methods return activities where the current date falls within the effective dates inclusive.
• any effective activity view: Activities of any effective or expired status are returned from methods.
• denormalized activity view: activities are expanded into a series of non-recurring single-date activities
• normalized acticity view: activities are represented by a single activity

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. 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	canLookupActivities() Tests if this user can perform Activity lookups.
ActivityList	getActivities() Gets all Activities.
ActivityList	getActivitiesByGenusType(Type activityGenusType) Gets an ActivityList corresponding to the given activity genus Type which does not include activities of genus types derived from the specified Type.
ActivityList	getActivitiesByIds(IdList activityIds) Gets an ActivityList corresponding to the given IdList.
ActivityList	getActivitiesByParentGenusType(Type activityGenusType) Gets an ActivityList corresponding to the given activity genus Type and include any additional activities with genus types derived from the specified Type.
ActivityList	getActivitiesByRecordType(Type activityRecordType) Gets an ActivityList containing the given activity record Type.
ActivityList	getActivitiesForActivityUnit(Id activityUnitId) Gets all Activities associated with a given ActivityUnit.
ActivityList	getActivitiesForActivityUnitAndTerm(Id activityUnitId, Id termId) Gets all Activities associated with a given ActivityUnit for a term.
ActivityList	getActivitiesForActivityUnitAndTermOnDate(Id activityUnitId, Id termId, DateTime from, DateTime to) Gets an ActivityList for the given activity unit, term, and effective within the given date range inclusive.
ActivityList	getActivitiesForActivityUnitOnDate(Id activityUnitId, DateTime from, DateTime to) Gets an ActivityList for the given activity unit and effective within the given date range inclusive.
ActivityList	getActivitiesForCourseOffering(Id courseOfferingId) Gets all Activities associated with a given CourseOffering.
ActivityList	getActivitiesForTerm(Id termId) Gets all Activities associated with a given term.
ActivityList	getActivitiesForTermOnDate(Id termId, DateTime from, DateTime to) Gets an ActivityList for the given term and effective within the given date range inclusive.
ActivityList	getActivitiesOnDate(DateTime from, DateTime to) Gets an ActivityList effective within the given date range inclusive.
Activity	getActivity(Id activityId) Gets the Activity specified by its Id.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	useAnyEffectiveActivityView() All methods return activities of any effective or expired status.
void	useComparativeActivityView() 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	useDenormalizedActivityView() A denormalized view expands recurring activities into a series of activities.
void	useEffectiveActivityView() All activity methods return activities where the current date falls within the effective dates inclusive.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	useNormalizedActivityView() A normalized view uses a single Activity to represent a set of recurring activities.
void	usePlenaryActivityView() A complete view of the Activity 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.

canLookupActivities

boolean canLookupActivities()

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

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActivityView

void useComparativeActivityView()

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.

usePlenaryActivityView

void usePlenaryActivityView()

A complete view of the Activity 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 activities in course catalogs which are children of this course 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 lookups to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveActivityView

void useEffectiveActivityView()

All activity methods return activities where the current date falls within the effective dates inclusive.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveActivityView

void useAnyEffectiveActivityView()

All methods return activities of any effective or expired status.

Compliance:

mandatory - This method is must be implemented.

useNormalizedActivityView

void useNormalizedActivityView()

A normalized view uses a single Activity to represent a set of recurring activities.

Compliance:

mandatory - This method is must be implemented.

useDenormalizedActivityView

void useDenormalizedActivityView()

A denormalized view expands recurring activities into a series of activities.

Compliance:

mandatory - This method is must be implemented.

getActivity

Activity getActivity(Id activityId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the Activity specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Activity may have a different Id than requested, such as the case where a duplicate Id was assigned to an Activity and retained for compatibility. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityId - Id of the Activity

Returns:

the activity

Throws:

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivitiesByIds

ActivityList getActivitiesByIds(IdList activityIds)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets an ActivityList corresponding to the given IdList. In plenary mode, the returned list contains all of the activities 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 Activities may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityIds - the list of Ids to retrieve

Returns:

the returned Activity list

Throws:

NotFoundException - an Id was not found

NullArgumentException - activityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByGenusType

ActivityList getActivitiesByGenusType(Type activityGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an ActivityList corresponding to the given activity genus Type which does not include activities of genus types derived from the specified Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityGenusType - an activity genus type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByParentGenusType

ActivityList getActivitiesByParentGenusType(Type activityGenusType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets an ActivityList corresponding to the given activity genus Type and include any additional activities with genus types derived from the specified Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityGenusType - an activity genus type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByRecordType

ActivityList getActivitiesByRecordType(Type activityRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets an ActivityList containing the given activity record Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityRecordType - an activity record type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesOnDate

ActivityList getActivitiesOnDate(DateTime from,
                               DateTime to)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets an ActivityList effective within the given date range inclusive. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned Activity list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForActivityUnit

ActivityList getActivitiesForActivityUnit(Id activityUnitId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets all Activities associated with a given ActivityUnit. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityUnitId - an activity unit Id

Returns:

the returned Activity list

Throws:

NullArgumentException - activityUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForActivityUnitOnDate

ActivityList getActivitiesForActivityUnitOnDate(Id activityUnitId,
                                              DateTime from,
                                              DateTime to)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets an ActivityList for the given activity unit and effective within the given date range inclusive. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityUnitId - an activity unit Id

from - start of date range

to - end of date range

Returns:

the returned Activity list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - activityUnitId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForTerm

ActivityList getActivitiesForTerm(Id termId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets all Activities associated with a given term. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

termId - a term Id

Returns:

the returned Activity list

Throws:

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForTermOnDate

ActivityList getActivitiesForTermOnDate(Id termId,
                                      DateTime from,
                                      DateTime to)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets an ActivityList for the given term and effective within the given date range inclusive. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

termId - a term Id

from - start of date range

to - end of date range

Returns:

the returned Activity list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - termId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForActivityUnitAndTerm

ActivityList getActivitiesForActivityUnitAndTerm(Id activityUnitId,
                                               Id termId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets all Activities associated with a given ActivityUnit for a term. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityUnitId - an activity unit Id

termId - a term Id

Returns:

the returned Activity list

Throws:

NullArgumentException - activityUnitId or termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForActivityUnitAndTermOnDate

ActivityList getActivitiesForActivityUnitAndTermOnDate(Id activityUnitId,
                                                     Id termId,
                                                     DateTime from,
                                                     DateTime to)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets an ActivityList for the given activity unit, term, and effective within the given date range inclusive. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

activityUnitId - an activity unit Id

termId - a term Id

from - start of date range

to - end of date range

Returns:

the returned Activity list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - activityUnitId, termId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForCourseOffering

ActivityList getActivitiesForCourseOffering(Id courseOfferingId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets all Activities associated with a given CourseOffering. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Parameters:

courseOfferingId - a course Id

Returns:

the returned Activity list

Throws:

NullArgumentException - courseOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivities

ActivityList getActivities()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets all Activities. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired activities are returned.

Returns:

a list of Activities

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.