org.osid.rules.check

Interface InstructionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRelationshipForm, OsidRuleForm, OsidTemporalForm, Suppliable

public interface InstructionForm
extends OsidRelationshipForm, OsidEnablerForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearContinueOnFail() Removes the continue-on-fail flag.
void	clearMessage() Removes the message.
void	clearWarning() Removes the warning flag.
Metadata	getContinueOnFailMetadata() Gets the metadata for the continue-on-fail flag.
InstructionFormRecord	getInstructionFormRecord(Type instructionRecordType) Gets the InstructionFormRecord corresponding to the given instruction record Type.
Metadata	getMessageMetadata() Gets the metadata for the message.
Metadata	getWarningMetadata() Gets the metadata for the warning flag.
void	setContinueOnFail(boolean cof) Sets the continue-on-fail flag.
void	setMessage(java.lang.String message) Sets the message.
void	setWarning(boolean warning) Sets the warning flag.

Methods inherited from interface org.osid.OsidEnablerForm

clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getMessageMetadata

Metadata getMessageMetadata()

Gets the metadata for the message.

Returns:

metadata for the message

Compliance:

mandatory - This method must be implemented.

setMessage

void setMessage(java.lang.String message)

Sets the message.

Parameters:

message - the new message

Throws:

InvalidArgumentException - message is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - message is null

Compliance:

mandatory - This method must be implemented.

clearMessage

void clearMessage()

Removes the message.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getWarningMetadata

Metadata getWarningMetadata()

Gets the metadata for the warning flag.

Returns:

metadata for the warning flag

Compliance:

mandatory - This method must be implemented.

setWarning

void setWarning(boolean warning)

Sets the warning flag.

Parameters:

warning - the new warning flag

Throws:

InvalidArgumentException - warning is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearWarning

void clearWarning()

Removes the warning flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getContinueOnFailMetadata

Metadata getContinueOnFailMetadata()

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

Returns:

metadata for the continue-on-fail flag

Compliance:

mandatory - This method must be implemented.

setContinueOnFail

void setContinueOnFail(boolean cof)

Sets the continue-on-fail flag.

Parameters:

cof - the new continue-on-fail flag

Throws:

InvalidArgumentException - cof is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearContinueOnFail

void clearContinueOnFail()

Removes the continue-on-fail flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getInstructionFormRecord

InstructionFormRecord getInstructionFormRecord(Type instructionRecordType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets the InstructionFormRecord corresponding to the given instruction record Type.

Parameters:

instructionRecordType - an instruction record type

Returns:

the instruction form 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.