org.osid.calendaring

Interface CalendarLookupSession

All Superinterfaces:

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

public interface CalendarLookupSession
extends OsidSession

This session provides methods for retrieving Calendar objects. The Calendar represents a collection of Events, Schedules , and time periods.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Calendars it can access, without breaking execution. However, an administrative application may require all Calendar elements to be available.

Calendars may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Calendar.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCalendars() Tests if this user can perform Calendar lookups.
Calendar	getCalendar(Id calendarId) Gets the Calendar specified by its Id.
CalendarList	getCalendars() Gets all Calendars.
CalendarList	getCalendarsByGenusType(Type calendarGenusType) Gets a CalendarList corresponding to the given calendar genus Type which does not include calendars of types derived from the specified Type.
CalendarList	getCalendarsByIds(IdList calendarIds) Gets a CalendarList corresponding to the given IdList.
CalendarList	getCalendarsByParentGenusType(Type calendarGenusType) Gets a CalendarList corresponding to the given calendar genus Type and include any additional calendars with genus types derived from the specified Type.
CalendarList	getCalendarsByProvider(Id resourceId) Gets a CalendarList for the given provider.
CalendarList	getCalendarsByRecordType(Type calendarRecordType) Gets a CalendarList containing the given calendar record Type.
void	useComparativeCalendarView() 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	usePlenaryCalendarView() A complete view of the Calendar returns is desired.

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

canLookupCalendars

boolean canLookupCalendars()

Tests if this user can perform Calendar 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.

useComparativeCalendarView

void useComparativeCalendarView()

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.

usePlenaryCalendarView

void usePlenaryCalendarView()

A complete view of the Calendar 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.

getCalendar

Calendar getCalendar(Id calendarId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the Calendar specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Calendar may have a different Id than requested, such as the case where a duplicate Id was assigned to a Calendar and retained for compatility.

Parameters:

calendarId - Id of the Calendar

Returns:

the calendar

Throws:

NotFoundException - calendarId not found

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getCalendarsByIds

CalendarList getCalendarsByIds(IdList calendarIds)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets a CalendarList corresponding to the given IdList. In plenary mode, the returned list contains all of the calendars 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 Calendar objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

calendarIds - the list of Ids to retrieve

Returns:

the returned Calendar list

Throws:

NotFoundException - an Id was not found

NullArgumentException - calendarIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByGenusType

CalendarList getCalendarsByGenusType(Type calendarGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a CalendarList corresponding to the given calendar genus Type which does not include calendars of types derived from the specified Type. In plenary mode, the returned list contains all known calendars or an error results. Otherwise, the returned list may contain only those calendars that are accessible through this session.

Parameters:

calendarGenusType - a calendar genus type

Returns:

the returned Calendar list

Throws:

NullArgumentException - calendarGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByParentGenusType

CalendarList getCalendarsByParentGenusType(Type calendarGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a CalendarList corresponding to the given calendar genus Type and include any additional calendars with genus types derived from the specified Type. In plenary mode, the returned list contains all known calendars or an error results. Otherwise, the returned list may contain only those calendars that are accessible through this session.

Parameters:

calendarGenusType - a calendar genus type

Returns:

the returned Calendar list

Throws:

NullArgumentException - calendarGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByRecordType

CalendarList getCalendarsByRecordType(Type calendarRecordType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a CalendarList containing the given calendar record Type. In plenary mode, the returned list contains all known calendars or an error results. Otherwise, the returned list may contain only those calendars that are accessible through this session.

Parameters:

calendarRecordType - a calendar record type

Returns:

the returned Calendar list

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendarsByProvider

CalendarList getCalendarsByProvider(Id resourceId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a CalendarList for the given provider. In plenary mode, the returned list contains all known calendars or an error results. Otherwise, the returned list may contain only those calendars that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Calendar list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCalendars

CalendarList getCalendars()
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets all Calendars. In plenary mode, the returned list contains all known calendars or an error results. Otherwise, the returned list may contain only those calendars that are accessible through this session.

Returns:

a CalendarList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.