OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTimeCheckStartDate
Description

Orders the results by the time check start date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTimeCheckEndDate
Description

Orders the results by the time end check date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTimeCheckEvent
Description

Orders the results by the time check event.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsTimeCheckEventSearchOrder
Description

Tests if an event search order is available.

Returnboolean true if an event search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimeCheckEventSearchOrder
Description

Gets the event search order.

Returnosid.calendaring.EventSearchOrderthe event search order
ErrorsILLEGAL_STATE supportsTimeCheckEventSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByTimeCheckCyclicEvent
Description

Orders the results by cyclic event.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsTimeCheckCyclicEventSearchOrder
Description

Tests if a cyclic event search order is available.

Returnboolean true if a cyclic event search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimeCheckCyclicEventSearchOrder
Description

Gets the cyclic event search order.

Returnosid.calendaring.cycle.CyclicEventSearchOrderthe cyclic event search order
ErrorsILLEGAL_STATE supportsTimeCheckCyclicEventSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByHoldCheckBlock
Description

Orders the results by block.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsHoldCheckBlockSearchOrder
Description

Tests if a block search order is available.

Returnboolean true if a block search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHoldCheckBlockSearchOrder
Description

Gets the block search order.

Returnosid.hold.BlockSearchOrderthe block search order
ErrorsILLEGAL_STATE supportsHoldCheckBlockSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByInquiryCheckAudit
Description

Orders the results by audit.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsInquiryCheckAuditSearchOrder
Description

Tests if an audit search order is available.

Returnboolean true if an audit search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquiryCheckAuditSearchOrder
Description

Gets the audit search order.

Returnosid.inquiry.AuditSearchOrderthe audit search order
ErrorsILLEGAL_STATE supportsInquiryCheckAuditSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByProcessCheckAgenda
Description

Orders the results by agenda.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsProcessCheckAgendaSearchOrder
Description

Tests if an agenda search order is available.

Returnboolean true if an agenda search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProcessCheckAgendaSearchOrder
Description

Gets the agenda search order.

Returnosid.rules.check.AgendaSearchOrderthe agenda search order
ErrorsILLEGAL_STATE supportsProcessCheckAgendaSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchOrderRecord
Description

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

Parametersosid.type.TypecheckRecordTypea check record type
Returnosid.rules.check.records.CheckSearchOrderRecordthe check search order record
ErrorsNULL_ARGUMENT checkRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(checkRecordType) is false
CompliancemandatoryThis method must be implemented.