org.osid.course.syllabus

Interface DocetSearchSession

All Superinterfaces:

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

public interface DocetSearchSession
extends DocetQuerySession

This session provides methods for searching Docet objects. The search query is constructed using the DocetQuery. The docet record Type also specifies the record for the docet query.

getDocetsByQuery() is the basic search method and returns a list of Docet elements. A more advanced search may be performed with getDocetsBySearch(). It accepts an DocetSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDocetsBySearch() returns an DocetSearchResults that can be used to access the resulting DocetList or be used to perform a search within the result set through DocetSearch.

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

Method Summary

Methods

Modifier and Type	Method and Description
DocetQuery	getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector) Gets a docet query from an inspector.
DocetSearchResults	getDocetsBySearch(DocetQuery docetQuery, DocetSearch docetSearch) Gets the search results matching the given search.
DocetSearch	getDocetSearch() Gets a docet search.
DocetSearchOrder	getDocetSearchOrder() Gets a docet search order.

Methods inherited from interface org.osid.course.syllabus.DocetQuerySession

canSearchDocets, getCourseCatalog, getCourseCatalogId, getDocetQuery, getDocetsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

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

getDocetSearch

DocetSearch getDocetSearch()

Gets a docet search.

Returns:

the docet search

Compliance:

mandatory - This method must be implemented.

getDocetSearchOrder

DocetSearchOrder getDocetSearchOrder()

Gets a docet search order. The DocetSearchOrder is supplied to an DocetSearch to specify the ordering of results.

Returns:

the docet search order

Compliance:

mandatory - This method must be implemented.

getDocetsBySearch

DocetSearchResults getDocetsBySearch(DocetQuery docetQuery,
                                   DocetSearch docetSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the search results matching the given search.

Parameters:

docetQuery - the docet query

docetSearch - the docet search

Returns:

the docet search results

Throws:

NullArgumentException - docetQuery or docetSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - docetQuery or docetSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDocetQueryFromInspector

DocetQuery getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)

Gets a docet query from an inspector. The inspector is available from an DocetSearchResults.

Parameters:

docetQueryInspector - a docet query inspector

Returns:

the course catalog query

Throws:

NullArgumentException - docetQueryInspector is null

UnsupportedException - docetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.