OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionForm
Implementsosid.OsidRelationshipForm
osid.OsidEnablerForm
Description

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

MethodgetMessageMetadata
Description

Gets the metadata for the message.

Returnosid.Metadatametadata for the message
CompliancemandatoryThis method must be implemented.
MethodsetMessage
Description

Sets the message.

Parametersstringmessagethe new message
ErrorsINVALID_ARGUMENT message is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT message is null
CompliancemandatoryThis method must be implemented.
MethodclearMessage
Description

Removes the message.

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

Gets the metadata for the warning flag.

Returnosid.Metadatametadata for the warning flag
CompliancemandatoryThis method must be implemented.
MethodsetWarning
Description

Sets the warning flag.

Parametersbooleanwarningthe new warning flag
ErrorsINVALID_ARGUMENT warning is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearWarning
Description

Removes the warning flag.

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

Gets the metadata for the continue-on-fail flag.

Returnosid.Metadatametadata for the continue-on-fail flag
CompliancemandatoryThis method must be implemented.
MethodsetContinueOnFail
Description

Sets the continue-on-fail flag.

Parametersbooleancofthe new continue-on-fail flag
ErrorsINVALID_ARGUMENT cof is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearContinueOnFail
Description

Removes the continue-on-fail flag.

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

Gets the InstructionFormRecord corresponding to the given instruction record Type.

Parametersosid.type.TypeinstructionRecordTypean instruction record type
Returnosid.rules.check.records.InstructionFormRecordthe instruction form record
ErrorsNULL_ARGUMENT instructionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(instructionRecordType) is false
CompliancemandatoryThis method must be implemented.