public interface ScheduleLookupSession extends OsidSession
This session provides methods for retrieving Schedules.
This session defines views that offer differing behaviors when retrieving multiple objects.
ScheduleAdminSession.
Schedules
may have an additional records indicated by
their respective record types. The record may not be accessed through a
cast of the Schedule.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSchedules()
Tests if this user can perform
Schedule lookups. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
Schedule |
getSchedule(Id scheduleId)
Gets the
Schedule specified by its Id. |
ScheduleList |
getSchedules()
Gets all
Schedules. |
ScheduleList |
getSchedulesByDate(DateTime date)
Gets a
ScheduleList containing the given date. |
ScheduleList |
getSchedulesByDateRange(DateTime from,
DateTime to)
Gets a
ScheduleList contained by the given date range
inclusive. |
ScheduleList |
getSchedulesByGenusType(Type scheduleGenusType)
Gets a
ScheduleList corresponding to the given schedule
genus Type which does not include schedule of genus
types derived from the specified Type. |
ScheduleList |
getSchedulesByIds(IdList scheduleIds)
Gets a
ScheduleList corresponding to the given
IdList. |
ScheduleList |
getSchedulesByLocation(Id locationId)
Gets a
ScheduleList containing the given location. |
ScheduleList |
getSchedulesByParentGenusType(Type scheduleGenusType)
Gets a
ScheduleList corresponding to the given schedule
genus Type and include any additional schedule with
genus types derived from the specified Type. |
ScheduleList |
getSchedulesByRecordType(Type scheduleRecordType)
Gets a
ScheduleList containing the given schedule
record Type. |
ScheduleList |
getSchedulesByScheduleSlot(Id scheduleSlotId)
Gets a
ScheduleList directly containing the given
shedule slot. |
void |
useComparativeScheduleView()
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 |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
void |
usePlenaryScheduleView()
A complete view of the
Schedule returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSchedules()
Schedule
lookups. 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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeScheduleView()
mandatory
- This method is must be implemented. void usePlenaryScheduleView()
Schedule
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 useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. Schedule getSchedule(Id scheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Schedule
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Schedule
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Schedule
and retained for compatibility.scheduleId
- Id
of the Schedule
NotFoundException
- scheduleId
not foundNullArgumentException
- scheduleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ScheduleList getSchedulesByIds(IdList scheduleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ScheduleList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
schedule 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 Schedules
may be omitted from the list and
may present the elements in any order including returning a unique
set.scheduleIds
- the list of Ids
to retrieve Schedule
listNotFoundException
- an Id was
not foundNullArgumentException
- scheduleIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByGenusType(Type scheduleGenusType) throws OperationFailedException, PermissionDeniedException
ScheduleList
corresponding to the given schedule
genus Type
which does not include schedule of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known schedule or an error results.
Otherwise, the returned list may contain only those schedule that are
accessible through this session.scheduleGenusType
- a schedule genus type Schedule
listNullArgumentException
- scheduleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByParentGenusType(Type scheduleGenusType) throws OperationFailedException, PermissionDeniedException
ScheduleList
corresponding to the given schedule
genus Type
and include any additional schedule with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known schedule or an error
results. Otherwise, the returned list may contain only those schedule
that are accessible through this session.scheduleGenusType
- a schedule genus type Schedule
listNullArgumentException
- scheduleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByRecordType(Type scheduleRecordType) throws OperationFailedException, PermissionDeniedException
ScheduleList
containing the given schedule
record Type.
In plenary mode, the returned list
contains all known schedule or an error results. Otherwise, the
returned list may contain only those schedule that are accessible
through this session.scheduleRecordType
- a schedule record type Schedule
listNullArgumentException
- scheduleRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByScheduleSlot(Id scheduleSlotId) throws OperationFailedException, PermissionDeniedException
ScheduleList
directly containing the given
shedule slot.
In plenary mode, the returned list
contains all known schedule or an error results. Otherwise, the
returned list may contain only those schedule that are accessible
through this session.scheduleSlotId
- a schedule slot Id
Schedule
listNullArgumentException
- scheduleSlotId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ScheduleList
containing the given location.
In plenary mode, the returned list contains all known
schedule or an error results. Otherwise, the returned list may contain
only those schedule that are accessible through this session.locationId
- a location Id
Schedule
listNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
ScheduleList
containing the given date.
In plenary mode, the returned list contains all known schedule
or an error results. Otherwise, the returned list may contain only
those schedule that are accessible through this session.date
- a date Schedule
listNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedulesByDateRange(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ScheduleList
contained by the given date range
inclusive.
In plenary mode, the returned list contains
all known schedule or an error results. Otherwise, the returned list
may contain only those schedule that are accessible through this
session.from
- start of date rangeto
- end of date range Schedule
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ScheduleList getSchedules() throws OperationFailedException, PermissionDeniedException
Schedules.
In plenary mode, the returned list
contains all known schedule or an error results. Otherwise, the
returned list may contain only those schedule that are accessible
through this session. ScheduleList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.