OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.DeedSearch
Implementsosid.OsidSearch
Used Byosid.room.squatting.DeedSearchSession
Description

The search interface for governing deed searches.

MethodsearchAmongDeeds
Description

Execute this search among the given list of deeds.

Parametersosid.id.IdListDeedIds list of deeds
ErrorsNULL_ARGUMENT DeedIds is null
Compliancemandatory This method must be implemented.
MethodorderDeedResults
Description

Specify an ordering to the search results.

Parametersosid.room.squatting.DeedSearchOrderdeedSearchOrder a deed search order
ErrorsNULL_ARGUMENT deedSearchOrder is null
UNSUPPORTED deedSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDeedSearchRecord
Description

Gets the search record corresponding to the given deed search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypedeedSearchRecordType a deed search record type
Returnosid.room.squatting.records.DeedSearchRecord the deed search record
ErrorsNULL_ARGUMENT deedSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(deedSearchRecordType) is false
Compliancemandatory This method must be implemented.