org.osid.hold

Interface IssueSearchOrder

All Superinterfaces:

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

public interface IssueSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ResourceSearchOrder	getBureauSearchOrder() Gets the resource search order.
IssueSearchOrderRecord	getIssueSearchOrderRecord(Type issueRecordType) Gets the issue search order record corresponding to the given issue record Type.
void	orderByBureau(SearchOrderStyle style) Orders the results by resource.
boolean	supportsBureauSearchOrder() Tests if a resource 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

orderByBureau

void orderByBureau(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBureauSearchOrder

boolean supportsBureauSearchOrder()

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.

getBureauSearchOrder

ResourceSearchOrder getBureauSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResourceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getIssueSearchOrderRecord

IssueSearchOrderRecord getIssueSearchOrderRecord(Type issueRecordType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

issueRecordType - an issue record type

Returns:

the issue search order record

Throws:

NullArgumentException - issueRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(issueRecordType) is false

Compliance:

mandatory - This method must be implemented.