public interface AwardSmartAcademySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AwardQuery
can be retrieved from this session
and mapped to this Academy
to create a virtual collection
of Awards.
The awards may be sequenced using the
AwardSearchOrder
from this session.
This Academy
has a default query that matches any award
and a default search order that specifies no sequencing. The queries may
be examined using an AwardQueryInspector.
The query may be
modified by converting the inspector back to an AwardQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAwardQuery(AwardQuery awardQuery)
Applies an award query to this academy.
|
void |
applyAwardSequencing(AwardSearchOrder awardSearchOrder)
Applies an award 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. |
AwardQuery |
getAwardQuery()
Gets an award query.
|
AwardQuery |
getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)
Gets an award query from an inspector.
|
AwardSearchOrder |
getAwardSearchOrder()
Gets an award search order.
|
AwardQueryInspector |
inspectAwardQuery()
Gets an award 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. AwardQuery getAwardQuery()
mandatory
- This method must be implemented. AwardSearchOrder getAwardSearchOrder()
mandatory
- This method must be implemented. void applyAwardQuery(AwardQuery awardQuery) throws OperationFailedException, PermissionDeniedException
awardQuery
- the award queryNullArgumentException
- awardQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- awardQuery
not of
this servicemandatory
- This method must be implemented. AwardQueryInspector inspectAwardQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAwardSequencing(AwardSearchOrder awardSearchOrder) throws OperationFailedException, PermissionDeniedException
awardSearchOrder
- the award search orderNullArgumentException
- awardSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- awardSearchOrder
not of this servicemandatory
- This method must be implemented. AwardQuery getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)
awardQueryInspector
- a query inspectorNullArgumentException
- awardQueryInspector
is null
UnsupportedException
- awardQueryInspector
is not of this servicemandatory
- This method must be implemented.