OSID - osid.calendaring.ScheduleSlotLookupSession Service Interface Definition

Interface	osid.calendaring.ScheduleSlotLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `ScheduleSlots.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative schedule slot view: elements may be silently omitted or re-ordered plenary schedule slot view: provides a complete set or is an error condition isolated calendar view: All schedule slot methods in this session operate, retrieve and pertain to schedule slots defined explicitly in the current calendar. Using an isolated view is useful for managing schedule slots with the `ScheduleSlotAdminSession.` federated calendar view: All schedule slot methods in this session operate, retrieve and pertain to all schedule slots defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence. sequestered schedule slot viiew: All schedule slot methods suppress sequestered schedule slots. unsequestered schedule slot view: All schedule slot methods return all schedule slots. `ScheduleSlots` may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `ScheduleSlot.`
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupScheduleSlots
Description	Tests if this user can perform `ScheduleSlot` 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeScheduleSlotView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryScheduleSlotView
Description	A complete view of the `ScheduleSlot` 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.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include schedules in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredScheduleSlotView
Description	The returns from the lookup methods omit sequestered schedule slots.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredScheduleSlotView
Description	All schedule slots are returned including sequestered schedule slots.
Compliance	`mandatory`		This method is must be implemented.
Method	getScheduleSlot
Description	Gets the `ScheduleSlot` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ScheduleSlot` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ScheduleSlot` and retained for compatibility. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.id.Id`	`scheduleSlotId`	`Id` of the `ScheduleSlot`
Return	`osid.calendaring.ScheduleSlot`		the schedule slot
Errors	NOT_FOUND		`scheduleSlotId` not found
	NULL_ARGUMENT		`scheduleSlotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getScheduleSlotsByIds
Description	Gets a `ScheduleSlotList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the schedule slots 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 `ScheduleSlots` may be omitted from the list and may present the elements in any order including returning a unique set. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.id.IdList`	`scheduleSlotIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`scheduleSlotIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsByGenusType
Description	Gets a `ScheduleSlotList` corresponding to the given schedule slot genus `Type` which does not include schedule slots of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.type.Type`	`scheduleSlotGenusType`	a schedule slot genus type
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	NULL_ARGUMENT		`scheduleSlotGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsByParentGenusType
Description	Gets a `ScheduleSlotList` corresponding to the given schedule slot genus `Type` and include any additional schedule slots with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.type.Type`	`scheduleSlotGenusType`	a schedule slot genus type
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	NULL_ARGUMENT		`scheduleSlotGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsByRecordType
Description	Gets a `ScheduleSlotList` containing the given schedule record `Type.` In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.type.Type`	`scheduleSlotRecordType`	a schedule slot record type
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	NULL_ARGUMENT		`scheduleSlotRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsByWeekdays
Description	Gets a `ScheduleSlotList` containing the given set of weekdays. In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`cardinal[]`	`weekdays`	a set of weekdays
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	INVALID_ARGUMENT		a `weekday` is negative
	NULL_ARGUMENT		`weekdays` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsByTime
Description	Gets a `ScheduleSlotList` matching the given time. In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Parameters	`osid.calendaring.Time`	`time`	a time
Return	`osid.calendaring.ScheduleSlotList`		the returned `ScheduleSlot` list
Errors	NULL_ARGUMENT		`time` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlots
Description	Gets all `ScheduleSlots.` In plenary mode, the returned list contains all known schedule slots or an error results. Otherwise, the returned list may contain only those schedule slots that are accessible through this session. In sequestered mode, no sequestered schedule slots are returned. In unsequestered mode, all schedule slots are returned.
Return	`osid.calendaring.ScheduleSlotList`		a `ScheduleSlotList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.