org.osid.rules.check

Interface CheckSearchOrder

All Superinterfaces:

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

public interface CheckSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CheckSearchOrderRecord	getCheckSearchOrderRecord(Type checkRecordType) Gets the check search order record corresponding to the given check record Type.
BlockSearchOrder	getHoldCheckBlockSearchOrder() Gets the block search order.
AuditSearchOrder	getInquiryCheckAuditSearchOrder() Gets the audit search order.
AgendaSearchOrder	getProcessCheckAgendaSearchOrder() Gets the agenda search order.
CyclicEventSearchOrder	getTimeCheckCyclicEventSearchOrder() Gets the cyclic event search order.
EventSearchOrder	getTimeCheckEventSearchOrder() Gets the event search order.
void	orderByHoldCheckBlock(SearchOrderStyle style) Orders the results by block.
void	orderByInquiryCheckAudit(SearchOrderStyle style) Orders the results by audit.
void	orderByProcessCheckAgenda(SearchOrderStyle style) Orders the results by agenda.
void	orderByTimeCheckCyclicEvent(SearchOrderStyle style) Orders the results by cyclic event.
void	orderByTimeCheckEndDate(SearchOrderStyle style) Orders the results by the time end check date.
void	orderByTimeCheckEvent(SearchOrderStyle style) Orders the results by the time check event.
void	orderByTimeCheckStartDate(SearchOrderStyle style) Orders the results by the time check start date.
boolean	supportsHoldCheckBlockSearchOrder() Tests if a block search order is available.
boolean	supportsInquiryCheckAuditSearchOrder() Tests if an audit search order is available.
boolean	supportsProcessCheckAgendaSearchOrder() Tests if an agenda search order is available.
boolean	supportsTimeCheckCyclicEventSearchOrder() Tests if a cyclic event search order is available.
boolean	supportsTimeCheckEventSearchOrder() Tests if an event search order is available.

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

Method Detail

orderByTimeCheckStartDate

void orderByTimeCheckStartDate(SearchOrderStyle style)

Orders the results by the time check start date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTimeCheckEndDate

void orderByTimeCheckEndDate(SearchOrderStyle style)

Orders the results by the time end check date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTimeCheckEvent

void orderByTimeCheckEvent(SearchOrderStyle style)

Orders the results by the time check event.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTimeCheckEventSearchOrder

boolean supportsTimeCheckEventSearchOrder()

Tests if an event search order is available.

Returns:

true if an event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimeCheckEventSearchOrder

EventSearchOrder getTimeCheckEventSearchOrder()

Gets the event search order.

Returns:

the event search order

Throws:

IllegalStateException - supportsTimeCheckEventSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByTimeCheckCyclicEvent

void orderByTimeCheckCyclicEvent(SearchOrderStyle style)

Orders the results by cyclic event.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTimeCheckCyclicEventSearchOrder

boolean supportsTimeCheckCyclicEventSearchOrder()

Tests if a cyclic event search order is available.

Returns:

true if a cyclic event search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimeCheckCyclicEventSearchOrder

CyclicEventSearchOrder getTimeCheckCyclicEventSearchOrder()

Gets the cyclic event search order.

Returns:

the cyclic event search order

Throws:

IllegalStateException - supportsTimeCheckCyclicEventSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByHoldCheckBlock

void orderByHoldCheckBlock(SearchOrderStyle style)

Orders the results by block.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsHoldCheckBlockSearchOrder

boolean supportsHoldCheckBlockSearchOrder()

Tests if a block search order is available.

Returns:

true if a block search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getHoldCheckBlockSearchOrder

BlockSearchOrder getHoldCheckBlockSearchOrder()

Gets the block search order.

Returns:

the block search order

Throws:

IllegalStateException - supportsHoldCheckBlockSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByInquiryCheckAudit

void orderByInquiryCheckAudit(SearchOrderStyle style)

Orders the results by audit.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsInquiryCheckAuditSearchOrder

boolean supportsInquiryCheckAuditSearchOrder()

Tests if an audit search order is available.

Returns:

true if an audit search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquiryCheckAuditSearchOrder

AuditSearchOrder getInquiryCheckAuditSearchOrder()

Gets the audit search order.

Returns:

the audit search order

Throws:

IllegalStateException - supportsInquiryCheckAuditSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByProcessCheckAgenda

void orderByProcessCheckAgenda(SearchOrderStyle style)

Orders the results by agenda.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProcessCheckAgendaSearchOrder

boolean supportsProcessCheckAgendaSearchOrder()

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.

getProcessCheckAgendaSearchOrder

AgendaSearchOrder getProcessCheckAgendaSearchOrder()

Gets the agenda search order.

Returns:

the agenda search order

Throws:

IllegalStateException - supportsProcessCheckAgendaSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getCheckSearchOrderRecord

CheckSearchOrderRecord getCheckSearchOrderRecord(Type checkRecordType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

checkRecordType - a check record type

Returns:

the check search order record

Throws:

NullArgumentException - checkRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(checkRecordType) is false

Compliance:

mandatory - This method must be implemented.