OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.Instruction
Implementsosid.OsidRelationship
osid.OsidEnabler
Description

A Instruction appliies a Check to an Agenda.

MethodgetAgendaId
Description

Gets the Id of the agenda.

Returnosid.id.Idthe agenda Id
CompliancemandatoryThis method must be implemented.
MethodgetAgenda
Description

Gets the agenda.

Returnosid.rules.check.Agendathe agenda
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCheckId
Description

Gets the Id of the check.

Returnosid.id.Idthe check Id
CompliancemandatoryThis method must be implemented.
MethodgetCheck
Description

Gets the check.

Returnosid.rules.check.Checkthe check
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetMessage
Description

Gets the message to be returned upon failure of the check evaluation.

Returnosid.locale.DisplayTextthe message
CompliancemandatoryThis method must be implemented.
MethodisWarning
Description

Tests if failure of the check should be interpreted as a warning and not a failure.

Returnboolean true if this is a warning, false if an error
CompliancemandatoryThis method must be implemented.
MethodcontinueOnFail
Description

Tests if evaluation of the next instruction should continue if the check in this instruction fails. While the overall evaluation of the agenda still fails, if true, allows for other messages to be gathered.

Returnboolean true if this processing should continue on failure, false if processing should cease upon failure
CompliancemandatoryThis method must be implemented.
MethodgetInstructionRecord
Description

Gets the instruction record corresponding to the given Instruction record Type. This method is used to retrieve an object implementing the requested record. The instructionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(instructionRecordType) is true .

Parametersosid.type.TypeinstructionRecordTypethe type of instruction record to retrieve
Returnosid.rules.check.records.InstructionRecordthe instruction 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.