org.osid.rules.check

Interface InstructionSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidEnablerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRelationshipSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface InstructionSearchOrder
extends OsidRelationshipSearchOrder, OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgendaSearchOrder	getAgendaSearchOrder() Gets the agenda search order.
CheckSearchOrder	getCheckSearchOrder() Gets the check search order.
InstructionSearchOrderRecord	getInstructionSearchOrderRecord(Type instructionRecordType) Gets the instruction search order record corresponding to the given instruction record Type.
void	orderByAgenda(SearchOrderStyle style) Orders the results by agenda.
void	orderByCheck(SearchOrderStyle style) Orders the results by check.
void	orderByContinueOnFail(SearchOrderStyle style) Orders the results by the continue-on-fail flag.
void	orderByMessage(SearchOrderStyle style) Orders the results by message.
void	orderByWarning(SearchOrderStyle style) Orders the results by the warning flag.
boolean	supportsAgendaSearchOrder() Tests if an agenda search order is available.
boolean	supportsCheckSearchOrder() Tests if a check search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidEnablerSearchOrder

getCyclicEventSearchOrder, getDemographicSearchOrder, getEventSearchOrder, getScheduleSearchOrder, orderByCyclicEvent, orderByDemographic, orderByEvent, orderBySchedule, supportsCyclicEventSearchOrder, supportsDemographicSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByAgenda

void orderByAgenda(SearchOrderStyle style)

Orders the results by agenda.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgendaSearchOrder

boolean supportsAgendaSearchOrder()

Tests if an agenda search order is available.

Returns:

true if an agenda search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgendaSearchOrder

AgendaSearchOrder getAgendaSearchOrder()

Gets the agenda search order.

Returns:

the agenda search order

Throws:

IllegalStateException - supportsAgendaSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByCheck

void orderByCheck(SearchOrderStyle style)

Orders the results by check.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCheckSearchOrder

boolean supportsCheckSearchOrder()

Tests if a check search order is available.

Returns:

true if a check search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCheckSearchOrder

CheckSearchOrder getCheckSearchOrder()

Gets the check search order.

Returns:

the check search order

Throws:

IllegalStateException - supportsCheckSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByMessage

void orderByMessage(SearchOrderStyle style)

Orders the results by message.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByWarning

void orderByWarning(SearchOrderStyle style)

Orders the results by the warning flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByContinueOnFail

void orderByContinueOnFail(SearchOrderStyle style)

Orders the results by the continue-on-fail flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getInstructionSearchOrderRecord

InstructionSearchOrderRecord getInstructionSearchOrderRecord(Type instructionRecordType)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

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

Parameters:

instructionRecordType - an instruction record type

Returns:

the instruction search order record

Throws:

NullArgumentException - instructionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionRecordType) is false

Compliance:

mandatory - This method must be implemented.