Interface ParameterForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ParameterBatchForm

public interface ParameterForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Parameters. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ParameterAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the parameter segments.

Method Summary

Modifier and Type	Method	Description
void	clearInputPosition()	Clears the input position.
void	clearSyntax()	Clears the value syntax.
Metadata	getInputPositionMetadata()	Gets the metadata for the input position.
ParameterFormRecord	getParameterFormRecord(Type parameterRecordType)	Gets the ParameterFormRecord corresponding to the given parameter record Type.
Metadata	getSyntaxMetadata()	Gets the metadata for the syntax.
void	setInputPosition(long position)	Sets the input position.
void	setSyntax(Syntax syntax)	Sets the syntax.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given 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 OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

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.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

getSyntaxMetadata

Metadata getSyntaxMetadata()

Gets the metadata for the syntax.

Returns:

metadata for the syntax

Compliance:

mandatory - This method must be implemented.

setSyntax

void setSyntax(Syntax syntax)

Sets the syntax.

Parameters:

syntax - the new syntax

Throws:

InvalidArgumentException - syntax is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - syntax is null

Compliance:

mandatory - This method must be implemented.

clearSyntax

void clearSyntax()

Clears the value syntax.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInputPositionMetadata

Metadata getInputPositionMetadata()

Gets the metadata for the input position.

Returns:

metadata for the input position

Compliance:

mandatory - This method must be implemented.

setInputPosition

void setInputPosition(long position)

Sets the input position.

Parameters:

position - the new input position

Throws:

InvalidArgumentException - position is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearInputPosition

void clearInputPosition()

Clears the input position.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getParameterFormRecord

ParameterFormRecord getParameterFormRecord(Type parameterRecordType)
                                    throws OperationFailedException

Gets the ParameterFormRecord corresponding to the given parameter record Type.

Parameters:

parameterRecordType - a parameter record type

Returns:

the parameter form record

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterRecordType) is false

Compliance:

mandatory - This method must be implemented.