org.osid.hold

Interface HoldSearchOrder

All Superinterfaces:

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

public interface HoldSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getAgentSearchOrder() Gets the agent search order.
HoldSearchOrderRecord	getHoldSearchOrderRecord(Type holdRecordType) Gets the hold search order record corresponding to the given hold record Type.
IssueSearchOrder	getIssueSearchOrder() Gets the issue search order.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByAgent(SearchOrderStyle style) Orders the results by agent.
void	orderByIssue(SearchOrderStyle style) Orders the results by issue.
void	orderByResource(SearchOrderStyle style) Orders the results by resource.
boolean	supportsAgentSearchOrder() Tests if an agent search order is available.
boolean	supportsIssueSearchOrder() Tests if an issue search order is available.
boolean	supportsResourceSearchOrder() Tests if a resource 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

orderByResource

void orderByResource(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

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.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResourceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByAgent

void orderByAgent(SearchOrderStyle style)

Orders the results by agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

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.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets the agent search order.

Returns:

the agent search order

Throws:

IllegalStateException - supportsAgentSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByIssue

void orderByIssue(SearchOrderStyle style)

Orders the results by issue.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsIssueSearchOrder

boolean supportsIssueSearchOrder()

Tests if an issue search order is available.

Returns:

true if an issue search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueSearchOrder

IssueSearchOrder getIssueSearchOrder()

Gets the issue search order.

Returns:

the issue search order

Throws:

IllegalStateException - supportsIssueSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getHoldSearchOrderRecord

HoldSearchOrderRecord getHoldSearchOrderRecord(Type holdRecordType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

holdRecordType - a hold record type

Returns:

the hold search order record

Throws:

NullArgumentException - holdRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdRecordType) is false

Compliance:

mandatory - This method must be implemented.