OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByCreationRule
Description

Specifies a preference for ordering the result set by the creation rule flag.

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

Specifies a preference for ordering the result set by the cyclic event.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventSearchOrder
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.
MethodgetCyclicEventSearchOrder
Description

Gets the cyclic event search order.

Returnosid.calendaring.cycle.CyclicEventSearchOrderthe cyclic event search order
ErrorsUNIMPLEMENTED supportsCyclicEventSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCyclicEventSearchOrder() is true.
MethodorderByStock
Description

Specifies a preference for ordering the result set by the stock.

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

Tests if a stock search order is available.

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

Gets the stock search order.

Returnosid.inventory.StockSearchOrderthe stock search order
ErrorsUNIMPLEMENTED supportsStockSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStockSearchOrder() is true.
MethodorderByStockLevel
Description

Specifies a preference for ordering the result set by the stock level.

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

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

Parametersosid.type.TypetodoProducerRecordTypea todo producer record type
Returnosid.checklist.mason.records.TodoProducerSearchOrderRecordthe todo producer search order record
ErrorsNULL_ARGUMENT todoProducerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoProducerRecordType) is false
CompliancemandatoryThis method must be implemented.