OSID - osid.configuration.Parameter Service Interface Definition

Interface	osid.configuration.Parameter
Implements	`osid.OsidRule`
Description	A parameter is used to map configuration values to an identifier and syntax. The type of the value must be used across all values of the same parameter. The values associated with a parameter should be queried through the `ValueLookupSession.`
Method	getValueSyntax
Description	Gets the syntax for the values of this parameter.
Return	`osid.Syntax`		the syntax of the values
Compliance	`mandatory`		This method must be implemented.
Method	getValueCoordinateType
Description	Gets the type of the value if the syntax is a coordinate.
Return	`osid.type.Type`		the type of the values
Errors	ILLEGAL_STATE		`getValueSyntax() != COORDINATE`
Compliance	`mandatory`		This method must be implemented.
Method	implementsValueCoordinateType
Description	Tests if the coordinate supports the given coordinate `Type.`
Parameters	`osid.type.Type`	`coordinateType`	a coordinate type
Return	`boolean`		`true` if the coordinate values associated with this parameter implement the given coordinate `Type,` `false` otherwise
Errors	ILLEGAL_STATE		`getValueSyntax() != COORDINATE`
Errors	NULL_ARGUMENT		`coordinateType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueHeadingType
Description	Gets the type of the value if the syntax is a heading.
Return	`osid.type.Type`		the type of the values
Errors	ILLEGAL_STATE		`getValueSyntax() != HEADING`
Compliance	`mandatory`		This method must be implemented.
Method	implementsValueHeadingType
Description	Tests if the heading supports the given heading `Type.`
Parameters	`osid.type.Type`	`headingType`	a heading type
Return	`boolean`		`true` if the heading values associated with this parameter implement the given heading `Type,` `false` otherwise
Errors	ILLEGAL_STATE		`getValueSyntax() != HEADING`
Errors	NULL_ARGUMENT		`headingType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueObjectType
Description	Gets the type of the value if the syntax is an object.
Return	`osid.type.Type`		the type of the values
Errors	ILLEGAL_STATE		`getValueSyntax() != OBJECT`
Compliance	`mandatory`		This method must be implemented.
Method	implementsValueObjectType
Description	Tests if the object supports the given `Type.` This method should be checked before retrieving the object value.
Parameters	`osid.type.Type`	`valueType`	a type
Return	`boolean`		`true` if the obect values associated with this parameter implement the given `Type,` `false` otherwise
Errors	ILLEGAL_STATE		`getValueSyntax() != OBJECT`
Errors	NULL_ARGUMENT		`valueType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueSpatialUnitRecordType
Description	Gets the type of the value if the syntax is a spatial unit.
Return	`osid.type.Type`		the type of the values
Errors	ILLEGAL_STATE		`getValueSyntax() != SPATIALUNIT`
Compliance	`mandatory`		This method must be implemented.
Method	implementsValueSpatialUnitRecordType
Description	Tests if the spatial unit supports the given record `Type.`
Parameters	`osid.type.Type`	`spatialUnitRecordType`	a spatial unit record type
Return	`boolean`		`true` if the spatial unit values associated with this parameter implement the given record `Type,` `false` otherwise
Errors	ILLEGAL_STATE		`getValueSyntax() != SPATIALUNIT`
Errors	NULL_ARGUMENT		`spatialUnitRecordTYpe` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueVersionScheme
Description	Gets the type of the value if the syntax is a version.
Return	`osid.type.Type`		the type of the values
Errors	ILLEGAL_STATE		`getValueSyntax() != VERSION`
Compliance	`mandatory`		This method must be implemented.
Method	implementsValueVersionScheme
Description	Tests if the version supports the given version `Type.`
Parameters	`osid.type.Type`	`versionType`	a version type
Return	`boolean`		`true` if the version values associated with this parameter implement the given version `Type,` `false` otherwise
Errors	ILLEGAL_STATE		`getValueSyntax() != VERSION`
Errors	NULL_ARGUMENT		`versionType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	areValuesShuffled
Description	Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.
Return	`boolean`		`true` if the values are shuffled, `false` otherwise
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.configuration.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.