org.osid.provisioning

Interface RequestTransactionSearchOrder

All Superinterfaces:

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

public interface RequestTransactionSearchOrder
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.
RequestTransactionSearchOrderRecord	getRequestTransactionSearchOrderRecord(Type requestTransactionRecordType) Gets the request transaction search order record corresponding to the given request record Type.
ResourceSearchOrder	getSubmitterSearchOrder() Gets the resource search order.
AgentSearchOrder	getSubmittingAgentSearchOrder() Gets the agent search order.
void	orderByBroker(SearchOrderStyle style) Orders the results by the broker.
void	orderBySubmitDate(SearchOrderStyle style) Orders the results by the submit date.
void	orderBySubmitter(SearchOrderStyle style) Orders the results by the submitter.
void	orderBySubmittingAgent(SearchOrderStyle style) Orders the results by submitting agent.
boolean	supportsBrokerSearchOrder() Tests if a broker search order is available.
boolean	supportsSubmitterSearchOrder() Tests if a resource search order is available.
boolean	supportsSubmittingAgentSearchOrder() Tests if an 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

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.

orderBySubmitDate

void orderBySubmitDate(SearchOrderStyle style)

Orders the results by the submit date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySubmitter

void orderBySubmitter(SearchOrderStyle style)

Orders the results 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 resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmitterSearchOrder

ResourceSearchOrder getSubmitterSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsSubmitterSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderBySubmittingAgent

void orderBySubmittingAgent(SearchOrderStyle style)

Orders the results by submitting agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSubmittingAgentSearchOrder

boolean supportsSubmittingAgentSearchOrder()

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.

getSubmittingAgentSearchOrder

AgentSearchOrder getSubmittingAgentSearchOrder()

Gets the agent search order.

Returns:

the agent search order

Throws:

IllegalStateException - supportsSubmittingAgentSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getRequestTransactionSearchOrderRecord

RequestTransactionSearchOrderRecord getRequestTransactionSearchOrderRecord(Type requestTransactionRecordType)
                                                                           throws OperationFailedException

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

Parameters:

requestTransactionRecordType - a request transaction record type

Returns:

the request transaction search order record

Throws:

NullArgumentException - requestTransactionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionRecordType) is false

Compliance:

mandatory - This method must be implemented.