org.osid.room.construction

Interface ProjectSearchOrder

All Superinterfaces:

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

public interface ProjectSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder

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.
ProjectSearchOrderRecord	getProjectSearchOrderRecord(Type projectRecordType) Gets the project search order record corresponding to the given project record Type.
void	orderByBuilding(SearchOrderStyle style) Specifies a preference for ordering the result set by the building.
void	orderByCost(SearchOrderStyle style) Specifies a preference for ordering the result set by the cost.
boolean	supportsBuildingSearchOrder() Tests if a 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

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.

orderByCost

void orderByCost(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProjectSearchOrderRecord

ProjectSearchOrderRecord getProjectSearchOrderRecord(Type projectRecordType)
                                                     throws OperationFailedException

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

Parameters:

projectRecordType - a project record type

Returns:

the project search order record

Throws:

NullArgumentException - projectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(projectRecordType) is false

Compliance:

mandatory - This method must be implemented.