Interface ChecklistSearchSession

All Superinterfaces:

AutoCloseable, ChecklistQuerySession, Closeable, OsidSession, OsidSession

public interface ChecklistSearchSession
extends ChecklistQuerySession

This session provides methods for searching Checklists. The search query is constructed using the ChecklistQuery. The checklist record Type also specifies the record for the checklist query.

getChecklistsByQuery() is the basic search method and returns a list of Checklist elements. A more advanced search may be performed with getChecklistsBySearch(). It accepts a ChecklistSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getChecklistsBySearch() returns a ChecklistSearchResults that can be used to access the resulting ChecklistList or be used to perform a search within the result set through ChecklistSearch.

Checklists may have a query record indicated by their respective record types. The query record is accessed via the ChecklistQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
ChecklistQuery	getChecklistQueryFromInspector(ChecklistQueryInspector checklistQueryInspector)	Gets an entry query from an inspector.
ChecklistSearchResults	getChecklistsBySearch(ChecklistQuery checklistQuery, ChecklistSearch checklistSearch)	Gets the search results matching the given search.
ChecklistSearch	getChecklistSearch()	Gets a checklist search.
ChecklistSearchOrder	getChecklistSearchOrder()	Gets a checklist search order.

Methods inherited from interface ChecklistQuerySession

canSearchChecklists, getChecklistQuery, getChecklistsByQuery

Modifier and Type	Method	Description
boolean	canSearchChecklists()	Tests if this user can perform Checklist searches.
ChecklistQuery	getChecklistQuery()	Gets a checklist query.
ChecklistList	getChecklistsByQuery(ChecklistQuery checklistQuery)	Gets a list of Checklists matching the given search.

Methods inherited from interface Closeable

close

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

getChecklistSearch

ChecklistSearch getChecklistSearch()

Gets a checklist search.

Returns:

the checklist search

Compliance:

mandatory - This method must be implemented.

getChecklistSearchOrder

ChecklistSearchOrder getChecklistSearchOrder()

Gets a checklist search order. The ChecklistSearchOrder is supplied to a ChecklistSearch to specify the ordering of results.

Returns:

the checklist search order

Compliance:

mandatory - This method must be implemented.

getChecklistsBySearch

ChecklistSearchResults getChecklistsBySearch(ChecklistQuery checklistQuery,
 ChecklistSearch checklistSearch)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

checklistQuery - the checklist query

checklistSearch - the checklist search

Returns:

the search results

Throws:

NullArgumentException - checklistQuery or checklistSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - checklistQuery or checklistSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getChecklistQueryFromInspector

ChecklistQuery getChecklistQueryFromInspector(ChecklistQueryInspector checklistQueryInspector)

Gets an entry query from an inspector. The inspector is available from an ChecklistSearchResults.

Parameters:

checklistQueryInspector - a checklist query inspector

Returns:

the checklist query

Throws:

NullArgumentException - checklistQueryInspector is null

UnsupportedException - checklistQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.