org.osid.calendaring

Interface CommitmentSmartCalendarSession

All Superinterfaces:

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

public interface CommitmentSmartCalendarSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CommitmentQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of Commitments. The entries may be sequenced using the CommitmentSearchOrder from this session.

This Calendar has a default query that matches any commitment and a default search order that specifies no sequencing. The queries may be examined using a CommitmentQueryInspector. The query may be modified by converting the inspector back to a CommitmentQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCommitmentQuery(CommitmentQuery commitmentQuery) Applies a commitment query to this calendar.
void	applyCommitmentSequencing(CommitmentSearchOrder commitmentSearchOrder) Applies a commitment search order to this calendar.
boolean	canManageSmartCalendars() Tests if this user can manage smart calendars.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
CommitmentQuery	getCommitmentQuery() Gets a commitment query.
CommitmentQuery	getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector) Gets a commitment query from an inspector.
CommitmentSearchOrder	getCommitmentSearchOrder() Gets a commitment search order.
CommitmentQueryInspector	inspectCommitmentQuery() Gets a commitment query inspector for this calendar.

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.

canManageSmartCalendars

boolean canManageSmartCalendars()

Tests if this user can manage smart calendars. 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 smart operations.

Returns:

false if smart calendar methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCommitmentQuery

CommitmentQuery getCommitmentQuery()

Gets a commitment query.

Returns:

the commitment query

Compliance:

mandatory - This method must be implemented.

getCommitmentSearchOrder

CommitmentSearchOrder getCommitmentSearchOrder()

Gets a commitment search order.

Returns:

the commitment search order

Compliance:

mandatory - This method must be implemented.

applyCommitmentQuery

void applyCommitmentQuery(CommitmentQuery commitmentQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a commitment query to this calendar.

Parameters:

commitmentQuery - the commitment query

Throws:

NullArgumentException - commitmentQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - commitmentQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCommitmentQuery

CommitmentQueryInspector inspectCommitmentQuery()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a commitment query inspector for this calendar.

Returns:

the commitment query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCommitmentSequencing

void applyCommitmentSequencing(CommitmentSearchOrder commitmentSearchOrder)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a commitment search order to this calendar.

Parameters:

commitmentSearchOrder - the commitment search order

Throws:

NullArgumentException - commitmentSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - commitmentSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCommitmentQueryFromInspector

CommitmentQuery getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)

Gets a commitment query from an inspector.

Parameters:

commitmentQueryInspector - a commitment query inspector

Returns:

the commitment query

Throws:

NullArgumentException - commitmentQueryInspector is null

UnsupportedException - commitmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.