public interface AwardLookupSession extends OsidSession
This session provides methods for retrieving Award
objects. The Award
represents a collection of conferrals.
This session defines views that offer differing behaviors when retrieving multiple objects.
AwardAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAwards()
Tests if this user can perform
Award lookups. |
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
Award |
getAward(Id awardId)
Gets the
Award specified by its Id. |
AwardList |
getAwards()
Gets all
Awards. |
AwardList |
getAwardsByGenusType(Type awardGenusType)
Gets an
AwardList corresponding to the given award
genus Type which does not include awards of genus types
derived from the specified Type. |
AwardList |
getAwardsByIds(IdList awardIds)
Gets an
AwardList corresponding to the given
IdList. |
AwardList |
getAwardsByParentGenusType(Type awardGenusType)
Gets an
AwardList corresponding to the given award
genus Type and include any additional awards with genus
types derived from the specified Type. |
AwardList |
getAwardsByRecordType(Type awardRecordType)
Gets an
AwardList containing the given award record
Type. |
void |
useComparativeAwardView()
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 |
useFederatedAcademyView()
Federates the view for methods in this session.
|
void |
useIsolatedAcademyView()
Isolates the view for methods in this session.
|
void |
usePlenaryAwardView()
A complete view of the
Award returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAcademyId()
Academy
Id
associated with this
session. Academy Id
associated with this sessionmandatory
- This method must be implemented. Academy getAcademy() throws OperationFailedException, PermissionDeniedException
Academy
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAwards()
Award
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 useComparativeAwardView()
mandatory
- This method is must be implemented. void usePlenaryAwardView()
Award
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 useFederatedAcademyView()
mandatory
- This method is must be implemented. void useIsolatedAcademyView()
mandatory
- This method is must be implemented. Award getAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Award
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Award
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Award
and retained for compatibility.awardId
- Id
of the Award
NotFoundException
- awardId
not foundNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AwardList getAwardsByIds(IdList awardIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardList
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 Awards
may be omitted from the list and
may present the elements in any order including returning a unique
set.awardIds
- the list of Ids
to retrieve Award
listNotFoundException
- an Id was
not foundNullArgumentException
- awardIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardList getAwardsByGenusType(Type awardGenusType) throws OperationFailedException, PermissionDeniedException
AwardList
corresponding to the given award
genus Type
which does not include awards of 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.awardGenusType
- an award genus type Award
listNullArgumentException
- awardGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardList getAwardsByParentGenusType(Type awardGenusType) throws OperationFailedException, PermissionDeniedException
AwardList
corresponding to the given award
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.awardGenusType
- an award genus type Award
listNullArgumentException
- awardGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardList getAwardsByRecordType(Type awardRecordType) throws OperationFailedException, PermissionDeniedException
AwardList
containing the given award 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.awardRecordType
- an award record type Award
listNullArgumentException
- awardRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardList getAwards() throws OperationFailedException, PermissionDeniedException
Awards.
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. Awards
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.