org.osid.inquiry

Interface ResponseSearchOrder

All Superinterfaces:

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

public interface ResponseSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
InquirySearchOrder	getInquirySearchOrder() Gets the inquiry search order.
ResourceSearchOrder	getResponderSearchOrder() Gets the responder resource search order.
AgentSearchOrder	getRespondingAgentSearchOrder() Gets the responding agent search order.
ResponseSearchOrderRecord	getResponseSearchOrderRecord(Type responseRecordType) Gets the response search order record corresponding to the given response record Type.
void	orderByAffirmative(SearchOrderStyle style) Orders the results by affirmative responses.
void	orderByInquiry(SearchOrderStyle style) Orders the results by inquiry.
void	orderByResponder(SearchOrderStyle style) Orders the results by responder resource.
void	orderByRespondingAgent(SearchOrderStyle style) Orders the results by responding agent.
boolean	supportsInquirySearchOrder() Tests if an inquiry search order is available.
boolean	supportsResponderSearchOrder() Tests if a responder resource search order is available.
boolean	supportsRespondingAgentSearchOrder() Tests if a responding agent 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

orderByInquiry

void orderByInquiry(SearchOrderStyle style)

Orders the results by inquiry.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsInquirySearchOrder

boolean supportsInquirySearchOrder()

Tests if an inquiry search order is available.

Returns:

true if an inquiry search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquirySearchOrder

InquirySearchOrder getInquirySearchOrder()

Gets the inquiry search order.

Returns:

the inquiry search order

Throws:

IllegalStateException - supportsInquirySearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByResponder

void orderByResponder(SearchOrderStyle style)

Orders the results by responder resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResponderSearchOrder

boolean supportsResponderSearchOrder()

Tests if a responder resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResponderSearchOrder

ResourceSearchOrder getResponderSearchOrder()

Gets the responder resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResponderSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByRespondingAgent

void orderByRespondingAgent(SearchOrderStyle style)

Orders the results by responding agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRespondingAgentSearchOrder

boolean supportsRespondingAgentSearchOrder()

Tests if a responding agent search order is available.

Returns:

true if an agent search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRespondingAgentSearchOrder

AgentSearchOrder getRespondingAgentSearchOrder()

Gets the responding agent search order.

Returns:

the agent search order

Throws:

IllegalStateException - supportsRespondingAgentSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByAffirmative

void orderByAffirmative(SearchOrderStyle style)

Orders the results by affirmative responses.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getResponseSearchOrderRecord

ResponseSearchOrderRecord getResponseSearchOrderRecord(Type responseRecordType)
                                                       throws OperationFailedException

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

Parameters:

responseRecordType - a response record type

Returns:

the response order record interface

Throws:

NullArgumentException - responseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseRecordType) is false

Compliance:

mandatory - This method must be implemented.