public interface Value extends OsidObject, Operable, Subjugateable
This interface specifies the value of a configuration parameter.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getParameterId()
Id
of this value. Id
mandatory
- This method must be implemented. Parameter getParameter() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. long getPriority()
mandatory
- This method must be implemented. boolean getBooleanValue()
IllegalStateException
- Parameter.getSyntax() !=
BOOLEAN
mandatory
- This method must be implemented. byte[] getBytesValue()
IllegalStateException
- Parameter.getSyntax() !=
BYTE
mandatory
- This method must be implemented. long getCardinalValue()
IllegalStateException
- Parameter.getSyntax() !=
CARDINAL
mandatory
- This method must be implemented. Coordinate getCoordinateValue()
IllegalStateException
- Parameter.getSyntax() !=
COORDINATE
mandatory
- This method must be implemented. Currency getCurrencyValue()
IllegalStateException
- Parameter.getSyntax() !=
CURRENCY
mandatory
- This method must be implemented. DateTime getDateTimeValue()
DateTime.
IllegalStateException
- Parameter.getSyntax() !=
DATETIME
mandatory
- This method must be implemented. java.math.BigDecimal getDecimalValue()
IllegalStateException
- Parameter.getSyntax() !=
DECIMAL
mandatory
- This method must be implemented. Distance getDistanceValue()
Distance.
IllegalStateException
- Parameter.getSyntax() !=
DISTANCE
mandatory
- This method must be implemented. Duration getDurationValue()
Duration.
IllegalStateException
- Parameter.getSyntax() !=
DURATION
mandatory
- This method must be implemented. Heading getHeadingValue()
Heading.
IllegalStateException
- Parameter.getSyntax() !=
HEADING
mandatory
- This method must be implemented. Id getIdValue()
Id.
IllegalStateException
- Parameter.getSyntax() !=
ID
mandatory
- This method must be implemented. long getIntegerValue()
IllegalStateException
- Parameter.getSyntax() !=
INTEGER
mandatory
- This method must be implemented. java.lang.Object getObjectValue()
IllegalStateException
- Parameter.getSyntax() !=
OBJECT
mandatory
- This method must be implemented. SpatialUnit getSpatialUnitValue()
IllegalStateException
- Parameter.getSyntax() !=
SPATIALUNIT
mandatory
- This method must be implemented. Speed getSpeedValue()
IllegalStateException
- Parameter.getSyntax() !=
SPEED
mandatory
- This method must be implemented. java.lang.String getStringValue()
IllegalStateException
- Parameter.getSyntax() !=
STRING
mandatory
- This method must be implemented. Time getTimeValue()
IllegalStateException
- Parameter.getSyntax() !=
TIME
mandatory
- This method must be implemented. Type getTypeValue()
Type.
IllegalStateException
- Parameter.getSyntax() !=
TYPE
mandatory
- This method must be implemented. Version getVersionValue()
IllegalStateException
- Parameter.getSyntax() !=
VERSION
mandatory
- This method must be implemented. ValueRecord getValueRecord(Type valueRecordType) throws OperationFailedException
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
.valueRecordType
- the type of value record to retrieveNullArgumentException
- valueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueRecordType)
is false
mandatory
- This method must be implemented.