OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.DeedSearchSession
Implementsosid.room.squatting.DeedQuerySession
Description

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.

MethodgetDeedSearch
Description

Gets a deed search.

Returnosid.room.squatting.DeedSearchthe deed search
CompliancemandatoryThis method must be implemented.
MethodgetDeedSearchOrder
Description

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

Returnosid.room.squatting.DeedSearchOrderthe deed search order
CompliancemandatoryThis method must be implemented.
MethodgetDeedsBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.squatting.DeedQuerydeedQuerythe deed query
osid.room.squatting.DeedSearchdeedSearchthe deed search
Returnosid.room.squatting.DeedSearchResultsthe deed search results
ErrorsNULL_ARGUMENT deedQuery or deedSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED deedQuery or deedSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDeedQueryFromInspector
Description

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

Parametersosid.room.squatting.DeedQueryInspectordeedQueryInspectora query inspector
Returnosid.room.squatting.DeedQuerythe deed query
ErrorsNULL_ARGUMENT deedQueryInspector is null
UNSUPPORTED deedQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.