org.osid.contact

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

Methods

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

Method Detail

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 supportsAddresseeSearchOrder() is 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.