public interface AwardEntryLookupSession extends OsidSession
This session defines methods for retrieving entriesand entry components.
This lookup session defines several views:
AwardEntries
with the AwardEntry
AdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
AwardEntries may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the AwardEntry.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAwardEntries()
Tests if this user can perform
AwardEntry lookups. |
AwardEntryList |
getAwardEntries()
Gets all
AwardEntries. |
AwardEntryList |
getAwardEntriesByGenusType(Type awardEntryGenusType)
Gets an
AwardEntryList corresponding to the given award
entry genus Type which does not include awards of types
derived from the specified Type. |
AwardEntryList |
getAwardEntriesByIds(IdList awardEntryId)
Gets an
AwardEntryList corresponding to the given
IdList. |
AwardEntryList |
getAwardEntriesByParentGenusType(Type awardEntryGenusType)
Gets an
AwardEntryList corresponding to the given award
entry genus Type and include any additional awards with
genus types derived from the specified Type. |
AwardEntryList |
getAwardEntriesByRecordType(Type awardEntryRecordType)
Gets an
AwardEntryList containing the given award entry
record Type. |
AwardEntryList |
getAwardEntriesForAward(Id awardId)
Gets an
AwardEntryList for the given award. |
AwardEntryList |
getAwardEntriesForAwardOnDate(Id awardId,
DateTime from,
DateTime to)
Gets an
AwardEntryList for the given award effective
during the entire given date range inclusive but not confined to the
date range. |
AwardEntryList |
getAwardEntriesForStudent(Id resourceId)
Gets an
AwardEntryList for the given student . |
AwardEntryList |
getAwardEntriesForStudentAndAward(Id resourceId,
Id awardId)
Gets an
AwardEntryList for the given student and award
. |
AwardEntryList |
getAwardEntriesForStudentAndAwardOnDate(Id resourceId,
Id awardId,
DateTime from,
DateTime to)
Gets an
AwardEntryList for the given student and award
effective during the entire given date range inclusive but not
confined to the date range. |
AwardEntryList |
getAwardEntriesForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets an
AwardEntryList for the given student effective
during the entire given date range inclusive but not confined to the
date range. |
AwardEntryList |
getAwardEntriesOnDate(DateTime from,
DateTime to)
Gets an
AwardEntryList effective during the entire
given date range inclusive but not confined to the date range. |
AwardEntry |
getAwardEntry(Id awardEntryId)
Gets the
AwardEntry specified by its Id. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
useAnyEffectiveAwardEntryView()
All award entries of any effective dates are returned by methods in
this session.
|
void |
useComparativeAwardEntryView()
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 |
useEffectiveAwardEntryView()
Only award 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 |
usePlenaryAwardEntryView()
A complete view of the
AwardEntry 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 canLookupAwardEntries()
AwardEntry
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 useComparativeAwardEntryView()
mandatory
- This method is must be implemented. void usePlenaryAwardEntryView()
AwardEntry
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 useEffectiveAwardEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveAwardEntryView()
mandatory
- This method is must be implemented. AwardEntry getAwardEntry(Id awardEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardEntry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AwardEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AwardEntry
and retained for
compatibility.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardEntryId
- the Id
of the AwardEntry
to retrieve chronicle
NotFoundException
- no AwardEntry
found
with the given Id
NullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByIds(IdList awardEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
awards 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 AwardEntries
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardEntryId
- the list of Ids
to retrieve AwardEntryList
NotFoundException
- an Id was
not foundNullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByGenusType(Type awardEntryGenusType) throws OperationFailedException, PermissionDeniedException
AwardEntryList
corresponding to the given award
entry genus Type
which does not include awards of types
derived from the specified Type.
In plenary mode, the returned list contains all known
awards or an error results. Otherwise, the returned list may contain
only those awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardEntryGenusType
- an award entry genus type AwardEntryList
NullArgumentException
- awardEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByParentGenusType(Type awardEntryGenusType) throws OperationFailedException, PermissionDeniedException
AwardEntryList
corresponding to the given award
entry genus Type
and include any additional awards with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
awards or an error results. Otherwise, the returned list may contain
only those awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardEntryGenusType
- an award entry genus type AwardEntryList
NullArgumentException
- awardEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesByRecordType(Type awardEntryRecordType) throws OperationFailedException, PermissionDeniedException
AwardEntryList
containing the given award entry
record Type.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardEntryRecordType
- an award entry record type AwardEntryList
listNullArgumentException
- awardEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AwardEntryList
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.from
- starting dateto
- ending date AwardEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AwardEntryList
for the given student .
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.resourceId
- a resource Id
AwardEntryList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AwardEntryList
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 awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.resourceId
- a resource Id
from
- starting dateto
- ending date AwardEntryList
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. AwardEntryList getAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardEntryList
for the given award.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardId
- an award Id
AwardEntryList
listNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForAwardOnDate(Id awardId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AwardEntryList
for the given award effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.awardId
- an award Id
from
- starting dateto
- ending date AwardEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- awardId, from
,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForStudentAndAward(Id resourceId, Id awardId) throws OperationFailedException, PermissionDeniedException
AwardEntryList
for the given student and award
.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.resourceId
- a resource Id
awardId
- an award Id
AwardEntryList
listNullArgumentException
- resourceId
or
awardId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntriesForStudentAndAwardOnDate(Id resourceId, Id awardId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AwardEntryList
for the given student and award
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned.resourceId
- a resource Id
awardId
- an award Id
from
- starting dateto
- ending date AwardEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, awardId,
from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardEntryList getAwardEntries() throws OperationFailedException, PermissionDeniedException
AwardEntries.
In plenary mode, the returned list contains all known awards or an
error results. Otherwise, the returned list may contain only those
awards that are accessible through this session.
In effective mode, award entries are returned that are currently
effective. In any effective mode, effective award entries and those
currently expired are returned. AwardEntries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.