OSID Logo
OSID Specifications
checklist mason package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.mason.TodoProducerForm
Implementsosid.OsidRuleForm
Description

This is the form for creating and updating TodoProducers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the TodoProducerAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCreationRuleMetadata
Description

Gets the metadata for a creation rule flag.

Returnosid.Metadatametadata for a creation operation
CompliancemandatoryThis method must be implemented.
MethodsetCreationRule
Description

Sets the cyclic event.

Parametersbooleancreationthe new creationr ule flag
ErrorsINVALID_ARGUMENT creation is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCreationRule
Description

Clears the creation rule flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventMetadata
Description

Gets the metadata for a cyclic event.

Returnosid.Metadatametadata for a cyclic event
CompliancemandatoryThis method must be implemented.
MethodsetCyclicEvent
Description

Sets the cyclic event.

Parametersosid.id.IdcyclicEventIdthe new cyclic event
ErrorsINVALID_ARGUMENT cyclicEventId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT cyclicEventId is null
CompliancemandatoryThis method must be implemented.
MethodclearCyclicEvent
Description

Clears the cyclic event.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetStockMetadata
Description

Gets the metadata for a cyclic event.

Returnosid.Metadatametadata for a cyclic event
CompliancemandatoryThis method must be implemented.
MethodsetStock
Description

Sets the stock.

Parametersosid.id.IdstockIdthe new stock
ErrorsINVALID_ARGUMENT stockId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stockId is null
CompliancemandatoryThis method must be implemented.
MethodclearStock
Description

Clears the stock.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetStockLevelMetadata
Description

Gets the metadata for the stock level.

Returnosid.Metadatametadata for the stock level
CompliancemandatoryThis method must be implemented.
MethodsetStockLevel
Description

Sets the stock level.

Parameterscardinallevelthe new stock level
ErrorsINVALID_ARGUMENT level is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearStockLevel
Description

Clears the stock level.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTodoProducerFormRecord
Description

Gets the TodoProducerFormRecord corresponding to the given todo producer record Type.

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