public interface AppointmentLookupSession extends OsidSession
This session defines methods for retrieving appointments.
This lookup session defines several views:
AppointmentAdminSession.
The methods useFederatedRealmView()
and
useIsolatedRealmView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAppointments()
Tests if this user can examine this realm.
|
Appointment |
getAppointment(Id appointmentId)
Gets the
Appointment specified by its Id. |
AppointmentList |
getAppointments()
Gets all appointments.
|
AppointmentList |
getAppointmentsByGenusType(Type appointmentGenusType)
Gets an
AppointmentList corresponding to the given
appointment genus Type which does not include
appointments of types derived from the specified Type. |
AppointmentList |
getAppointmentsByIds(IdList appointmentIds)
Gets an
AppointmentList corresponding to the given
IdList. |
AppointmentList |
getAppointmentsByParentGenusType(Type appointmentGenusType)
Gets an
AppointmentList corresponding to the given
appointment genus Type and include any additional
appointments with genus types derived from the specified Type. |
AppointmentList |
getAppointmentsByRecordType(Type appointmentRecordType)
Gets an
AppointmentList containing the given
appointment record Type. |
AppointmentList |
getAppointmentsForPerson(Id personId)
Gets an
AppointmentList for the given person Id. |
AppointmentList |
getAppointmentsForPersonAndPosition(Id personId,
Id positionId)
Gets an
AppointmentList for the given person and
position. |
AppointmentList |
getAppointmentsForPersonAndPositionOnDate(Id personId,
Id positionId,
DateTime from,
DateTime to)
Gets an
AppointmentList corresponding to the given
person and position and effective during the entire given date range
inclusive but not confined to the date range. |
AppointmentList |
getAppointmentsForPersonOnDate(Id personId,
DateTime from,
DateTime to)
Gets a list of appointments for a resource and effective during the
entire given date range inclusive but not confined to the date range.
|
AppointmentList |
getAppointmentsForPosition(Id positionId)
Gets an
AppointmentList for the given position. |
AppointmentList |
getAppointmentsForPositionOnDate(Id positionId,
DateTime from,
DateTime to)
Gets a list of appointments for a position and effective during the
entire given date range inclusive but not confined to the date range.
|
AppointmentList |
getAppointmentsOnDate(DateTime from,
DateTime to)
Gets an
AppointmentList effective during the entire
given date range inclusive but not confined to the date range. |
Realm |
getRealm()
Gets the
Realm associated with this session. |
Id |
getRealmId()
Gets the
Realm Id associated with this
session. |
void |
useAnyEffectiveAppointmentView()
All appointments of any effective dates are returned by methods in
this session.
|
void |
useComparativeAppointmentView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveAppointmentView()
Only appointments whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedRealmView()
Federates the view for methods in this session.
|
void |
useIsolatedRealmView()
Isolates the view for methods in this session.
|
void |
usePlenaryAppointmentView()
A complete view of the
Appointment returns is desired. |
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 canLookupAppointments()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if realm reading methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeAppointmentView()
mandatory
- This method is must be implemented. void usePlenaryAppointmentView()
Appointment
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedRealmView()
mandatory
- This method is must be implemented. void useIsolatedRealmView()
mandatory
- This method is must be implemented. void useEffectiveAppointmentView()
mandatory
- This method is must be implemented. void useAnyEffectiveAppointmentView()
mandatory
- This method is must be implemented. Appointment getAppointment(Id appointmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Appointment
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Appointment
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an Appointment
and retained for
compatibility.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.appointmentId
- the Id
of the Appointment
to retrieve Appointment
NotFoundException
- no Appointment
found
with the given Id
NullArgumentException
- appointmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsByIds(IdList appointmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AppointmentList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
appointments specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible appointments may be omitted from the list and may present
the elements in any order including returning a unique set.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.appointmentIds
- the list of Ids
to retrieve Appointment list
NotFoundException
- an Id was
not foundNullArgumentException
- appointmentIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsByGenusType(Type appointmentGenusType) throws OperationFailedException, PermissionDeniedException
AppointmentList
corresponding to the given
appointment genus Type
which does not include
appointments of types derived from the specified Type.
In plenary mode, the returned list contains all known
appointments or an error results. Otherwise, the returned list may
contain only those appointments that are accessible through this
session.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.appointmentGenusType
- an appointments genus type Appointment list
NullArgumentException
- appointmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsByParentGenusType(Type appointmentGenusType) throws OperationFailedException, PermissionDeniedException
AppointmentList
corresponding to the given
appointment genus Type
and include any additional
appointments with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
appointments or an error results. Otherwise, the returned list may
contain only those appointments that are accessible through this
session.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.appointmentGenusType
- an appointment genus type Appointment list
NullArgumentException
- appointmentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsByRecordType(Type appointmentRecordType) throws OperationFailedException, PermissionDeniedException
AppointmentList
containing the given
appointment record Type.
In plenary mode, the returned list contains all known appointments or
an error results. Otherwise, the returned list may contain only those
appointments that are accessible through this session.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.appointmentRecordType
- an appointment record type AppointmentList
NullArgumentException
- appointmentRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AppointmentList
effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known appointments or
an error results. Otherwise, the returned list may contain only those
appointments that are accessible through this session.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.from
- start of date rangeto
- end of date range AppointmentList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPerson(Id personId) throws OperationFailedException, PermissionDeniedException
AppointmentList
for the given person Id.
In plenary mode, the returned list contains all of the
appointments corresponding to the given person, including duplicates,
or an error results if an appointment is inaccessible. Otherwise,
inaccessible Appointments
may be omitted from the list.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.personId
- the Id
of the person AppointmentList
NullArgumentException
- personId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPersonOnDate(Id personId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
personId
- a person Id
from
- start of date rangeto
- end of date range AppointmentList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- personId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPosition(Id positionId) throws OperationFailedException, PermissionDeniedException
AppointmentList
for the given position.
Id.
In plenary mode, the returned list contains all of the
appointments corresponding to the given position, including
duplicates, or an error results if an appointment is inaccessible.
Otherwise, inaccessible Appointments
may be omitted
from the list.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.positionId
- a position Id
AppointmentList
NullArgumentException
- positionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPositionOnDate(Id positionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
positionId
- a position Id
from
- start of date rangeto
- end of date range AppointmentList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- positionId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPersonAndPosition(Id personId, Id positionId) throws OperationFailedException, PermissionDeniedException
AppointmentList
for the given person and
position.
In plenary mode, the returned list contains all of the
appointments corresponding to the given resource and reference,
including duplicates, or an error results if an appointment is
inaccessible. Otherwise, inaccessible Appointments
may
be omitted from the list.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.personId
- a person Id
positionId
- a position Id
AppointmentList
NullArgumentException
- personId
or
positionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointmentsForPersonAndPositionOnDate(Id personId, Id positionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AppointmentList
corresponding to the given
person and position and effective during the entire given date range
inclusive but not confined to the date range.
In plenary mode, the returned list contains all of the appointments
corresponding to the given peer, including duplicates, or an error
results if an appointment is inaccessible. Otherwise, inaccessible
Appointments
may be omitted from the list.
In effective mode, appointments are returned that are currently
effective. In any effective mode, effective appointments and those
currently expired are returned.personId
- a person Id
positionId
- a position Id
from
- start of date rangeto
- end of date range AppointmentList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- referenceId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AppointmentList getAppointments() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.