org.osid.calendaring

Interface CalendarQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

CalendarSearchSession

public interface CalendarQuerySession
extends OsidSession

This session provides methods for searching among Calendar objects. The search query is constructed using the CalendarQuery.

Calendars may have a query record indicated by their respective record types. The query record is accessed via the CalendarQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchCalendars() Tests if this user can perform Calendar searches.
CalendarQuery	getCalendarQuery() Gets a calendar query.
CalendarList	getCalendarsByQuery(CalendarQuery calendarQuery) Gets a list of Calendar objects matching the given calendar query.

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

canSearchCalendars

boolean canSearchCalendars()

Tests if this user can perform Calendar searches. 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 search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarQuery

CalendarQuery getCalendarQuery()

Gets a calendar query.

Returns:

a calendar query

Compliance:

mandatory - This method must be implemented.

getCalendarsByQuery

CalendarList getCalendarsByQuery(CalendarQuery calendarQuery)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a list of Calendar objects matching the given calendar query.

Parameters:

calendarQuery - the calendar query

Returns:

the returned CalendarList

Throws:

NullArgumentException - calendarQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - calendarQuery is not of this service

Compliance:

mandatory - This method must be implemented.