org.osid.calendaring

Interface ScheduleSlotLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ScheduleSlotLookupSession
extends OsidSession

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 Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupScheduleSlots() Tests if this user can perform ScheduleSlot lookups.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
ScheduleSlot	getScheduleSlot(Id scheduleSlotId) Gets the ScheduleSlot specified by its Id.
ScheduleSlotList	getScheduleSlots() Gets all ScheduleSlots.
ScheduleSlotList	getScheduleSlotsByGenusType(Type scheduleSlotGenusType) 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.
ScheduleSlotList	getScheduleSlotsByIds(IdList scheduleSlotIds) Gets a ScheduleSlotList corresponding to the given IdList.
ScheduleSlotList	getScheduleSlotsByParentGenusType(Type scheduleSlotGenusType) 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.
ScheduleSlotList	getScheduleSlotsByRecordType(Type scheduleSlotRecordType) Gets a ScheduleSlotList containing the given schedule record Type.
ScheduleSlotList	getScheduleSlotsByTime(Time time) Gets a ScheduleSlotList matching the given time.
ScheduleSlotList	getScheduleSlotsByWeekdays(long[] weekdays) Gets a ScheduleSlotList containing the given set of weekdays.
void	useComparativeScheduleSlotView() 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	usePlenaryScheduleSlotView() A complete view of the ScheduleSlot returns is desired.
void	useSequesteredScheduleSlotView() The returns from the lookup methods omit sequestered schedule slots.
void	useUnsequesteredScheduleSlotView() All schedule slots are returned including sequestered schedule slots.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the Calendar associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupScheduleSlots

boolean canLookupScheduleSlots()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeScheduleSlotView

void useComparativeScheduleSlotView()

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.

usePlenaryScheduleSlotView

void usePlenaryScheduleSlotView()

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.

useFederatedCalendarView

void useFederatedCalendarView()

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.

useIsolatedCalendarView

void useIsolatedCalendarView()

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.

useSequesteredScheduleSlotView

void useSequesteredScheduleSlotView()

The returns from the lookup methods omit sequestered schedule slots.

Compliance:

mandatory - This method is must be implemented.

useUnsequesteredScheduleSlotView

void useUnsequesteredScheduleSlotView()

All schedule slots are returned including sequestered schedule slots.

Compliance:

mandatory - This method is must be implemented.

getScheduleSlot

ScheduleSlot getScheduleSlot(Id scheduleSlotId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

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:

scheduleSlotId - Id of the ScheduleSlot

Returns:

the schedule slot

Throws:

NotFoundException - scheduleSlotId not found

NullArgumentException - scheduleSlotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getScheduleSlotsByIds

ScheduleSlotList getScheduleSlotsByIds(IdList scheduleSlotIds)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

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:

scheduleSlotIds - the list of Ids to retrieve

Returns:

the returned ScheduleSlot list

Throws:

NotFoundException - an Id was not found

NullArgumentException - scheduleSlotIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsByGenusType

ScheduleSlotList getScheduleSlotsByGenusType(Type scheduleSlotGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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:

scheduleSlotGenusType - a schedule slot genus type

Returns:

the returned ScheduleSlot list

Throws:

NullArgumentException - scheduleSlotGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsByParentGenusType

ScheduleSlotList getScheduleSlotsByParentGenusType(Type scheduleSlotGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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:

scheduleSlotGenusType - a schedule slot genus type

Returns:

the returned ScheduleSlot list

Throws:

NullArgumentException - scheduleSlotGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsByRecordType

ScheduleSlotList getScheduleSlotsByRecordType(Type scheduleSlotRecordType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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:

scheduleSlotRecordType - a schedule slot record type

Returns:

the returned ScheduleSlot list

Throws:

NullArgumentException - scheduleSlotRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsByWeekdays

ScheduleSlotList getScheduleSlotsByWeekdays(long[] weekdays)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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:

weekdays - a set of weekdays

Returns:

the returned ScheduleSlot list

Throws:

InvalidArgumentException - a weekday is negative

NullArgumentException - weekdays is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsByTime

ScheduleSlotList getScheduleSlotsByTime(Time time)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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:

time - a time

Returns:

the returned ScheduleSlot list

Throws:

NullArgumentException - time is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlots

ScheduleSlotList getScheduleSlots()
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Returns:

a ScheduleSlotList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.