Interface ProvisionReturnSearchOrder

All Superinterfaces:

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

public interface ProvisionReturnSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
ProvisionReturnSearchOrderRecord	getProvisionReturnSearchOrderRecord(Type provisionReturnRecordType)	Gets the provision return search order record corresponding to the given provision return record Type .
ResourceSearchOrder	getReturnerSearchOrder()	Gets the resource search order.
AgentSearchOrder	getReturningAgentSearchOrder()	Gets the agent search order.
void	orderByReturnDate(SearchOrderStyle style)	Orders the results by the return date.
void	orderByReturner(SearchOrderStyle style)	Orders the results by the returner.
void	orderByReturningAgent(SearchOrderStyle style)	Orders the results by the returning agent.
boolean	supportsReturnerSearchOrder()	Tests if a resource search order is available.
boolean	supportsReturningAgentSearchOrder()	Tests if an agent 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 .

Method Details

orderByReturnDate

void orderByReturnDate(SearchOrderStyle style)

Orders the results by the return date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByReturner

void orderByReturner(SearchOrderStyle style)

Orders the results by the returner.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsReturnerSearchOrder

boolean supportsReturnerSearchOrder()

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.

getReturnerSearchOrder

ResourceSearchOrder getReturnerSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsReturnerSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByReturningAgent

void orderByReturningAgent(SearchOrderStyle style)

Orders the results by the returning agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsReturningAgentSearchOrder

boolean supportsReturningAgentSearchOrder()

Tests if an agent search order is available.

Returns:

true if an agent search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReturningAgentSearchOrder

AgentSearchOrder getReturningAgentSearchOrder()

Gets the agent search order.

Returns:

the agent search order

Throws:

IllegalStateException - supportsReturningAgentSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getProvisionReturnSearchOrderRecord

ProvisionReturnSearchOrderRecord getProvisionReturnSearchOrderRecord(Type provisionReturnRecordType)
                                                              throws OperationFailedException

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

Parameters:

provisionReturnRecordType - a provision return record type

Returns:

the provision return search order record

Throws:

NullArgumentException - provisionReturnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionReturnRecordType) is false

Compliance:

mandatory - This method must be implemented.