public interface AwardQuerySession extends OsidSession
This session provides methods for searching Award
objects. The search query is constructed using the AwardQuery.
The award record Type
also specifies the record for
the award query.
Awards may have a query record indicated by their respective record
types. The query record is accessed via the AwardQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAwards()
Tests if this user can perform
Award searches. |
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
AwardQuery |
getAwardQuery()
Gets an award query.
|
AwardList |
getAwardsByQuery(AwardQuery awardQuery)
Gets a list of
Awards matching the given search. |
void |
useFederatedAcademyView()
Federates the view for methods in this session.
|
void |
useIsolatedAcademyView()
Isolates the view for methods in this session.
|
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 canSearchAwards()
Award
searches. 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 opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedAcademyView()
mandatory
- This method is must be implemented. void useIsolatedAcademyView()
mandatory
- This method is must be implemented. AwardQuery getAwardQuery()
mandatory
- This method must be implemented. AwardList getAwardsByQuery(AwardQuery awardQuery) throws OperationFailedException, PermissionDeniedException
Awards
matching the given search.awardQuery
- the award query AwardList
NullArgumentException
- awardQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- awardQuery
is not
of this servicemandatory
- This method must be implemented.