org.osid.ordering

Interface ProductSearchOrder

All Superinterfaces:

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

public interface ProductSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ProductSearchOrderRecord	getProductSearchOrderRecord(Type productRecordType) Gets the product search record order corresponding to the given product record Type.
void	orderByAvailability(SearchOrderStyle style) Specifies a preference for ordering the result set by the availability.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by the code.

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

orderByCode

void orderByCode(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAvailability

void orderByAvailability(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProductSearchOrderRecord

ProductSearchOrderRecord getProductSearchOrderRecord(Type productRecordType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

productRecordType - an product record type

Returns:

the product search order record

Throws:

NullArgumentException - productRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(productRecordType) is false

Compliance:

mandatory - This method must be implemented.