org.osid.acknowledgement

Interface CreditSearchOrder

All Superinterfaces:

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

public interface CreditSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CreditSearchOrderRecord	getCreditSearchOrderRecord(Type creditRecordType) Gets the credit search order record corresponding to the given credit record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByReference(SearchOrderStyle style) Specifies a preference for ordering the result set by the reference.
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsResourceSearchOrder() Tests if a resource search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByReference

void orderByReference(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

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 search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsResourceSearchOrder() is true.

getCreditSearchOrderRecord

CreditSearchOrderRecord getCreditSearchOrderRecord(Type creditRecordType)
                                                   throws OperationFailedException

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

Parameters:

creditRecordType - a credit record type

Returns:

the credit search order record

Throws:

NullArgumentException - creditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(creditRecordType) is false

Compliance:

mandatory - This method must be implemented.