org.osid.room.squatting

Interface DeedSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface DeedSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BuildingSearchOrder	getBuildingSearchOrder() Gets the building search order.
DeedSearchOrderRecord	getDeedSearchOrderRecord(Type deedRecordType) Gets the deed search order record corresponding to the given deed record Type.
ResourceSearchOrder	getOwnerSearchOrder() Gets the owner resource search order.
void	orderByBuilding(SearchOrderStyle style) Specifies a preference for ordering the result set by the building.
void	orderByOwner(SearchOrderStyle style) Specifies a preference for ordering the result set by the owner.
boolean	supportsBuildingSearchOrder() Tests if a building search order is available.
boolean	supportsOwnerSearchOrder() Tests if an owner resource search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByBuilding

void orderByBuilding(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBuildingSearchOrder

boolean supportsBuildingSearchOrder()

Tests if a building search order is available.

Returns:

true if a building search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrder

BuildingSearchOrder getBuildingSearchOrder()

Gets the building search order.

Returns:

the building search order

Throws:

UnimplementedException - supportsBuildingSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsBuildingSearchOrder() is true.

orderByOwner

void orderByOwner(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOwnerSearchOrder

boolean supportsOwnerSearchOrder()

Tests if an owner resource search order is available.

Returns:

true if an owner search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOwnerSearchOrder

ResourceSearchOrder getOwnerSearchOrder()

Gets the owner resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsOwnerSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsOwnerSearchOrder() is true.

getDeedSearchOrderRecord

DeedSearchOrderRecord getDeedSearchOrderRecord(Type deedRecordType)
                                               throws OperationFailedException

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

Parameters:

deedRecordType - a deed record type

Returns:

the deed search order record

Throws:

NullArgumentException - deedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedRecordType) is false

Compliance:

mandatory - This method must be implemented.