public interface ConferralSmartAcademySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ConferralQuery
can be retrieved from this
session and mapped to this Academy
to create a virtual
collection of Conferrals.
The awards may be sequenced using
the ConferralSearchOrder
from this session.
This Academy
has a default query that matches any
conferral and a default search order that specifies no sequencing. The
queries may be examined using a ConferralQueryInspector.
The query may be modified by converting the inspector back to a
ConferralQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyConferralQuery(ConferralQuery conferralQuery)
Applies a conferral query to this academy.
|
void |
applyConferralSequencing(ConferralSearchOrder conferralSearchOrder)
Applies a conferral 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. |
ConferralQuery |
getConferralQuery()
Gets a conferral query.
|
ConferralQuery |
getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)
Gets a conferral query from an inspector.
|
ConferralSearchOrder |
getConferralSearchOrder()
Gets a conferral search order.
|
ConferralQueryInspector |
inspectConferralQuery()
Gets a conferral 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. ConferralQuery getConferralQuery()
mandatory
- This method must be implemented. ConferralSearchOrder getConferralSearchOrder()
mandatory
- This method must be implemented. void applyConferralQuery(ConferralQuery conferralQuery) throws OperationFailedException, PermissionDeniedException
conferralQuery
- the conferral queryNullArgumentException
- conferralQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- conferralQuery
not of this servicemandatory
- This method must be implemented. ConferralQueryInspector inspectConferralQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyConferralSequencing(ConferralSearchOrder conferralSearchOrder) throws OperationFailedException, PermissionDeniedException
conferralSearchOrder
- the conferral search orderNullArgumentException
- conferralSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- conferralSearchOrder
not of this servicemandatory
- This method must be implemented. ConferralQuery getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)
conferralQueryInspector
- a query inspectorNullArgumentException
- conferralQueryInspector
is null
UnsupportedException
- conferralQueryInspector
is not of this servicemandatory
- This method must be implemented.