Interface | osid.rules.check.InstructionForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
osid.OsidEnablerForm | |||
Description |
This is the form for creating and updating | ||
Method | getMessageMetadata | ||
Description |
Gets the metadata for the message. | ||
Return | osid.Metadata | metadata for the message | |
Compliance | mandatory | This method must be implemented. | |
Method | setMessage | ||
Description |
Sets the message. | ||
Parameters | string | message | the new message |
Errors | INVALID_ARGUMENT | message is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | message is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearMessage | ||
Description |
Removes the message. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarningMetadata | ||
Description |
Gets the metadata for the warning flag. | ||
Return | osid.Metadata | metadata for the warning flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setWarning | ||
Description |
Sets the warning flag. | ||
Parameters | boolean | warning | the new warning flag |
Errors | INVALID_ARGUMENT | warning is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearWarning | ||
Description |
Removes the warning flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getContinueOnFailMetadata | ||
Description |
Gets the metadata for the continue-on-fail flag. | ||
Return | osid.Metadata | metadata for the continue-on-fail flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setContinueOnFail | ||
Description |
Sets the continue-on-fail flag. | ||
Parameters | boolean | cof | the new continue-on-fail flag |
Errors | INVALID_ARGUMENT | cof is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearContinueOnFail | ||
Description |
Removes the continue-on-fail flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructionFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | instructionRecordType | an instruction record type |
Return | osid.rules.check.records.InstructionFormRecord | the instruction form record | |
Errors | NULL_ARGUMENT | instructionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(instructionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |