org.osid.room.squatting

Interface DeedSearchSession

All Superinterfaces:

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

public interface DeedSearchSession
extends DeedQuerySession

This session provides methods for searching Deed objects. The search query is constructed using the DeedQuery. The deed record Type also specifies the record for the deed query.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
DeedQuery	getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector) Gets a deed query from an inspector.
DeedSearchResults	getDeedsBySearch(DeedQuery deedQuery, DeedSearch deedSearch) Gets the search results matching the given search.
DeedSearch	getDeedSearch() Gets a deed search.
DeedSearchOrder	getDeedSearchOrder() Gets a deed search order.

Methods inherited from interface org.osid.room.squatting.DeedQuerySession

canSearchDeeds, getCampus, getCampusId, getDeedQuery, getDeedsByQuery, useFederatedCampusView, useIsolatedCampusView

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

getDeedSearch

DeedSearch getDeedSearch()

Gets a deed search.

Returns:

the deed search

Compliance:

mandatory - This method must be implemented.

getDeedSearchOrder

DeedSearchOrder getDeedSearchOrder()

Gets a deed search order. The DeedSearchOrder is supplied to a DeedSearch to specify the ordering of results.

Returns:

the deed search order

Compliance:

mandatory - This method must be implemented.

getDeedsBySearch

DeedSearchResults getDeedsBySearch(DeedQuery deedQuery,
                                 DeedSearch deedSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the search results matching the given search.

Parameters:

deedQuery - the deed query

deedSearch - the deed search

Returns:

the deed search results

Throws:

NullArgumentException - deedQuery or deedSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - deedQuery or deedSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDeedQueryFromInspector

DeedQuery getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector)

Gets a deed query from an inspector. The inspector is available from a DeedSearchResults.

Parameters:

deedQueryInspector - a query inspector

Returns:

the deed query

Throws:

NullArgumentException - deedQueryInspector is null

UnsupportedException - deedQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.