OSID - osid.lexicon.ParameterForm Service Interface Definition

Interface	osid.lexicon.ParameterForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.lexicon.batch.ParameterBatchForm`
Used By	`osid.lexicon.ParameterAdminSession`
Description	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	getSyntaxMetadata
Description	Gets the metadata for the syntax.
Return	`osid.Metadata`		metadata for the syntax
Compliance	`mandatory`		This method must be implemented.
Method	setSyntax
Description	Sets the syntax.
Parameters	`osid.Syntax`	`syntax`	the new syntax
Errors	INVALID_ARGUMENT		`syntax` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`syntax` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSyntax
Description	Clears the value syntax.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly() is true`
Compliance	`mandatory`		This method must be implemented.
Method	getInputPositionMetadata
Description	Gets the metadata for the input position.
Return	`osid.Metadata`		metadata for the input position
Compliance	`mandatory`		This method must be implemented.
Method	setInputPosition
Description	Sets the input position.
Parameters	`cardinal`	`position`	the new input position
Errors	INVALID_ARGUMENT		`position` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearInputPosition
Description	Clears the input position.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly() is true`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterFormRecord
Description	Gets the `ParameterFormRecord` corresponding to the given parameter record `Type` .
Parameters	`osid.type.Type`	`parameterRecordType`	a parameter record type
Return	`osid.lexicon.records.ParameterFormRecord`		the parameter form record
Errors	NULL_ARGUMENT		`parameterRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(parameterRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.