public interface PlanCourseCatalogSession extends OsidSession
This session provides methods to retrieve Plan
to
CourseCatalog
mappings. A Plan
may appear in
multiple Course Catalogs.
Each CourseCatalog
may have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPlanCourseCatalogMappings()
Tests if this user can perform lookups of plan/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByPlan(Id planId)
Gets the list of
CourseCatalog Ids
mapped to a Plan. |
CourseCatalogList |
getCourseCatalogsByPlan(Id planId)
Gets the list of
CourseCatalog objects mapped to a
Plan. |
IdList |
getPlanIdsByCourseCatalog(Id courseCatalogId)
Gets the list of Plan Ids associated with an
CourseCatalog. |
IdList |
getPlanIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Plan Ids corresponding to a list of
CourseCatalog objects. |
PlanList |
getPlansByCourseCatalog(Id courseCatalogId)
Gets the list of
Plans associated with an
CourseCatalog. |
PlanList |
getPlansByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Plans corresponding to a list of
Course Catalogs. |
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
Plan and CourseCatalog
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPlanCourseCatalogMappings()
PERMISSION_DENIED.
This is intendedas a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCatalogView()
Plan
and 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. IdList getPlanIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog.
courseCatalogId
- Id
of an CourseCatalog.
Ids
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Plans
associated with an
CourseCatalog.
courseCatalogId
- Id
of an CourseCatalog
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPlanIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Plan Ids
corresponding to a list of
CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Plans
corresponding to a list of
Course Catalogs.
courseCatalogIds
- list of course catalog Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByPlan(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a Plan.
planId
- Id
of a Plan
Ids
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByPlan(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Plan.
planId
- Id
of a Plan
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.