public interface Instruction extends OsidRelationship, OsidEnabler
A Instruction
appliies a Check
to an
Agenda.
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.
|
getEndReason, getEndReasonId, hasEndReason
getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getEndDate, getStartDate, isEffective
Id getAgendaId()
Id
of the agenda. Id
mandatory
- This method must be implemented. Agenda getAgenda() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getCheckId()
Id
of the check. Id
mandatory
- This method must be implemented. Check getCheck() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DisplayText getMessage()
mandatory
- This method must be implemented. boolean isWarning()
true
if this is a warning, false
if an errormandatory
- This method must be implemented. boolean continueOnFail()
true
if this processing should continue on
failure, false
if processing should cease upon
failuremandatory
- This method must be implemented. InstructionRecord getInstructionRecord(Type instructionRecordType) throws OperationFailedException, PermissionDeniedException
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
.instructionRecordType
- the type of instruction record to
retrieveNullArgumentException
- instructionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(instructionRecordType)
is false
mandatory
- This method must be implemented.