org.osid.calendaring

Interface CommitmentSearchSession

All Superinterfaces:

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

public interface CommitmentSearchSession
extends CommitmentQuerySession

This session provides methods for searching Commitment objects. The search query is constructed using the CommitmentQuery. The commitment record Type also specifies the record for the commitment query.

getCommitmentsByQuery() is the basic search method and returns a list of Commitments. A more advanced search may be performed with getCommitmentsBySearch(). It accepts a CommitmentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCommitmentsBySearch() returns an CommitmentSearchResults that can be used to access the resulting CommitmentList or be used to perform a search within the result set through CommitmentSearch.

This session defines views that offer differing behaviors for searching.

• federated calendar view: searches include commitments in calendars of which this calendar is a ancestor in the calendar hierarchy
• isolated calendar view: searches are restricted to commitments in this calendar only

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

Method Summary

Methods

Modifier and Type	Method and Description
CommitmentQuery	getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector) Gets a commitment query from an inspector.
CommitmentSearchResults	getCommitmentsBySearch(CommitmentQuery commitmentQuery, CommitmentSearch commitmentSearch) Gets the search results matching the given search query using the given search.
CommitmentSearch	getCommitmentSearch() Gets a commitment search.
CommitmentSearchOrder	getCommitmentSearchOrder() Gets a commitment search order.

Methods inherited from interface org.osid.calendaring.CommitmentQuerySession

canSearchCommitments, getCalendar, getCalendarId, getCommitmentQuery, getCommitmentsByQuery, useFederatedCalendarView, useIsolatedCalendarView

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

getCommitmentSearch

CommitmentSearch getCommitmentSearch()

Gets a commitment search.

Returns:

the commitment search

Compliance:

mandatory - This method must be implemented.

getCommitmentSearchOrder

CommitmentSearchOrder getCommitmentSearchOrder()

Gets a commitment search order. The CommitmentSearchOrder is supplied to a CommitmentSearch to specify the ordering of results.

Returns:

the commitment search order

Compliance:

mandatory - This method must be implemented.

getCommitmentsBySearch

CommitmentSearchResults getCommitmentsBySearch(CommitmentQuery commitmentQuery,
                                             CommitmentSearch commitmentSearch)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

commitmentQuery - the commitment search query

commitmentSearch - the commitment search

Returns:

the commitment search results

Throws:

NullArgumentException - commitmentQuery or commitmentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - commitmentSearch or commitmentQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getCommitmentQueryFromInspector

CommitmentQuery getCommitmentQueryFromInspector(CommitmentQueryInspector commitmentQueryInspector)

Gets a commitment query from an inspector. The inspector is available from an CommitmentSearchResults.

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.