OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducer
Implementsosid.OsidRule
Description

A TodoProducer describes the mason for making Todos.

MethodisCreationRule
Description

Tests if a todo should be created or destroyed.

Returnboolean true if a creation rule, false if a destruction rule
CompliancemandatoryThis method must be implemented.
MethodisBasedOnTimeCycle
Description

Tests if a todo should be produced based on a time cycle.

Returnboolean true if based on a timecycle, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventId
Description

Gets the cyclic event Id.

Returnosid.id.Idthe cyclic event Id
ErrorsILLEGAL_STATE isBasedOnTimeCycle() is false
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEvent
Description

Gets the cyclic event.

Returnosid.calendaring.cycle.CyclicEventthe cyclic event
ErrorsILLEGAL_STATE isBasedOnTimeCycle() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisBasedOnStock
Description

Tests if a todo should be produced based on an item level in a stock.

Returnboolean true if based on a stock, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStockLevel
Description

Gets the stock level.

Returncardinalthe stock level
ErrorsILLEGAL_STATE isBasedOnStock() is false
CompliancemandatoryThis method must be implemented.
MethodgetStockId
Description

Gets the stock Id.

Returnosid.id.Idthe stock Id
ErrorsILLEGAL_STATE isBasedOnStock() is false
CompliancemandatoryThis method must be implemented.
MethodgetStock
Description

Gets the stock.

Returnosid.inventory.Stockthe stock
ErrorsILLEGAL_STATE isBasedOnStock() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerRecord
Description

Gets the todo producer record corresponding to the given TodoProducer record Type. This method is used to retrieve an object implementing the requested record. The todoProducerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(todoProducerRecordType) is true .

Parametersosid.type.TypetodoProducerRecordTypethe type of todo producer record to retrieve
Returnosid.checklist.mason.records.TodoProducerRecordthe todo producer record
ErrorsNULL_ARGUMENT todoProducerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoProducerRecordType) is false
CompliancemandatoryThis method must be implemented.