org.osid.provisioning

Interface ProvisionSearchOrder

All Superinterfaces:

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

public interface ProvisionSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerSearchOrder	getBrokerSearchOrder() Gets the broker search order.
ProvisionableSearchOrder	getProvisionableSearchOrder() Gets the provisionable search order.
ProvisionReturnSearchOrder	getProvisionReturnSearchOrder() Gets the provision return search order.
ProvisionSearchOrderRecord	getProvisionSearchOrderRecord(Type provisionRecordType) Gets the provision search order record corresponding to the given provision record Type.
ResourceSearchOrder	getRecipientSearchOrder() Gets the resource search order.
RequestSearchOrder	getRequestSearchOrder() Gets the request search order.
void	orderByBroker(SearchOrderStyle style) Orders the results by the broker.
void	orderByCost(SearchOrderStyle style) Orders the results by the cost.
void	orderByDueDate(SearchOrderStyle style) Orders the results by the due date.
void	orderByLeased(SearchOrderStyle style) Orders the results by the leased flag.
void	orderByMustReturn(SearchOrderStyle style) Orders the results by the must return flag.
void	orderByProvisionable(SearchOrderStyle style) Orders the results by the provisionable.
void	orderByProvisionDate(SearchOrderStyle style) Orders the results by the provision date.
void	orderByProvisionReturn(SearchOrderStyle style) Orders the results by returned.
void	orderByRate(SearchOrderStyle style) Orders the results by the rate amount and period.
void	orderByRecipient(SearchOrderStyle style) Orders the results by the recipient.
void	orderByRequest(SearchOrderStyle style) Orders the results by the request.
boolean	supportsBrokerSearchOrder() Tests if a broker search order is available.
boolean	supportsProvisionableSearchOrder() Tests if a provisionable search order is available.
boolean	supportsProvisionReturnSearchOrder() Tests if a provision return search order is available.
boolean	supportsRecipientSearchOrder() Tests if a resource search order is available.
boolean	supportsRequestSearchOrder() Tests if a request 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

orderByBroker

void orderByBroker(SearchOrderStyle style)

Orders the results by the broker.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBrokerSearchOrder

boolean supportsBrokerSearchOrder()

Tests if a broker search order is available.

Returns:

true if a broker search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerSearchOrder

BrokerSearchOrder getBrokerSearchOrder()

Gets the broker search order.

Returns:

the broker search order

Throws:

IllegalStateException - supportsBrokerSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByProvisionable

void orderByProvisionable(SearchOrderStyle style)

Orders the results by the provisionable.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProvisionableSearchOrder

boolean supportsProvisionableSearchOrder()

Tests if a provisionable search order is available.

Returns:

true if a provisionable search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchOrder

ProvisionableSearchOrder getProvisionableSearchOrder()

Gets the provisionable search order.

Returns:

the provisionable search order

Throws:

IllegalStateException - supportsProvisionableSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByRecipient

void orderByRecipient(SearchOrderStyle style)

Orders the results by the recipient.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRecipientSearchOrder

boolean supportsRecipientSearchOrder()

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.

getRecipientSearchOrder

ResourceSearchOrder getRecipientSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsRecipientSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByRequest

void orderByRequest(SearchOrderStyle style)

Orders the results by the request.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRequestSearchOrder

boolean supportsRequestSearchOrder()

Tests if a request search order is available.

Returns:

true if a request search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRequestSearchOrder

RequestSearchOrder getRequestSearchOrder()

Gets the request search order.

Returns:

the request search order

Throws:

IllegalStateException - supportsRequestSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByProvisionDate

void orderByProvisionDate(SearchOrderStyle style)

Orders the results by the provision date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLeased

void orderByLeased(SearchOrderStyle style)

Orders the results by the leased flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMustReturn

void orderByMustReturn(SearchOrderStyle style)

Orders the results by the must return flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDueDate

void orderByDueDate(SearchOrderStyle style)

Orders the results by the due date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCost

void orderByCost(SearchOrderStyle style)

Orders the results by the cost.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRate

void orderByRate(SearchOrderStyle style)

Orders the results by the rate amount and period.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProvisionReturn

void orderByProvisionReturn(SearchOrderStyle style)

Orders the results by returned.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProvisionReturnSearchOrder

boolean supportsProvisionReturnSearchOrder()

Tests if a provision return search order is available.

Returns:

true if a provision return search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProvisionReturnSearchOrder

ProvisionReturnSearchOrder getProvisionReturnSearchOrder()

Gets the provision return search order.

Returns:

the provision return search order

Throws:

IllegalStateException - supportsProvisionReturnSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getProvisionSearchOrderRecord

ProvisionSearchOrderRecord getProvisionSearchOrderRecord(Type provisionRecordType)
                                                         throws OperationFailedException

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

Parameters:

provisionRecordType - a provision record type

Returns:

the provision search order record

Throws:

NullArgumentException - provisionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionRecordType) is false

Compliance:

mandatory - This method must be implemented.