public interface PersonSmartRealmSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PersonQuery
can be retrieved from this session
and mapped to this Realm
to create a virtual collection of
Persons.
The persons may be sequenced using the
PersonSearchOrder
from this session.
This Realm
has a default query that matches any person
and a default search order that specifies no sequencing. The queries may
be examined using a PersonQueryInspector.
The query may be
modified by converting the inspector back to a PersonQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPersonQuery(PersonQuery personQuery)
Applies a person query to this realm.
|
void |
applyPersonSequencing(PersonSearchOrder personSearchOrder)
Applies a person search order to this realm.
|
boolean |
canManageSmartRealms()
Tests if this user can manage smart realms.
|
PersonQuery |
getPersonQuery()
Gets a person query.
|
PersonQuery |
getPersonQueryFromInspector(PersonQueryInspector personQueryInspector)
Gets a person query from an inspector.
|
PersonSearchOrder |
getPersonSearchOrder()
Gets a person search order.
|
Realm |
getRealm()
Gets the
Realm associated with this session. |
Id |
getRealmId()
Gets the
Realm Id associated with this
session. |
PersonQueryInspector |
inspectPersonQuery()
Gets a person 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. PersonQuery getPersonQuery()
mandatory
- This method must be implemented. PersonSearchOrder getPersonSearchOrder()
mandatory
- This method must be implemented. void applyPersonQuery(PersonQuery personQuery) throws OperationFailedException, PermissionDeniedException
personQuery
- the person queryNullArgumentException
- personQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- personQuery
not
of this servicemandatory
- This method must be implemented. PersonQueryInspector inspectPersonQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPersonSequencing(PersonSearchOrder personSearchOrder) throws OperationFailedException, PermissionDeniedException
personSearchOrder
- the person search orderNullArgumentException
- personSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- personSearchOrder
not of this servicemandatory
- This method must be implemented. PersonQuery getPersonQueryFromInspector(PersonQueryInspector personQueryInspector)
personQueryInspector
- a query inspectorNullArgumentException
- personQueryInspector
is null
UnsupportedException
- personQueryInspector
is not of this servicemandatory
- This method must be implemented.