public interface CourseCatalogLookupSession extends OsidSession
This session provides methods for retrieving CourseCatalog
objects. The CourseCatalog
represents a collection
of courses, offerings and tems.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
CourseCatalogs
it can access, without breaking execution. However,
an assessment may only be useful if all CourseCatalogs
referenced by it are available, and a test-taking application may
sacrifice some interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCourseCatalogs()
Tests if this user can perform
CourseCatalog lookups. |
CourseCatalog |
getCourseCatalog(Id courseCatalogId)
Gets the
CourseCatalog specified by its Id. |
CourseCatalogList |
getCourseCatalogs()
Gets all
CourseCatalogs. |
CourseCatalogList |
getCourseCatalogsByGenusType(Type courseCatalogGenusType)
Gets a
CourseCatalogList corresponding to the given
course catalog genus Type which does not include course
catalogs of types derived from the specified Type. |
CourseCatalogList |
getCourseCatalogsByIds(IdList courseCatalogIds)
Gets a
CourseCatalogList corresponding to the given
IdList. |
CourseCatalogList |
getCourseCatalogsByParentGenusType(Type courseCatalogGenusType)
Gets a
CourseCatalogList corresponding to the given
course catalog genus Type and include any additional
course catalogs with genus types derived from the specified
Type. |
CourseCatalogList |
getCourseCatalogsByProvider(Id resourceId)
Gets a
CourseCatalogList from the given provider. |
CourseCatalogList |
getCourseCatalogsByRecordType(Type courseCatalogRecordType)
Gets a
CourseCatalogList containing the given course
catalog record Type. |
void |
useComparativeCourseCatalogView()
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 |
usePlenaryCourseCatalogView()
A complete view of the
CourseCatalog returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCourseCatalogs()
CourseCatalog
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCatalogView()
CourseCatalog
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. CourseCatalog getCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
CourseCatalog
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CourseCatalog
and retained for
compatibility.courseCatalogId
- Id
of the CourseCatalog
NotFoundException
- courseCatalogId
not
foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CourseCatalogList getCourseCatalogsByIds(IdList courseCatalogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalogList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the course catalogs 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 CourseCatalogs
may be omitted
from the list and may present the elements in any order including
returning a unique set.courseCatalogIds
- the list of Ids
to retrieve CourseCatalog
listNotFoundException
- an Id was
not foundNullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByGenusType(Type courseCatalogGenusType) throws OperationFailedException, PermissionDeniedException
CourseCatalogList
corresponding to the given
course catalog genus Type
which does not include course
catalogs of types derived from the specified Type.
In
plenary mode, the returned list contains all known course catalogs or
an error results. Otherwise, the returned list may contain only those
course catalogs that are accessible through this session.courseCatalogGenusType
- a course catalog genus type CourseCatalog
listNullArgumentException
- courseCatalogGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByParentGenusType(Type courseCatalogGenusType) throws OperationFailedException, PermissionDeniedException
CourseCatalogList
corresponding to the given
course catalog genus Type
and include any additional
course catalogs with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
course catalogs or an error results. Otherwise, the returned list may
contain only those course catalogs that are accessible through this
session.courseCatalogGenusType
- a course catalog genus type CourseCatalog
listNullArgumentException
- courseCatalogGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByRecordType(Type courseCatalogRecordType) throws OperationFailedException, PermissionDeniedException
CourseCatalogList
containing the given course
catalog record Type.
In plenary mode, the returned list
contains all known course catalogs or an error results. Otherwise, the
returned list may contain only those course catalogs that are
accessible through this session.courseCatalogRecordType
- a course catalog record type CourseCatalog
listNullArgumentException
- courseCatalogRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
CourseCatalogList
from the given provider.
In plenary mode, the returned list contains all known
course catalogs or an error results. Otherwise, the returned list may
contain only those course catalogs that are accessible through this
session.resourceId
- a resource Id
CourseCatalog
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogs() throws OperationFailedException, PermissionDeniedException
CourseCatalogs.
In plenary mode, the returned
list contains all known course catalogs or an error results.
Otherwise, the returned list may contain only those course catalogs
that are accessible through this session. CourseCatalogs
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.