public interface ProgramEntryLookupSession extends OsidSession
This session defines methods for retrieving entries.
This lookup session defines several views:
ProgramEntries
with the
ProgramEntry AdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Program entries may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the ProgramEntry.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProgramEntries()
Tests if this user can perform
ProgramEntry lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
ProgramEntryList |
getProgramEntries()
Gets all
ProgramEntries. |
ProgramEntryList |
getProgramEntriesByGenusType(Type programEntryGenusType)
Gets a
ProgramEntryList corresponding to the given
program entry genus Type which does not include program
entries of types derived from the specified Type. |
ProgramEntryList |
getProgramEntriesByIds(IdList programEntryId)
Gets a
ProgramEntryList corresponding to the given
IdList. |
ProgramEntryList |
getProgramEntriesByParentGenusType(Type programEntryGenusType)
Gets a
ProgramEntryList corresponding to the given
program entry genus Type and include any additional
program entries with genus types derived from the specified
Type. |
ProgramEntryList |
getProgramEntriesByRecordType(Type programEntryRecordType)
Gets a
ProgramEntryList containing the given program
entry record Type. |
ProgramEntryList |
getProgramEntriesForProgram(Id programId)
Gets a
ProgramEntryList for the given program. |
ProgramEntryList |
getProgramEntriesForProgramOnDate(Id programId,
DateTime from,
DateTime to)
Gets a
ProgramEntryList for the given program effective
during the entire given date range inclusive but not confined to the
date range. |
ProgramEntryList |
getProgramEntriesForStudent(Id resourceId)
Gets a
ProgramEntryList for the given student . |
ProgramEntryList |
getProgramEntriesForStudentAndProgram(Id resourceId,
Id programId)
Gets a
ProgramEntryList for the given student and
program . |
ProgramEntryList |
getProgramEntriesForStudentAndProgramOnDate(Id resourceId,
Id programId,
DateTime from,
DateTime to)
Gets a
ProgramEntryList for the given student and
program effective during the entire given date range inclusive but not
confined to the date range. |
ProgramEntryList |
getProgramEntriesForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
ProgramEntryList for the given student effective
during the entire given date range inclusive but not confined to the
date range. |
ProgramEntryList |
getProgramEntriesOnDate(DateTime from,
DateTime to)
Gets a
ProgramEntryList effective during the entire
given date range inclusive but not confined to the date range. |
ProgramEntry |
getProgramEntry(Id programEntryId)
Gets the
ProgramEntry specified by its Id. |
void |
useAnyEffectiveProgramEntryView()
All program entries of any effective dates are returned by methods in
this session.
|
void |
useComparativeProgramEntryView()
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 |
useEffectiveProgramEntryView()
Only program entries 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 |
usePlenaryProgramEntryView()
A complete view of the
ProgramEntry 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 canLookupProgramEntries()
ProgramEntry
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 useComparativeProgramEntryView()
mandatory
- This method is must be implemented. void usePlenaryProgramEntryView()
ProgramEntry
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 useEffectiveProgramEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveProgramEntryView()
mandatory
- This method is must be implemented. ProgramEntry getProgramEntry(Id programEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProgramEntry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ProgramEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ProgramEntry
and retained for
compatibility.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programEntryId
- the Id
of the
ProgramEntry
to retrieve ProgramEntry
NotFoundException
- no ProgramEntry
found with the given Id
NullArgumentException
- programEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesByIds(IdList programEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProgramEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
program entries 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 ProgramEntries
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programEntryId
- the list of Ids
to retrieve ProgramEntryList
NotFoundException
- an Id was
not foundNullArgumentException
- programEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesByGenusType(Type programEntryGenusType) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
corresponding to the given
program entry genus Type
which does not include program
entries of types derived from the specified Type.
In plenary mode, the returned list contains all known
program entries or an error results. Otherwise, the returned list may
contain only those program entries that are accessible through this
session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programEntryGenusType
- a program entry genus type ProgramEntryList
NullArgumentException
- programEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesByParentGenusType(Type programEntryGenusType) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
corresponding to the given
program entry genus Type
and include any additional
program entries with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
program entries or an error results. Otherwise, the returned list may
contain only those program entries that are accessible through this
session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programEntryGenusType
- a program entry genus type ProgramEntryList
NullArgumentException
- programEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesByRecordType(Type programEntryRecordType) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
containing the given program
entry record Type.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programEntryRecordType
- a program entry record type ProgramEntryList
listNullArgumentException
- programEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.from
- starting dateto
- ending date ProgramEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given student .
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.resourceId
- a resource Id
ProgramEntryList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given student effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.resourceId
- a resource Id
from
- starting dateto
- ending date ProgramEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForProgram(Id programId) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given program.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programId
- a program Id
ProgramEntryList
listNullArgumentException
- programId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForProgramOnDate(Id programId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given program effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.programId
- a program Id
from
- starting dateto
- ending date ProgramEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- programId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForStudentAndProgram(Id resourceId, Id programId) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given student and
program .
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.resourceId
- a resource Id
programId
- a program Id
ProgramEntryList
listNullArgumentException
- resourceId
or
programId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntriesForStudentAndProgramOnDate(Id resourceId, Id programId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProgramEntryList
for the given student and
program effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned.resourceId
- a resource Id
programId
- a program Id
from
- starting dateto
- ending date ProgramEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, programId,
from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramEntryList getProgramEntries() throws OperationFailedException, PermissionDeniedException
ProgramEntries.
In plenary mode, the returned list contains all known program entries
or an error results. Otherwise, the returned list may contain only
those program entries that are accessible through this session.
In effective mode, program entries are returned that are currently
effective. In any effective mode, effective program entries and those
currently expired are returned. ProgramEntries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.