org.osid.rules.check

Interface Instruction

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRelationship, OsidRule, Temporal

public interface Instruction
extends OsidRelationship, OsidEnabler

A Instruction appliies a Check to an Agenda.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	continueOnFail() Tests if evaluation of the next instruction should continue if the check in this instruction fails.
Agenda	getAgenda() Gets the agenda.
Id	getAgendaId() Gets the Id of the agenda.
Check	getCheck() Gets the check.
Id	getCheckId() Gets the Id of the check.
InstructionRecord	getInstructionRecord(Type instructionRecordType) Gets the instruction record corresponding to the given Instruction record Type.
DisplayText	getMessage() Gets the message to be returned upon failure of the check evaluation.
boolean	isWarning() Tests if failure of the check should be interpreted as a warning and not a failure.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getAgendaId

Id getAgendaId()

Gets the Id of the agenda.

Returns:

the agenda Id

Compliance:

mandatory - This method must be implemented.

getAgenda

Agenda getAgenda()
                 throws OperationFailedException

Gets the agenda.

Returns:

the agenda

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCheckId

Id getCheckId()

Gets the Id of the check.

Returns:

the check Id

Compliance:

mandatory - This method must be implemented.

getCheck

Check getCheck()
               throws OperationFailedException

Gets the check.

Returns:

the check

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getMessage

DisplayText getMessage()

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

Returns:

the message

Compliance:

mandatory - This method must be implemented.

isWarning

boolean isWarning()

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

Returns:

true if this is a warning, false if an error

Compliance:

mandatory - This method must be implemented.

continueOnFail

boolean continueOnFail()

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.

Returns:

true if this processing should continue on failure, false if processing should cease upon failure

Compliance:

mandatory - This method must be implemented.

getInstructionRecord

InstructionRecord getInstructionRecord(Type instructionRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

instructionRecordType - the type of instruction record to retrieve

Returns:

the instruction record

Throws:

NullArgumentException - instructionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionRecordType) is false

Compliance:

mandatory - This method must be implemented.