OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.Value
Implementsosid.OsidObject
osid.Operable
osid.Subjugateable
Description

This interface specifies the value of a configuration parameter.

MethodgetParameterId
Description

Gets the parameter Id of this value.

Returnosid.id.Idthe parameter Id
CompliancemandatoryThis method must be implemented.
MethodgetParameter
Description

Gets the parameter of this value.

Returnosid.configuration.Parameterthe parameter
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPriority
Description

Gets the priority of this value. If the values for this parameter are not shuffled, the priority indicates a static ordering of the values from lowest to highest. If the values for this parameter are shuffled, the priority effects the weight with greater numbers having greater weights.

Returncardinalthe index of this value
CompliancemandatoryThis method must be implemented.
MethodgetBooleanValue
Description

Gets the value if it is a boolean.

Returnbooleanthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != BOOLEAN
CompliancemandatoryThis method must be implemented.
MethodgetBytesValue
Description

Gets the value if it is a byte.

Returnbyte[]the value
ErrorsILLEGAL_STATE Parameter.getSyntax() != BYTE
CompliancemandatoryThis method must be implemented.
MethodgetCardinalValue
Description

Gets the value if it is a cardinal.

Returncardinalthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != CARDINAL
CompliancemandatoryThis method must be implemented.
MethodgetCoordinateValue
Description

Gets the value if it is a coordinate.

Returnosid.mapping.Coordinatethe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != COORDINATE
CompliancemandatoryThis method must be implemented.
MethodgetCurrencyValue
Description

Gets the value if it is a currency.

Returnosid.financials.Currencythe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != CURRENCY
CompliancemandatoryThis method must be implemented.
MethodgetDateTimeValue
Description

Gets the value if it is a DateTime.

Returnosid.calendaring.DateTimethe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != DATETIME
CompliancemandatoryThis method must be implemented.
MethodgetDecimalValue
Description

Gets the value if it is a decimal.

Returndecimalthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != DECIMAL
CompliancemandatoryThis method must be implemented.
MethodgetDistanceValue
Description

Gets the value if it is a Distance.

Returnosid.mapping.Distancethe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != DISTANCE
CompliancemandatoryThis method must be implemented.
MethodgetDurationValue
Description

Gets the value if it is a Duration.

Returnosid.calendaring.Durationthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != DURATION
CompliancemandatoryThis method must be implemented.
MethodgetHeadingValue
Description

Gets the value if it is a Heading.

Returnosid.mapping.Headingthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != HEADING
CompliancemandatoryThis method must be implemented.
MethodgetIdValue
Description

Gets the value if it is an Id.

Returnosid.id.Idthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != ID
CompliancemandatoryThis method must be implemented.
MethodgetIntegerValue
Description

Gets the value if it is an integer.

Returnintegerthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != INTEGER
CompliancemandatoryThis method must be implemented.
MethodgetObjectValue
Description

Gets the value if it is an object.

Returnobjectthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != OBJECT
CompliancemandatoryThis method must be implemented.
MethodgetSpatialUnitValue
Description

Gets the value if it is a spatial unit.

Returnosid.mapping.SpatialUnitthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != SPATIALUNIT
CompliancemandatoryThis method must be implemented.
MethodgetSpeedValue
Description

Gets the value if it is a speed.

Returnosid.mapping.Speedthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != SPEED
CompliancemandatoryThis method must be implemented.
MethodgetStringValue
Description

Gets the value if it is a string.

Returnstringthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != STRING
CompliancemandatoryThis method must be implemented.
MethodgetTimeValue
Description

Gets the value if it is a time.

Returnosid.calendaring.Timethe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != TIME
CompliancemandatoryThis method must be implemented.
MethodgetTypeValue
Description

Gets the value if it is a Type.

Returnosid.type.Typethe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != TYPE
CompliancemandatoryThis method must be implemented.
MethodgetVersionValue
Description

Gets the value if it is a version.

Returnosid.installation.Versionthe value
ErrorsILLEGAL_STATE Parameter.getSyntax() != VERSION
CompliancemandatoryThis method must be implemented.
MethodgetValueRecord
Description

Gets the value record corresponding to the given Value record Type. This method is used to retrieve an object implementing the requested record. The valueRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(valueRecordType) is true .

Parametersosid.type.TypevalueRecordTypethe type of value record to retrieve
Returnosid.configuration.records.ValueRecordthe value record
ErrorsNULL_ARGUMENT valueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueRecordType) is false
CompliancemandatoryThis method must be implemented.