public interface AppointmentSmartRealmSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AppointmentQuery
can be retrieved from this
session and mapped to this Realm
to create a virtual
collection of Appointments.
The appointments may be
sequenced using the AppointmentSearchOrder
from this
session.
This Realm
has a default query that matches any
appointment and a default search order that specifies no sequencing. The
queries may be examined using an AppointmentQueryInspector.
The query may be modified by converting the inspector back to an
AppointmentQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAppointmentQuery(AppointmentQuery appointmentQuery)
Applies an appointment query to this realm.
|
void |
applyAppointmentSequencing(AppointmentSearchOrder appointmentSearchOrder)
Applies an appointment search order to this realm.
|
boolean |
canManageSmartRealms()
Tests if this user can manage smart realms.
|
AppointmentQuery |
getAppointmentQuery()
Gets an appointment query.
|
AppointmentQuery |
getAppointmentQueryFromInspector(AppointmentQueryInspector appointmentQueryInspector)
Gets an appointment query from an inspector.
|
AppointmentSearchOrder |
getAppointmentSearchOrder()
Gets an appointment search order.
|
Realm |
getRealm()
Gets the
Realm associated with this session. |
Id |
getRealmId()
Gets the
Realm Id associated with this
session. |
AppointmentQueryInspector |
inspectAppointmentQuery()
Gets an appointment 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. AppointmentQuery getAppointmentQuery()
mandatory
- This method must be implemented. AppointmentSearchOrder getAppointmentSearchOrder()
mandatory
- This method must be implemented. void applyAppointmentQuery(AppointmentQuery appointmentQuery) throws OperationFailedException, PermissionDeniedException
appointmentQuery
- the appointment queryNullArgumentException
- appointmentQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- appointmentQuery
not of this servicemandatory
- This method must be implemented. AppointmentQueryInspector inspectAppointmentQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAppointmentSequencing(AppointmentSearchOrder appointmentSearchOrder) throws OperationFailedException, PermissionDeniedException
appointmentSearchOrder
- the appointment search orderNullArgumentException
- appointmentSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- appointmentSearchOrder
not of this servicemandatory
- This method must be implemented. AppointmentQuery getAppointmentQueryFromInspector(AppointmentQueryInspector appointmentQueryInspector)
appointmentQueryInspector
- a query inspectorNullArgumentException
-
appointmentQueryInspector
is null
UnsupportedException
- appointmentQueryInspector
is not of this servicemandatory
- This method must be implemented.