OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.DeedSearch
Implementsosid.OsidSearch
Description

The search interface for governing deed searches.

MethodsearchAmongDeeds
Description

Execute this search among the given list of deeds.

Parametersosid.id.IdListDeedIdslist of deeds
ErrorsNULL_ARGUMENT DeedIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDeedResults
Description

Specify an ordering to the search results.

Parametersosid.room.squatting.DeedSearchOrderdeedSearchOrdera deed search order
ErrorsNULL_ARGUMENT deedSearchOrder is null
UNSUPPORTED deedSearchOrder is not of this service
CompliancemandatoryThis 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.TypedeedSearchRecordTypea deed search record type
Returnosid.room.squatting.records.DeedSearchRecordthe deed search record
ErrorsNULL_ARGUMENT deedSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deedSearchRecordType) is false
CompliancemandatoryThis method must be implemented.