Interface DeedSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DeedQuerySession, OsidSession, OsidSession

public interface DeedSearchSession
extends DeedQuerySession

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

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

close

Methods inherited from interface DeedQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchDeeds()	Tests if this user can perform Deed searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
DeedQuery	getDeedQuery()	Gets a deed query.
DeedList	getDeedsByQuery(DeedQuery deedQuery)	Gets a list of Deeds matching the given deed query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	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

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.