Interface RuleForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

public interface RuleForm
extends OsidForm

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

Method Summary

Modifier and Type	Method	Description
RuleFormRecord	getRuleFormRecord(Type ruleRecordType)	Gets the RuleFormRecord corresponding to the given rule record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Method Details

getRuleFormRecord

RuleFormRecord getRuleFormRecord(Type ruleRecordType)
                          throws OperationFailedException

Gets the RuleFormRecord corresponding to the given rule record Type.

Parameters:

ruleRecordType - the rule record type

Returns:

the record

Throws:

NullArgumentException - ruleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ruleRecordType) is false

Compliance:

mandatory - This method must be implemented.