public interface CourseOfferingLookupSession extends OsidSession
This session defines methods for retrieving course offerings. A
CourseOffering
is a scheduled course listed in a course catalog. A
CourseOffering
is derived from a Course
and
maps to an offering time and registered students.
This lookup session defines several views:
CourseOfferings
with the
CourseOfferingAdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Courses may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Course.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCourseOfferings()
Tests if this user can perform
CourseOffering lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CourseOffering |
getCourseOffering(Id courseOfferingId)
Gets the
CourseOffering specified by its Id. |
CourseOfferingList |
getCourseOfferings()
Gets all
CourseOfferings. |
CourseOfferingList |
getCourseOfferingsByGenusType(Type courseOfferingGenusType)
Gets a
CourseOfferingList corresponding to the given
course offering genus Type which does not include
course offerings of types derived from the specified Type. |
CourseOfferingList |
getCourseOfferingsByIds(IdList courseOfferingIds)
Gets a
CourseOfferingList corresponding to the given
IdList. |
CourseOfferingList |
getCourseOfferingsByNumberForTerm(Id termId,
java.lang.String number)
Gets all
CourseOfferings ny number and associated with
a given Term. |
CourseOfferingList |
getCourseOfferingsByParentGenusType(Type courseOfferingGenusType)
Gets a
CourseOfferingList corresponding to the given
course genus Type and include any additional course
offerings with genus types derived from the specified Type. |
CourseOfferingList |
getCourseOfferingsByRecordType(Type courseOfferingRecordType)
Gets a
CourseOfferingList containing the given course
offering record Type. |
CourseOfferingList |
getCourseOfferingsForCourse(Id courseId)
Gets all
CourseOfferings associated with a given
Course. |
CourseOfferingList |
getCourseOfferingsForCourseAndTerm(Id courseId,
Id termId)
Gets all
CourseOfferings associated with a given
Term and Course. |
CourseOfferingList |
getCourseOfferingsForCourseAndTermOnDate(Id courseId,
Id termId,
DateTime from,
DateTime to)
Gets all
CourseOffering s for a course, term, and
effective within the given date range inclusive. |
CourseOfferingList |
getCourseOfferingsForCourseOnDate(Id courseId,
DateTime from,
DateTime to)
Gets all
CourseOffering s for a course and effective
within the given date range inclusive. |
CourseOfferingList |
getCourseOfferingsForTerm(Id termId)
Gets all
CourseOfferings associated for a given
Term. |
CourseOfferingList |
getCourseOfferingsForTermOnDate(Id termId,
DateTime from,
DateTime to)
Gets all
CourseOfferings for a term and effective
within the given date range inclusive. |
CourseOfferingList |
getCourseOfferingsOnDate(DateTime from,
DateTime to)
Gets all
CourseOfferings effective within the given
date range inclusive. |
void |
useAnyEffectiveCourseOfferingView()
All methods return course offerings of any effective or expired
status.
|
void |
useComparativeCourseOfferingView()
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 |
useEffectiveCourseOfferingView()
All course offering methods return course offerings 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 |
usePlenaryCourseOfferingView()
A complete view of the
CourseOffering returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCourseOfferings()
CourseOffering
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCourseOfferingView()
mandatory
- This method is must be implemented. void usePlenaryCourseOfferingView()
CourseOffering
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.mandatory
- This method is must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useEffectiveCourseOfferingView()
mandatory
- This method is must be implemented. void useAnyEffectiveCourseOfferingView()
mandatory
- This method is must be implemented. CourseOffering getCourseOffering(Id courseOfferingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseOffering
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CourseOffering
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Course
and retained for compatibility.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseOfferingId
- the Id
of the
CourseOffering
to retrieve CourseOffering
NotFoundException
- no CourseOffering
found with the given Id
NullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsByIds(IdList courseOfferingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseOfferingList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
course offerings 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 CourseOfferings
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseOfferingIds
- the list of Ids
to retrieve CourseOffering
listNotFoundException
- an Id was
not foundNullArgumentException
- courseOfferingIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsByGenusType(Type courseOfferingGenusType) throws OperationFailedException, PermissionDeniedException
CourseOfferingList
corresponding to the given
course offering genus Type
which does not include
course offerings of types derived from the specified Type.
In plenary mode, the returned list contains all known
course offerings or an error results. Otherwise, the returned list may
contain only those course offerings that are accessible through this
session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseOfferingGenusType
- a course offering genus type CourseOffering
listNullArgumentException
- courseOfferingGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsByParentGenusType(Type courseOfferingGenusType) throws OperationFailedException, PermissionDeniedException
CourseOfferingList
corresponding to the given
course genus Type
and include any additional course
offerings with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
course offerings or an error results. Otherwise, the returned list may
contain only those course offerings that are accessible through this
session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseOfferingGenusType
- a course offering genus type CourseOffering
listNullArgumentException
- courseOfferingGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsByRecordType(Type courseOfferingRecordType) throws OperationFailedException, PermissionDeniedException
CourseOfferingList
containing the given course
offering record Type.
In plenary mode, the returned list contains all known courses or an
error results. Otherwise, the returned list may contain only those
course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseOfferingRecordType
- a course offering record type CourseOffering
listNullArgumentException
- courseOfferingRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CourseOfferings
effective within the given
date range inclusive.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.from
- start of date rangeto
- end of date range CourseOfferings
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
CourseOfferings
associated with a given
Course.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseId
- a course Id
CourseOfferings
NullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForCourseOnDate(Id courseId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CourseOffering
s for a course and effective
within the given date range inclusive.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseId
- a course Id
from
- start of date rangeto
- end of date range CourseOfferings
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- courseId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForTerm(Id termId) throws OperationFailedException, PermissionDeniedException
CourseOfferings
associated for a given
Term.
In plenary mode, the returned list contains all known
course offerings or an error results. Otherwise, the returned list may
contain only those course offerings that are accessible through this
session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.termId
- a term Id
CourseOfferings
NullArgumentException
- termId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForTermOnDate(Id termId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CourseOfferings
for a term and effective
within the given date range inclusive.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.termId
- a term Id
from
- start of date rangeto
- end of date range CourseOfferings
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- termId, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForCourseAndTerm(Id courseId, Id termId) throws OperationFailedException, PermissionDeniedException
CourseOfferings
associated with a given
Term
and Course.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseId
- a course Id
termId
- a term Id
CourseOfferings
NullArgumentException
- courseId
or
termId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsForCourseAndTermOnDate(Id courseId, Id termId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CourseOffering
s for a course, term, and
effective within the given date range inclusive.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.courseId
- a course Id
termId
- a term Id
from
- start of date rangeto
- end of date range CourseOfferings
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- courseId, termId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferingsByNumberForTerm(Id termId, java.lang.String number) throws OperationFailedException, PermissionDeniedException
CourseOfferings ny number and
associated with
a given Term.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those course offerings that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned.termId
- a term Id
number
- a course offering number CourseOfferings
NullArgumentException
- termId
or
number
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseOfferingList getCourseOfferings() throws OperationFailedException, PermissionDeniedException
CourseOfferings.
In plenary mode, the returned list contains all known course offerings
or an error results. Otherwise, the returned list may contain only
those courses that are accessible through this session.
In effective mode, course offerings are returned where the current
date falls within the effective dates inclusive. In any effective
mode, effective and expired course offerings are returned. CourseOfferings
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.