org.osid.checklist

Interface ChecklistSearchSession

All Superinterfaces:

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

public interface ChecklistSearchSession
extends ChecklistQuerySession

This session provides methods for searching Checklist objects. 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

Methods

Modifier and Type	Method and 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 org.osid.checklist.ChecklistQuerySession

canSearchChecklists, getChecklistQuery, getChecklistsByQuery

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

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.