Interface | osid.checklist.mason.TodoProducerForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getCreationRuleMetadata | ||
Description |
Gets the metadata for a creation rule flag. | ||
Return | osid.Metadata | metadata for a creation operation | |
Compliance | mandatory | This method must be implemented. | |
Method | setCreationRule | ||
Description |
Sets the cyclic event. | ||
Parameters | boolean | creation | the new creationr ule flag |
Errors | INVALID_ARGUMENT | creation is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreationRule | ||
Description |
Clears the creation rule flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventMetadata | ||
Description |
Gets the metadata for a cyclic event. | ||
Return | osid.Metadata | metadata for a cyclic event | |
Compliance | mandatory | This method must be implemented. | |
Method | setCyclicEvent | ||
Description |
Sets the cyclic event. | ||
Parameters | osid.id.Id | cyclicEventId | the new cyclic event |
Errors | INVALID_ARGUMENT | cyclicEventId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | cyclicEventId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCyclicEvent | ||
Description |
Clears the cyclic event. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockMetadata | ||
Description |
Gets the metadata for a cyclic event. | ||
Return | osid.Metadata | metadata for a cyclic event | |
Compliance | mandatory | This method must be implemented. | |
Method | setStock | ||
Description |
Sets the stock. | ||
Parameters | osid.id.Id | stockId | the new stock |
Errors | INVALID_ARGUMENT | stockId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | stockId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearStock | ||
Description |
Clears the stock. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockLevelMetadata | ||
Description |
Gets the metadata for the stock level. | ||
Return | osid.Metadata | metadata for the stock level | |
Compliance | mandatory | This method must be implemented. | |
Method | setStockLevel | ||
Description |
Sets the stock level. | ||
Parameters | cardinal | level | the new stock level |
Errors | INVALID_ARGUMENT | level is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearStockLevel | ||
Description |
Clears the stock level. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodoProducerFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | todoProducerRecordType | a todo producer record type |
Return | osid.checklist.mason.records.TodoProducerFormRecord | the todo producer form 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. |