public interface ConferralQuerySession extends OsidSession
This session provides methods for searching Conferral
objects. The search query is constructed using the ConferralQuery.
The conferral record Type
also specifies the record
for the award query.
Conferrals may have a query record indicated by their respective
record types. The query record is accessed via the ConferralQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchConferrals()
Tests if this user can perform susbcription searches.
|
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
ConferralQuery |
getConferralQuery()
Gets a conferral query.
|
ConferralList |
getConferralsByQuery(ConferralQuery conferralQuery)
Gets a list of conferrals matching the given conferral query.
|
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 canSearchConferrals()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish 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. ConferralQuery getConferralQuery()
mandatory
- This method must be implemented. ConferralList getConferralsByQuery(ConferralQuery conferralQuery) throws OperationFailedException, PermissionDeniedException
conferralQuery
- the conferral query ConferralList
NullArgumentException
- conferralQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- conferralQuery
is
not of this servicemandatory
- This method must be implemented.