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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

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 {@code supportsBuildingSearchOrder()} is {@code 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.