org.osid.ordering

Interface OrderSearchOrder

All Superinterfaces:

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

public interface OrderSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getCloserSearchOrder() Gets the closer search order.
AgentSearchOrder	getClosingAgentSearchOrder() Gets the closing agent search order.
ResourceSearchOrder	getCustomerSearchOrder() Gets the customer search order.
OrderSearchOrderRecord	getOrderSearchOrderRecord(Type orderRecordType) Gets the order search order record corresponding to the given order record Type.
ResourceSearchOrder	getSubmitterSearchOrder() Gets the submitter search order.
AgentSearchOrder	getSubmittingAgentSearchOrder() Gets the submitting agent search order.
void	orderByClosedDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the closed date.
void	orderByCloser(SearchOrderStyle style) Specifies a preference for ordering the result set by the closer.
void	orderByClosingAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the closer.
void	orderByCustomer(SearchOrderStyle style) Specifies a preference for ordering the result set by the customer.
void	orderBySubmitDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the submitted date.
void	orderBySubmitter(SearchOrderStyle style) Specifies a preference for ordering the result set by the submitter.
void	orderBySubmittingAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the submitting agent.
void	orderByTotalCost(SearchOrderStyle style) Specifies a preference for ordering the result set by the total cost.
boolean	supportsCloserSearchOrder() Tests if a closer search order is available.
boolean	supportsClosingAgentSearchOrder() Tests if a closing agent search order is available.
boolean	supportsCustomerSearchOrder() Tests if a customer search order is available.
boolean	supportsSubmitterSearchOrder() Tests if a submitter search order is available.
boolean	supportsSubmittingAgentSearchOrder() Tests if a submitting agent search 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

orderByCustomer

void orderByCustomer(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCustomerSearchOrder

boolean supportsCustomerSearchOrder()

Tests if a customer search order is available.

Returns:

true if a customer order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCustomerSearchOrder

ResourceSearchOrder getCustomerSearchOrder()

Gets the customer search order.

Returns:

the customer search order

Throws:

UnimplementedException - supportsCustomerSearchOrder() is false

Compliance:

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

orderByTotalCost

void orderByTotalCost(SearchOrderStyle style)

Specifies a preference for ordering the result set by the total cost.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySubmitDate

void orderBySubmitDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the submitted date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySubmitter

void orderBySubmitter(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSubmitterSearchOrder

boolean supportsSubmitterSearchOrder()

Tests if a submitter search order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmitterSearchOrder

ResourceSearchOrder getSubmitterSearchOrder()

Gets the submitter search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsSubmitterSearchOrder() is false

Compliance:

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

orderBySubmittingAgent

void orderBySubmittingAgent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the submitting agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSubmittingAgentSearchOrder

boolean supportsSubmittingAgentSearchOrder()

Tests if a submitting agent search order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentSearchOrder

AgentSearchOrder getSubmittingAgentSearchOrder()

Gets the submitting agent search order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsSubmittingAgentSearchOrder() is false

Compliance:

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

orderByClosedDate

void orderByClosedDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the closed date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCloser

void orderByCloser(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCloserSearchOrder

boolean supportsCloserSearchOrder()

Tests if a closer search order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCloserSearchOrder

AgentSearchOrder getCloserSearchOrder()

Gets the closer search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsCloserSearchOrder() is false

Compliance:

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

orderByClosingAgent

void orderByClosingAgent(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsClosingAgentSearchOrder

boolean supportsClosingAgentSearchOrder()

Tests if a closing agent search order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getClosingAgentSearchOrder

AgentSearchOrder getClosingAgentSearchOrder()

Gets the closing agent search order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsClosingAgentSearchOrder() is false

Compliance:

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

getOrderSearchOrderRecord

OrderSearchOrderRecord getOrderSearchOrderRecord(Type orderRecordType)
                                                 throws OperationFailedException

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

Parameters:

orderRecordType - a order record type

Returns:

the order search order record

Throws:

NullArgumentException - orderRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(orderRecordType) is false

Compliance:

mandatory - This method must be implemented.