OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.Parameter
Implementsosid.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.

MethodgetValueSyntax
Description

Gets the syntax for the values of this parameter.

Returnosid.Syntaxthe syntax of the values
CompliancemandatoryThis method must be implemented.
MethodgetValueCoordinateType
Description

Gets the type of the value if the syntax is a coordinate.

Returnosid.type.Typethe type of the values
ErrorsILLEGAL_STATE getValueSyntax() != COORDINATE
CompliancemandatoryThis method must be implemented.
MethodimplementsValueCoordinateType
Description

Tests if the coordinate supports the given coordinate Type.

Parametersosid.type.TypecoordinateTypea coordinate type
Returnboolean true if the coordinate values associated with this parameter implement the given coordinate Type, false otherwise
ErrorsILLEGAL_STATE getValueSyntax() != COORDINATE
NULL_ARGUMENT coordinateType is null
CompliancemandatoryThis method must be implemented.
MethodgetValueHeadingType
Description

Gets the type of the value if the syntax is a heading.

Returnosid.type.Typethe type of the values
ErrorsILLEGAL_STATE getValueSyntax() != HEADING
CompliancemandatoryThis method must be implemented.
MethodimplementsValueHeadingType
Description

Tests if the heading supports the given heading Type.

Parametersosid.type.TypeheadingTypea heading type
Returnboolean true if the heading values associated with this parameter implement the given heading Type, false otherwise
ErrorsILLEGAL_STATE getValueSyntax() != HEADING
NULL_ARGUMENT headingType is null
CompliancemandatoryThis method must be implemented.
MethodgetValueObjectType
Description

Gets the type of the value if the syntax is an object.

Returnosid.type.Typethe type of the values
ErrorsILLEGAL_STATE getValueSyntax() != OBJECT
CompliancemandatoryThis method must be implemented.
MethodimplementsValueObjectType
Description

Tests if the object supports the given Type. This method should be checked before retrieving the object value.

Parametersosid.type.TypevalueTypea type
Returnboolean true if the obect values associated with this parameter implement the given Type, false otherwise
ErrorsILLEGAL_STATE getValueSyntax() != OBJECT
NULL_ARGUMENT valueType is null
CompliancemandatoryThis method must be implemented.
MethodgetValueSpatialUnitRecordType
Description

Gets the type of the value if the syntax is a spatial unit.

Returnosid.type.Typethe type of the values
ErrorsILLEGAL_STATE getValueSyntax() != SPATIALUNIT
CompliancemandatoryThis method must be implemented.
MethodimplementsValueSpatialUnitRecordType
Description

Tests if the spatial unit supports the given record Type.

Parametersosid.type.TypespatialUnitRecordTypea spatial unit record type
Returnboolean true if the spatial unit values associated with this parameter implement the given record Type, false otherwise
ErrorsILLEGAL_STATE getValueSyntax() != SPATIALUNIT
NULL_ARGUMENT spatialUnitRecordTYpe is null
CompliancemandatoryThis method must be implemented.
MethodgetValueVersionScheme
Description

Gets the type of the value if the syntax is a version.

Returnosid.type.Typethe type of the values
ErrorsILLEGAL_STATE getValueSyntax() != VERSION
CompliancemandatoryThis method must be implemented.
MethodimplementsValueVersionScheme
Description

Tests if the version supports the given version Type.

Parametersosid.type.TypeversionTypea version type
Returnboolean true if the version values associated with this parameter implement the given version Type, false otherwise
ErrorsILLEGAL_STATE getValueSyntax() != VERSION
NULL_ARGUMENT versionType is null
CompliancemandatoryThis method must be implemented.
MethodareValuesShuffled
Description

Tests if if the values assigned to this parameter will be shuffled or values are sorted by index.

Returnboolean true if the values are shuffled, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParameterRecord
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 .

Parametersosid.type.TypeparameterRecordTypethe type of parameter record to retrieve
Returnosid.configuration.records.ParameterRecordthe parameter record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterRecordType) is false
CompliancemandatoryThis method must be implemented.