public interface AppointmentQuerySession extends OsidSession
This session provides methods for querying Appointment
objects. The search query is constructed using the
AppointmentQuery.
This session defines views that offer differing behaviors for searching.
Appointments may have a query record indicated by their respective
record types. The query record is accessed via the
AppointmentQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAppointments()
Tests if this user can perform
Appointment searches. |
AppointmentQuery |
getAppointmentQuery()
Gets an appointment query.
|
AppointmentList |
getAppointmentsByQuery(AppointmentQuery appointmentQuery)
Gets a list of appointments matching the given appointment query.
|
Realm |
getRealm()
Gets the
Realm associated with this session. |
Id |
getRealmId()
Gets the
Realm Id associated with this
session. |
void |
useFederatedRealmView()
Federates the view for methods in this session.
|
void |
useIsolatedRealmView()
Isolates the view for methods in this session.
|
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAppointments()
Appointment
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may wish not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedRealmView()
mandatory
- This method is must be implemented. void useIsolatedRealmView()
mandatory
- This method is must be implemented. AppointmentQuery getAppointmentQuery()
mandatory
- This method must be implemented. AppointmentList getAppointmentsByQuery(AppointmentQuery appointmentQuery) throws OperationFailedException, PermissionDeniedException
appointmentQuery
- the appointment query AppointmentList
NullArgumentException
- appointmentQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- appointmentQuery
is not of this servicemandatory
- This method must be implemented.