public interface InstructionSearchOrder extends OsidRelationshipSearchOrder, OsidEnablerSearchOrder
An interface for specifying the ordering of search results.
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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
getCyclicEventSearchOrder, getDemographicSearchOrder, getEventSearchOrder, getScheduleSearchOrder, orderByCyclicEvent, orderByDemographic, orderByEvent, orderBySchedule, supportsCyclicEventSearchOrder, supportsDemographicSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
orderByEffective, orderByEndDate, orderByStartDate
void orderByAgenda(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAgendaSearchOrder()
true
if an agenda search order is available,
false
otherwisemandatory
- This method must be implemented. AgendaSearchOrder getAgendaSearchOrder()
IllegalStateException
-
supportsAgendaSearchOrder()
is false
mandatory
- This method must be implemented. void orderByCheck(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCheckSearchOrder()
true
if a check search order is available,
false
otherwisemandatory
- This method must be implemented. CheckSearchOrder getCheckSearchOrder()
IllegalStateException
-
supportsCheckSearchOrder()
is false
mandatory
- This method must be implemented. void orderByMessage(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByWarning(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByContinueOnFail(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. InstructionSearchOrderRecord getInstructionSearchOrderRecord(Type instructionRecordType) throws OperationFailedException, PermissionDeniedException
Type.
Multiple retrievals return the
same underlying object.instructionRecordType
- an instruction record typeNullArgumentException
- instructionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(instructionRecordType)
is false
mandatory
- This method must be implemented.