public interface PlanLookupSession extends OsidSession
This session defines methods for retrieving plans.
This lookup session defines several views:
PlanAdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPlans()
Tests if this user can lookup plans.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
Plan |
getPlan(Id planId)
Gets the
Plan specified by its Id. |
PlanList |
getPlans()
Gets all plans.
|
PlanList |
getPlansByGenusType(Type planGenusType)
Gets a
PlanList corresponding to the given plan genus
Type which does not include plans of genus types
derived from the specified Type. |
PlanList |
getPlansByIds(IdList planIds)
Gets a
PlanList corresponding to the given
IdList. |
PlanList |
getPlansByParentGenusType(Type planGenusType)
Gets a
PlanList corresponding to the given plan genus
Type and include any additional plans with genus types
derived from the specified Type. |
PlanList |
getPlansByRecordType(Type planRecordType)
Gets a
PlanList containing the given plan record
Type. |
PlanList |
getPlansForCourseOffering(Id courseOfferingId)
Gets a
PlanList for the given course offering
Id. |
PlanList |
getPlansForCourseOfferingOnDate(Id courseOfferingId,
DateTime from,
DateTime to)
Gets a
PlanList for a course offering effective during
the entire given date range inclusive but not confined to the date
range. |
PlanList |
getPlansForSyllabus(Id syllabusId)
Gets a
PlanList for the given syllabus Id. |
PlanList |
getPlansForSyllabusAndCourseOffering(Id syllabusId,
Id courseOfferingId)
Gets a
PlanList for the given syllabus and
course offering. |
PlanList |
getPlansForSyllabusAndCourseOfferingOnDate(Id syllabusId,
Id courseOfferingId,
DateTime from,
DateTime to)
Gets a
PlanList for a syllabus and course offering
effective during the entire given date range inclusive but not
confined to the date range. |
PlanList |
getPlansForSyllabusOnDate(Id syllabusId,
DateTime from,
DateTime to)
Gets a
PlanList for a syllabus effective during the
entire given date range inclusive but not confined to the date range. |
PlanList |
getPlansOnDate(DateTime from,
DateTime to)
Gets a
PlanList effective during the entire given date
range inclusive but not confined to the date range. |
void |
useAnyEffectivePlanView()
All plans of any effective dates are returned by methods in this
session.
|
void |
useComparativePlanView()
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 |
useEffectivePlanView()
Only plans 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 |
usePlenaryPlanView()
A complete view of the
Plan 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 canLookupPlans()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if plan lookup methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativePlanView()
mandatory
- This method is must be implemented. void usePlenaryPlanView()
Plan
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 useEffectivePlanView()
mandatory
- This method is must be implemented. void useAnyEffectivePlanView()
mandatory
- This method is must be implemented. Plan getPlan(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Plan
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Plan
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Plan
and retained for compatibility.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.planId
- the Id
of the Plan
to
retrieve Plan
NotFoundException
- no Plan
found with
the given Id
NullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByIds(IdList planIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PlanList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
plans 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 plans may be omitted from the list and may present the
elements in any order including returning a unique set.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.planIds
- the list of Ids
to retrieve Plan list
NotFoundException
- an Id was
not foundNullArgumentException
- planIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByGenusType(Type planGenusType) throws OperationFailedException, PermissionDeniedException
PlanList
corresponding to the given plan genus
Type
which does not include plans of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.planGenusType
- a plan genus type Plan
listNullArgumentException
- planGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByParentGenusType(Type planGenusType) throws OperationFailedException, PermissionDeniedException
PlanList
corresponding to the given plan genus
Type
and include any additional plans with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known plans or an
error results. Otherwise, the returned list may contain only those
plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.planGenusType
- a plan genus type Plan
listNullArgumentException
- planGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansByRecordType(Type planRecordType) throws OperationFailedException, PermissionDeniedException
PlanList
containing the given plan record
Type.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.planRecordType
- a plan record type Plan
listNullArgumentException
- planRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PlanList
effective during the entire given date
range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.from
- start of date rangeto
- end of date range Plan
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
PlanList
for the given syllabus Id.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.syllabusId
- a syllabus Id
Plan
listNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForSyllabusOnDate(Id syllabusId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PlanList
for a syllabus effective during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known plans or an
error results. Otherwise, the returned list may contain only those
plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.syllabusId
- a syllabus Id
from
- start of date rangeto
- end of date range Plan
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- syllabusId, from, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
PlanList
for the given course offering
Id.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.courseOfferingId
- a course offering Id
Plan
listNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForCourseOfferingOnDate(Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PlanList
for a course offering effective during
the entire given date range inclusive but not confined to the date
range.
In plenary mode, the returned list contains all known plans or an
error results. Otherwise, the returned list may contain only those
plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.courseOfferingId
- a course offering Id
from
- start of date rangeto
- end of date range Plan
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- courseOfferingId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForSyllabusAndCourseOffering(Id syllabusId, Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
PlanList
for the given syllabus and
course offering.
In plenary mode, the returned list contains all known
plans or an error results. Otherwise, the returned list may contain
only those plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.syllabusId
- a syllabus Id
courseOfferingId
- a course offering Id
Plan
listNullArgumentException
- syllabusId
or
courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlansForSyllabusAndCourseOfferingOnDate(Id syllabusId, Id courseOfferingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PlanList
for a syllabus and course offering
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known plans or an
error results. Otherwise, the returned list may contain only those
plans that are accessible through this session.
In effective mode, plans are returned that are currently effective. In
any effective mode, effective plans and those currently expired are
returned.syllabusId
- a syllabus Id
courseOfferingId
- a course offering Id
from
- start of date rangeto
- end of date range Plan
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- syllabusId,
courseOfferingId, from, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PlanList getPlans() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.