Interface AddressSearchOrder

All Superinterfaces:

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

public interface AddressSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
AddressSearchOrderRecord	getAddressSearchOrderRecord(Type addressRecordType)	Gets the address search order record corresponding to the given address record Type.
ResourceSearchOrder	getResourceSearchOrder()	Gets the resource order.
void	orderByResource(SearchOrderStyle style)	Specifies a preference for ordering the result set by the resource.
boolean	supportsResourceSearchOrder()	Tests if a resource 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 .

Method Details

orderByResource

void orderByResource(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsAddresseeSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsAddresseeSearchOrder()} is {@code true} .

getAddressSearchOrderRecord

AddressSearchOrderRecord getAddressSearchOrderRecord(Type addressRecordType)
                                              throws OperationFailedException

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

Parameters:

addressRecordType - an address record type

Returns:

the address search order record

Throws:

NullArgumentException - addressRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressRecordType) is false

Compliance:

mandatory - This method must be implemented.