org.osid.room

Interface BuildingSearchOrder

All Superinterfaces:

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

public interface BuildingSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AddressSearchOrder	getAddressSearchOrder() Gets the address search order.
BuildingSearchOrderRecord	getBuildingSearchOrderRecord(Type buildingRecordType) Gets the building search order record corresponding to the given building record Type.
BuildingSearchOrder	getEnclosingBuildingSearchOrder() Gets the enclosing building search order.
void	orderByAddress(SearchOrderStyle style) Specifies a preference for ordering the result set by the address.
void	orderByEnclosingBuilding(SearchOrderStyle style) Specifies a preference for ordering the result set by the subdivisions.
void	orderByGrossArea(SearchOrderStyle style) Specifies a preference for ordering the result set by the gross area.
void	orderByNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by the building number.
void	orderByOfficialName(SearchOrderStyle style) Specifies a preference for ordering the result set by the offical name.
boolean	supportsAddressSearchOrder() Tests if an address order is available.
boolean	supportsEnclosingBuildingSearchOrder() Tests if an enclosing building search order is available.

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

orderByAddress

void orderByAddress(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAddressSearchOrder

boolean supportsAddressSearchOrder()

Tests if an address order is available.

Returns:

true if an address search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddressSearchOrder

AddressSearchOrder getAddressSearchOrder()

Gets the address search order.

Returns:

the address search order

Throws:

UnimplementedException - supportsAddressSearchOrder() is false

Compliance:

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

orderByOfficialName

void orderByOfficialName(SearchOrderStyle style)

Specifies a preference for ordering the result set by the offical name.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByNumber

void orderByNumber(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEnclosingBuilding

void orderByEnclosingBuilding(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEnclosingBuildingSearchOrder

boolean supportsEnclosingBuildingSearchOrder()

Tests if an enclosing building search order is available.

Returns:

true if a building search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnclosingBuildingSearchOrder

BuildingSearchOrder getEnclosingBuildingSearchOrder()

Gets the enclosing building search order.

Returns:

the building search order

Throws:

UnimplementedException - supportsEnclosingBuildingSearchOrder() is false

Compliance:

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

orderByGrossArea

void orderByGrossArea(SearchOrderStyle style)

Specifies a preference for ordering the result set by the gross area.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrderRecord

BuildingSearchOrderRecord getBuildingSearchOrderRecord(Type buildingRecordType)
                                                       throws OperationFailedException

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

Parameters:

buildingRecordType - a building record type

Returns:

the building search order record

Throws:

NullArgumentException - buildingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingRecordType) is false

Compliance:

mandatory - This method must be implemented.