OSID - osid.checklist.mason.TodoProducer Service Interface Definition

Interface	osid.checklist.mason.TodoProducer
Implements	`osid.OsidRule`
Used By	`osid.checklist.mason.TodoProducerAdminSession`
	`osid.checklist.mason.TodoProducerList`
	`osid.checklist.mason.TodoProducerLookupSession`
Description	A `TodoProducer` describes the mason for making `Todos` .
Method	isCreationRule
Description	Tests if a todo should be created or destroyed.
Return	`boolean`		`true` if a creation rule, `false` if a destruction rule
Compliance	`mandatory`		This method must be implemented.
Method	isBasedOnTimeCycle
Description	Tests if a todo should be produced based on a time cycle.
Return	`boolean`		`true` if based on a timecycle, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventId
Description	Gets the cyclic event `Id` .
Return	`osid.id.Id`		the cyclic event `Id`
Errors	ILLEGAL_STATE		`isBasedOnTimeCycle()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEvent
Description	Gets the cyclic event.
Return	`osid.calendaring.cycle.CyclicEvent`		the cyclic event
Errors	ILLEGAL_STATE		`isBasedOnTimeCycle()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isBasedOnStock
Description	Tests if a todo should be produced based on an item level in a stock.
Return	`boolean`		`true` if based on a stock, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStockLevel
Description	Gets the stock level.
Return	`cardinal`		the stock level
Errors	ILLEGAL_STATE		`isBasedOnStock()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getStockId
Description	Gets the stock `Id` .
Return	`osid.id.Id`		the stock `Id`
Errors	ILLEGAL_STATE		`isBasedOnStock()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getStock
Description	Gets the stock.
Return	`osid.inventory.Stock`		the stock
Errors	ILLEGAL_STATE		`isBasedOnStock()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTodoProducerRecord
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` .
Parameters	`osid.type.Type`	`todoProducerRecordType`	the type of todo producer record to retrieve
Return	`osid.checklist.mason.records.TodoProducerRecord`		the todo producer record
Errors	NULL_ARGUMENT		`todoProducerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(todoProducerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.