Interface CommitmentSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CommitmentQuerySession, OsidSession, 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 an 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface CommitmentQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchCommitments()	Tests if this user can perform Commitment searches.
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.
CommitmentList	getCommitmentsByQuery(CommitmentQuery commitmentQuery)	Gets a list of Commitments matching the given commitment 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 OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.