public interface ConvocationSmartAcademySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ConvocationQuery
can be retrieved from this
session and mapped to this Academy
to create a virtual
collection of Convocations.
The awards may be sequenced
using the ConvocationSearchOrder
from this session.
This Academy
has a default query that matches any
convocation and a default search order that specifies no sequencing. The
queries may be examined using a ConvocationQueryInspector.
The query may be modified by converting the inspector back to a
ConvocationQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyConvocationQuery(ConvocationQuery convocationQuery)
Applies a convocation query to this academy.
|
void |
applyConvocationSequencing(ConvocationSearchOrder convocationSearchOrder)
Applies a convocation search order to this academy.
|
boolean |
canManageSmartAcademies()
Tests if this user can manage smart academies.
|
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.
|
ConvocationQuery |
getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)
Gets a convocation query from an inspector.
|
ConvocationSearchOrder |
getConvocationSearchOrder()
Gets a convocation search order.
|
ConvocationQueryInspector |
inspectConvocationQuery()
Gets a convocation query inspector for this academy.
|
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. Academy
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartAcademies()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart academy management is not
authorized, true
otherwisemandatory
- This method must be implemented. ConvocationQuery getConvocationQuery()
mandatory
- This method must be implemented. ConvocationSearchOrder getConvocationSearchOrder()
mandatory
- This method must be implemented. void applyConvocationQuery(ConvocationQuery convocationQuery) throws OperationFailedException, PermissionDeniedException
convocationQuery
- the convocation queryNullArgumentException
- convocationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- convocationQuery
not of this servicemandatory
- This method must be implemented. ConvocationQueryInspector inspectConvocationQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyConvocationSequencing(ConvocationSearchOrder convocationSearchOrder) throws OperationFailedException, PermissionDeniedException
convocationSearchOrder
- the convocation search orderNullArgumentException
- convocationSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- convocationSearchOrder
not of this servicemandatory
- This method must be implemented. ConvocationQuery getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)
convocationQueryInspector
- a query inspectorNullArgumentException
-
convocationQueryInspector
is null
UnsupportedException
- convocationQueryInspector
is not of this servicemandatory
- This method must be implemented.