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

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

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

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} .

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