public interface ConvocationQuerySession extends OsidSession
This session provides methods for searching Convocation
objects. The search query is constructed using the
ConvocationQuery.
The award record Type
also
specifies the record for the award query.
Convocations may have a query record indicated by their respective
record types. The query record is accessed via the
ConvocationQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchConvocations()
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. |
ConvocationQuery |
getConvocationQuery()
Gets a convocation query.
|
ConvocationList |
getConvocationsByQuery(ConvocationQuery convocationQuery)
Gets a list of convocations matching the given convocation 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 canSearchConvocations()
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. ConvocationQuery getConvocationQuery()
mandatory
- This method must be implemented. ConvocationList getConvocationsByQuery(ConvocationQuery convocationQuery) throws OperationFailedException, PermissionDeniedException
convocationQuery
- the convocation query ConvocationList
NullArgumentException
- convocationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- convocationQuery
is not of this servicemandatory
- This method must be implemented.