public interface LessonLookupSession extends OsidSession
This session provides methods for retrieving Lesson
objects. The Lesson
represents a collection of syllabi.
This session defines views that offer differing behaviors when retrieving multiple objects.
LessonAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupLessons()
Tests if this user can perform
Lesson lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
Lesson |
getLesson(Id lessonId)
Gets the
Lesson specified by its Id. |
LessonList |
getLessons()
Gets all
Lessons. |
LessonList |
getLessonsByGenusType(Type lessonGenusType)
Gets a
LessonList corresponding to the given lesson
genus Type which does not include lessonsof genus types
derived from the specified Type. |
LessonList |
getLessonsByIds(IdList lessonIds)
Gets a
LessonList corresponding to the given
IdList. |
LessonList |
getLessonsByParentGenusType(Type lessonGenusType)
Gets a
LessonList corresponding to the given lesson
genus Type and include any additional lessonswith genus
types derived from the specified Type. |
LessonList |
getLessonsByRecordType(Type lessonRecordType)
Gets a
LessonList containing the given lesson record
Type. |
LessonList |
getLessonsForDocet(Id docetId)
Gets a
LessonList for the given docet Id. |
LessonList |
getLessonsForDocetOnDate(Id docetId,
DateTime from,
DateTime to)
Gets a
LessonList for a docet effective sduring the
entire given date range inclusive but not confined to the date range. |
LessonList |
getLessonsForPlan(Id planId)
Gets a
LessonList for the given plan Id. |
LessonList |
getLessonsForPlanAndDocet(Id planId,
Id docetId)
Gets a
LessonList for the given plan and docet. |
LessonList |
getLessonsForPlanAndDocetOnDate(Id planId,
Id docetId,
DateTime from,
DateTime to)
Gets a
LessonList for a plan and docet effective during
the entire given date range inclusive but not confined to the date
range. |
LessonList |
getLessonsForPlanOnDate(Id planId,
DateTime from,
DateTime to)
Gets a
LessonList for a plan effective during the
entire given date range inclusive but not confined to the date range. |
LessonList |
getLessonsOnDate(DateTime from,
DateTime to)
Gets a
LessonList effective sduring the entire given
date range inclusive but not confined to the date range. |
void |
useAnyEffectiveLessonView()
All lessons of any effective dates are returned by methods in this
session.
|
void |
useComparativeLessonView()
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 |
useEffectiveLessonView()
Only lessons whose effective dates are current are returned by methods
in this session.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryLessonView()
A complete view of the
Lesson 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 canLookupLessons()
Lesson
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 useComparativeLessonView()
mandatory
- This method is must be implemented. void usePlenaryLessonView()
Lesson
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 useEffectiveLessonView()
mandatory
- This method is must be implemented. void useAnyEffectiveLessonView()
mandatory
- This method is must be implemented. Lesson getLesson(Id lessonId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Lesson
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Lesson
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Lesson
and retained for compatibility.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.lessonId
- Id
of the Lesson
NotFoundException
- lessonId
not foundNullArgumentException
- lessonId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. LessonList getLessonsByIds(IdList lessonIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
LessonList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
lessonsspecified 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 Lessons
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.lessonIds
- the list of Ids
to retrieve Lesson
listNotFoundException
- an Id was
not foundNullArgumentException
- lessonIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsByGenusType(Type lessonGenusType) throws OperationFailedException, PermissionDeniedException
LessonList
corresponding to the given lesson
genus Type
which does not include lessonsof genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
lessonsor an error results. Otherwise, the returned list may contain
only those lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.lessonGenusType
- a lesson genus type Lesson
listNullArgumentException
- lessonGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsByParentGenusType(Type lessonGenusType) throws OperationFailedException, PermissionDeniedException
LessonList
corresponding to the given lesson
genus Type
and include any additional lessonswith genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
lessonsor an error results. Otherwise, the returned list may contain
only those lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.lessonGenusType
- a lesson genus type Lesson
listNullArgumentException
- lessonGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsByRecordType(Type lessonRecordType) throws OperationFailedException, PermissionDeniedException
LessonList
containing the given lesson record
Type.
In plenary mode, the returned list contains all known
lessonsor an error results. Otherwise, the returned list may contain
only those lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.lessonRecordType
- a lesson record type Lesson
listNullArgumentException
- lessonRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
LessonList
effective sduring the entire given
date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.from
- s atsrting dateto
- an ending date Lesson
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForPlan(Id planId) throws OperationFailedException, PermissionDeniedException
LessonList
for the given plan Id.
In plenary mode, the returned list contains all known
lessons or an error results. Otherwise, the returned list may contain
only those lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.planId
- a plan Id
Lesson
listNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForPlanOnDate(Id planId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
LessonList
for a plan effective during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.planId
- a plan Id
from
- s atsrting dateto
- an ending date Lesson
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- planId, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForDocet(Id docetId) throws OperationFailedException, PermissionDeniedException
LessonList
for the given docet Id.
In plenary mode, the returned list contains all known
lessonsor an error results. Otherwise, the returned list may contain
only those lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.docetId
- a docet Id
Lesson
listNullArgumentException
- docetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForDocetOnDate(Id docetId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
LessonList
for a docet effective sduring the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.docetId
- a docet Id
from
- s atsrting dateto
- an ending date Lesson
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- docetId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForPlanAndDocet(Id planId, Id docetId) throws OperationFailedException, PermissionDeniedException
LessonList
for the given plan and docet.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.planId
- a plan Id
docetId
- a docet Id
Lesson
listNullArgumentException
- planId
or
docetId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsForPlanAndDocetOnDate(Id planId, Id docetId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
LessonList
for a plan and docet effective during
the entire given date range inclusive but not confined to the date
range.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned.planId
- a plan Id
docetId
- a docet Id
from
- s atsrting dateto
- an ending date Lesson
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- planId, docetId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessons() throws OperationFailedException, PermissionDeniedException
Lessons.
In plenary mode, the returned list contains all known lessonsor an
error results. Otherwise, the returned list may contain only those
lessonsthat are accessible through this session.
In effective mode, lessons are returned that are currently effective.
In any effective mode, effective lessons and those currently expired
are returned. Lessons
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.