OSID - osid.lexicon.Parameter Service Interface Definition

Interface	osid.lexicon.Parameter
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.lexicon.ParameterAdminSession`
	`osid.lexicon.ParameterList`
	`osid.lexicon.ParameterLookupSession`
Description	A `Parameter` specifies a variable substitution in the string of a `Text` to produce an `Idiom` .
Method	getTextId
Description	Gets the text `Id` .
Return	`osid.id.Id`		the text `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getText
Description	Gets the text.
Return	`osid.lexicon.Text`		the text
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSyntax
Description	Gets the syntax of the parameter.
Return	`osid.Syntax`		the syntax
Compliance	`mandatory`		This method must be implemented.
Method	getInputPosition
Description	Gets the input position for this parameter as supplied to the text.
Return	`cardinal`		the position
Compliance	`mandatory`		This method must be implemented.
Method	getParameterRecord
Description	Gets the parameter record corresponding to the given `Parameter` record `Type` . This method is used to retrieve an object implementing the requested record. The `parameterRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(parameterRecordType)` is `true` .
Parameters	`osid.type.Type`	`parameterRecordType`	the type of parameter record to retrieve
Return	`osid.lexicon.records.ParameterRecord`		the parameter 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.