public interface PositionSmartRealmSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PositionQuery
can be retrieved from this
session and mapped to this Realm
to create a virtual
collection of Positions.
The positions may be sequenced
using the PositionSearchOrder
from this session.
This Realm
has a default query that matches any
position and a default search order that specifies no sequencing. The
queries may be examined using a PositionQueryInspector.
The
query may be modified by converting the inspector back to a
PositionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPositionQuery(PositionQuery positionQuery)
Applies a position query to this realm.
|
void |
applyPositionSequencing(PositionSearchOrder positionSearchOrder)
Applies a position search order to this realm.
|
boolean |
canManageSmartRealms()
Tests if this user can manage smart realms.
|
PositionQuery |
getPositionQuery()
Gets a position query.
|
PositionQuery |
getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)
Gets a position query from an inspector.
|
PositionSearchOrder |
getPositionSearchOrder()
Gets a position search order.
|
Realm |
getRealm()
Gets the
Realm associated with this session. |
Id |
getRealmId()
Gets the
Realm Id associated with this
session. |
PositionQueryInspector |
inspectPositionQuery()
Gets a position query inspector for this realm.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRealmId()
Realm
Id
associated with this
session. Realm Id
associated with this sessionmandatory
- This method must be implemented. Realm getRealm() throws OperationFailedException, PermissionDeniedException
Realm
associated with this session. Realm
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartRealms()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart realm management is not
authorized, true
otherwisemandatory
- This method must be implemented. PositionQuery getPositionQuery()
mandatory
- This method must be implemented. PositionSearchOrder getPositionSearchOrder()
mandatory
- This method must be implemented. void applyPositionQuery(PositionQuery positionQuery) throws OperationFailedException, PermissionDeniedException
positionQuery
- the position queryNullArgumentException
- positionQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- positionQuery
not
of this servicemandatory
- This method must be implemented. PositionQueryInspector inspectPositionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPositionSequencing(PositionSearchOrder positionSearchOrder) throws OperationFailedException, PermissionDeniedException
positionSearchOrder
- the position search orderNullArgumentException
- positionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- positionSearchOrder
not of this servicemandatory
- This method must be implemented. PositionQuery getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)
positionQueryInspector
- a query inspectorNullArgumentException
- positionQueryInspector
is null
UnsupportedException
- positionQueryInspector
is not of this servicemandatory
- This method must be implemented.