org.osid.calendaring

Interface SupersedingEventQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

SupersedingEventSearchSession

public interface SupersedingEventQuerySession
extends OsidSession

This session provides methods for searching SupersedingEvent objects. The search query is constructed using the SupersedingEventQuery. The superseding event record Type also specifies the record for the superseding event query.

This session defines views that offer differing behaviors for searching.

• federated calendar view: searches include superseding events in calendars of which this calendar is an ancestor in the calendar hierarchy
• isolated calendar view: searches are restricted to superseding events in this calendar

SupersedingEvents may have a query record indicated by their respective record types. The query record is accessed via the SupersedingE ventQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchSupersedingEvents() Tests if this user can perform SupersedingEvents searches.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
SupersedingEventQuery	getSupersedingEventQuery() Gets a superseding event query.
SupersedingEventList	getSupersedingEventsByQuery(SupersedingEventQuery supersedingEventQuery) Gets a list of SupersedingEvents matching the given superseding event query.
void	useFederatedCalendarView() Federates the view for methods in this session.
void	useIsolatedCalendarView() Isolates the view for methods in this session.

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.

canSearchSupersedingEvents

boolean canSearchSupersedingEvents()

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

useFederatedCalendarView

void useFederatedCalendarView()

Federates the view for methods in this session. A federated view will include superseding events 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 searches to this calendar only.

Compliance:

mandatory - This method is must be implemented.

getSupersedingEventQuery

SupersedingEventQuery getSupersedingEventQuery()

Gets a superseding event query.

Returns:

the superseding event query

Compliance:

mandatory - This method must be implemented.

getSupersedingEventsByQuery

SupersedingEventList getSupersedingEventsByQuery(SupersedingEventQuery supersedingEventQuery)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a list of SupersedingEvents matching the given superseding event query.

Parameters:

supersedingEventQuery - the superseding event query

Returns:

the returned SupersedingEventList

Throws:

NullArgumentException - supersedingEventQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - supersedingEventQuery is not of this service

Compliance:

mandatory - This method must be implemented.