public interface ProjectSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByBuilding(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBuildingSearchOrder()
true
if a building search order is available,
false
otherwisemandatory
- This method must be implemented. BuildingSearchOrder getBuildingSearchOrder()
UnimplementedException
-
supportsBuildingSearchOrder()
is false
optional
- This method must be implemented if
supportsBuildingSearchOrder()
is true.
void orderByCost(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ProjectSearchOrderRecord getProjectSearchOrderRecord(Type projectRecordType) throws OperationFailedException
projectRecordType
- a project record typeNullArgumentException
- projectRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(projectRecordType)
is false
mandatory
- This method must be implemented.