org.osid.configuration

Interface Value

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, Subjugateable

public interface Value
extends OsidObject, Operable, Subjugateable

This interface specifies the value of a configuration parameter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBooleanValue() Gets the value if it is a boolean.
byte[]	getBytesValue() Gets the value if it is a byte.
long	getCardinalValue() Gets the value if it is a cardinal.
Coordinate	getCoordinateValue() Gets the value if it is a coordinate.
Currency	getCurrencyValue() Gets the value if it is a currency.
DateTime	getDateTimeValue() Gets the value if it is a DateTime.
java.math.BigDecimal	getDecimalValue() Gets the value if it is a decimal.
Distance	getDistanceValue() Gets the value if it is a Distance.
Duration	getDurationValue() Gets the value if it is a Duration.
Heading	getHeadingValue() Gets the value if it is a Heading.
Id	getIdValue() Gets the value if it is an Id.
long	getIntegerValue() Gets the value if it is an integer.
java.lang.Object	getObjectValue() Gets the value if it is an object.
Parameter	getParameter() Gets the parameter of this value.
Id	getParameterId() Gets the parameter Id of this value.
long	getPriority() Gets the priority of this value.
SpatialUnit	getSpatialUnitValue() Gets the value if it is a spatial unit.
Speed	getSpeedValue() Gets the value if it is a speed.
java.lang.String	getStringValue() Gets the value if it is a string.
Time	getTimeValue() Gets the value if it is a time.
Type	getTypeValue() Gets the value if it is a Type.
ValueRecord	getValueRecord(Type valueRecordType) Gets the value record corresponding to the given Value record Type.
Version	getVersionValue() Gets the value if it is a version.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getParameterId

Id getParameterId()

Gets the parameter Id of this value.

Returns:

the parameter Id

Compliance:

mandatory - This method must be implemented.

getParameter

Parameter getParameter()
                       throws OperationFailedException

Gets the parameter of this value.

Returns:

the parameter

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPriority

long getPriority()

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.

Returns:

the index of this value

Compliance:

mandatory - This method must be implemented.

getBooleanValue

boolean getBooleanValue()

Gets the value if it is a boolean.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != BOOLEAN

Compliance:

mandatory - This method must be implemented.

getBytesValue

byte[] getBytesValue()

Gets the value if it is a byte.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != BYTE

Compliance:

mandatory - This method must be implemented.

getCardinalValue

long getCardinalValue()

Gets the value if it is a cardinal.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != CARDINAL

Compliance:

mandatory - This method must be implemented.

getCoordinateValue

Coordinate getCoordinateValue()

Gets the value if it is a coordinate.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != COORDINATE

Compliance:

mandatory - This method must be implemented.

getCurrencyValue

Currency getCurrencyValue()

Gets the value if it is a currency.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != CURRENCY

Compliance:

mandatory - This method must be implemented.

getDateTimeValue

DateTime getDateTimeValue()

Gets the value if it is a DateTime.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != DATETIME

Compliance:

mandatory - This method must be implemented.

getDecimalValue

java.math.BigDecimal getDecimalValue()

Gets the value if it is a decimal.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != DECIMAL

Compliance:

mandatory - This method must be implemented.

getDistanceValue

Distance getDistanceValue()

Gets the value if it is a Distance.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != DISTANCE

Compliance:

mandatory - This method must be implemented.

getDurationValue

Duration getDurationValue()

Gets the value if it is a Duration.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != DURATION

Compliance:

mandatory - This method must be implemented.

getHeadingValue

Heading getHeadingValue()

Gets the value if it is a Heading.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != HEADING

Compliance:

mandatory - This method must be implemented.

getIdValue

Id getIdValue()

Gets the value if it is an Id.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != ID

Compliance:

mandatory - This method must be implemented.

getIntegerValue

long getIntegerValue()

Gets the value if it is an integer.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != INTEGER

Compliance:

mandatory - This method must be implemented.

getObjectValue

java.lang.Object getObjectValue()

Gets the value if it is an object.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != OBJECT

Compliance:

mandatory - This method must be implemented.

getSpatialUnitValue

SpatialUnit getSpatialUnitValue()

Gets the value if it is a spatial unit.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != SPATIALUNIT

Compliance:

mandatory - This method must be implemented.

getSpeedValue

Speed getSpeedValue()

Gets the value if it is a speed.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != SPEED

Compliance:

mandatory - This method must be implemented.

getStringValue

java.lang.String getStringValue()

Gets the value if it is a string.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != STRING

Compliance:

mandatory - This method must be implemented.

getTimeValue

Time getTimeValue()

Gets the value if it is a time.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != TIME

Compliance:

mandatory - This method must be implemented.

getTypeValue

Type getTypeValue()

Gets the value if it is a Type.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != TYPE

Compliance:

mandatory - This method must be implemented.

getVersionValue

Version getVersionValue()

Gets the value if it is a version.

Returns:

the value

Throws:

IllegalStateException - Parameter.getSyntax() != VERSION

Compliance:

mandatory - This method must be implemented.

getValueRecord

ValueRecord getValueRecord(Type valueRecordType)
                           throws OperationFailedException

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 .

Parameters:

valueRecordType - the type of value record to retrieve

Returns:

the value record

Throws:

NullArgumentException - valueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueRecordType) is false

Compliance:

mandatory - This method must be implemented.