public interface KeySmartAgencySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An KeyQuery
can be retrieved from this session
and mapped to this Agency
to create a virtual collection of
Keys.
The keys may be sequenced using the
KeySearchOrder
from this session.
This Agency
has a default query that matches any key
and a default search order that specifies no sequencing. The queries may
be examined using an KeyQueryInspector.
The query may be
modified by converting the inspector back to an KeyQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyKeyQuery(KeyQuery keyQuery)
Applies an key query to this agency.
|
void |
applyKeySequencing(KeySearchOrder keySearchOrder)
Applies an key search order to this agency.
|
boolean |
canManageSmartAgencies()
Tests if this user can manage smart agencies.
|
Agency |
getAgency()
Gets the
Agency associated with this session. |
Id |
getAgencyId()
Gets the
Agency Id associated with this
session. |
KeyQuery |
getKeyQuery()
Gets an key query.
|
KeyQuery |
getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)
Gets an key query from an inspector.
|
KeySearchOrder |
getKeySearchOrder()
Gets an key search order.
|
KeyQueryInspector |
inspectKeyQuery()
Gets an key query inspector for this agency.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAgencyId()
Agency
Id
associated with this
session. Agency Id
associated with this sessionmandatory
- This method must be implemented. Agency getAgency() throws OperationFailedException, PermissionDeniedException
Agency
associated with this session. Agency
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartAgencies()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart agency management is not
authorized, true
otherwisemandatory
- This method must be implemented. KeyQuery getKeyQuery()
mandatory
- This method must be implemented. KeySearchOrder getKeySearchOrder()
mandatory
- This method must be implemented. void applyKeyQuery(KeyQuery keyQuery) throws OperationFailedException, PermissionDeniedException
keyQuery
- the key queryNullArgumentException
- keyQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- keyQuery
not of
this servicemandatory
- This method must be implemented. KeyQueryInspector inspectKeyQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyKeySequencing(KeySearchOrder keySearchOrder) throws OperationFailedException, PermissionDeniedException
keySearchOrder
- the key search orderNullArgumentException
- keySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- keySearchOrder
not of this servicemandatory
- This method must be implemented. KeyQuery getKeyQueryFromInspector(KeyQueryInspector keyQueryInspector)
keyQueryInspector
- a query inspectorNullArgumentException
- keyQueryInspector
is null
UnsupportedException
- keyQueryInspector
is not of this servicemandatory
- This method must be implemented.