OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.DeedSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBuilding
Description

Specifies a preference for ordering the result set by the building.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingSearchOrder
Description

Tests if a building search order is available.

Returnboolean true if a building search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBuildingSearchOrder
Description

Gets the building search order.

Returnosid.room.BuildingSearchOrderthe building search order
ErrorsUNIMPLEMENTED supportsBuildingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsBuildingSearchOrder() is true.
MethodorderByOwner
Description

Specifies a preference for ordering the result set by the owner.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOwnerSearchOrder
Description

Tests if an owner resource search order is available.

Returnboolean true if an owner search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOwnerSearchOrder
Description

Gets the owner resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsOwnerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsOwnerSearchOrder() is true.
MethodgetDeedSearchOrderRecord
Description

Gets the deed search order record corresponding to the given deed record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypedeedRecordTypea deed record type
Returnosid.room.squatting.records.DeedSearchOrderRecordthe deed search order record
ErrorsNULL_ARGUMENT deedRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(deedRecordType) is false
CompliancemandatoryThis method must be implemented.