public interface ValueForm extends OsidObjectForm, OsidOperableForm, OsidSubjugateableForm
This is the form for creating and updating Values.
Various data elements may be set here for use in the create and update
methods in the ValueAdminSession
For each data element that
may be set, metadata may be examined to provide display hints or data
constraints.
Modifier and Type | Method and Description |
---|---|
void |
clearPriority()
Clears the priority.
|
void |
clearValue()
Clears the value.
|
Metadata |
getBooleanValueMetadata()
Gets the metadata for a boolean value.
|
Metadata |
getByteValueMetadata()
Gets the metadata for a byte value.
|
Metadata |
getCardinalValueMetadata()
Gets the metadata for a cardinal value.
|
Metadata |
getCoordinateValueMetadata()
Gets the metadata for a coordinate value.
|
Metadata |
getCurrencyValueMetadata()
Gets the metadata for a currency value.
|
Metadata |
getDateTimeValueMetadata()
Gets the metadata for a
DateTime value. |
Metadata |
getDecimalValueMetadata()
Gets the metadata for a decimal value.
|
Metadata |
getDistanceValueMetadata()
Gets the metadata for a
Distance value. |
Metadata |
getDurationValueMetadata()
Gets the metadata for a
Duration value. |
Metadata |
getIdValueMetadata()
Gets the metadata for an
Id value. |
Metadata |
getIntegerValueMetadata()
Gets the metadata for an integer value.
|
Metadata |
getObjectValueMetadata()
Gets the metadata for an object value.
|
Metadata |
getPriorityMetadata()
Gets the metadata for the value priority.
|
Metadata |
getSpatialUnitValueMetadata()
Gets the metadata for a spatial unit value.
|
Metadata |
getSpeedValueMetadata()
Gets the metadata for a speed value.
|
Metadata |
getStringValueMetadata()
Gets the metadata for a string value.
|
Metadata |
getTimeValueMetadata()
Gets the metadata for a
Time value. |
Metadata |
getTypeValueMetadata()
Gets the metadata for a
Type value. |
ValueFormRecord |
getValueFormRecord(Type valueRecordType)
Gets the
ValueFormRecord corresponding to the given
value record Type. |
Metadata |
getVersionValueMetadata()
Gets the metadata for a
Version value. |
void |
setBooleanValue(boolean value)
Sets a boolean value.
|
void |
setBytesValue(byte[] value)
Sets a byte value.
|
void |
setCardinalValue(long value)
Sets a cardinal value.
|
void |
setCoordinateValue(Coordinate value)
Sets a coordinate value.
|
void |
setCurrencyValue(Currency value)
Sets a currency value.
|
void |
setDateTimeValue(DateTime value)
Sets a
DateTime value. |
void |
setDecimalValue(java.math.BigDecimal value)
Sets a decimal value.
|
void |
setDistanceValue(Distance value)
Sets a
Distance value. |
void |
setDurationValue(Duration value)
Sets a
Duration value. |
void |
setIdValue(Id value)
Sets an
Id value. |
void |
setIntegerValue(long value)
Sets an integer value.
|
void |
setObjectValue(java.lang.Object value,
Type objectType)
Sets an object value.
|
void |
setPriority(long priority)
Sets the priority.
|
void |
setSpatialUnitValue(SpatialUnit value)
Sets a spatial unit value.
|
void |
setSpeedValue(Speed value)
Sets a speed value.
|
void |
setStringValue(java.lang.String value)
Sets a string value.
|
void |
setTimeValue(Time value)
Sets a
Time value. |
void |
setTypeValue(Type value)
Sets a
Type value. |
void |
setVersionValue(Version value)
Sets a
Version value. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getPriorityMetadata()
mandatory
- This method must be implemented. void setPriority(long priority)
priority
- the new priorityInvalidArgumentException
- priority
is
invalidNoAccessException
- priority
cannot be
modifiedmandatory
- This method must be implemented. void clearPriority()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getBooleanValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
BOOLEAN
mandatory
- This method must be implemented. void setBooleanValue(boolean value)
value
- the new boolean valueIllegalStateException
- Parameter.getSyntax() !=
BOOLEAN
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getByteValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
BYTE
mandatory
- This method must be implemented. void setBytesValue(byte[] value)
value
- the new byte valueIllegalStateException
- Parameter.getSyntax() !=
BYTE
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getCardinalValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
CARDINAL
mandatory
- This method must be implemented. void setCardinalValue(long value)
value
- the new cardinal valueIllegalStateException
- Parameter.getSyntax() !=
CARDINAL
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getCoordinateValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
COORDINATE
mandatory
- This method must be implemented. void setCoordinateValue(Coordinate value)
value
- the new coordinate valueIllegalStateException
- Parameter.getSyntax() !=
COORDINATE
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getCurrencyValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
CURRENCY
mandatory
- This method must be implemented. void setCurrencyValue(Currency value)
value
- the new currency valueIllegalStateException
- Parameter.getSyntax() !=
CURRENCY
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getDateTimeValueMetadata()
DateTime
value.IllegalStateException
- Parameter.getSyntax() !=
DATETIME
mandatory
- This method must be implemented. void setDateTimeValue(DateTime value)
DateTime
value.value
- the new datetime valueIllegalStateException
- Parameter.getSyntax() !=
DATETIME
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getDecimalValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
DECIMAL
mandatory
- This method must be implemented. void setDecimalValue(java.math.BigDecimal value)
value
- the new decimal valueIllegalStateException
- Parameter.getSyntax() !=
DECIMAL
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getDistanceValueMetadata()
Distance
value.IllegalStateException
- Parameter.getSyntax() !=
DISTANCE
mandatory
- This method must be implemented. void setDistanceValue(Distance value)
Distance
value.value
- the new distance valueIllegalStateException
- Parameter.getSyntax() !=
DISTANCE
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getDurationValueMetadata()
Duration
value.IllegalStateException
- Parameter.getSyntax() !=
DURATION
mandatory
- This method must be implemented. void setDurationValue(Duration value)
Duration
value.value
- the new duration valueIllegalStateException
- Parameter.getSyntax() !=
DURATION
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getIdValueMetadata()
Id
value. Id
IllegalStateException
- Parameter.getSyntax() !=
ID
mandatory
- This method must be implemented. void setIdValue(Id value)
Id
value.value
- the new Id
valueIllegalStateException
- Parameter.getSyntax() !=
ID
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getIntegerValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
INTEGER
mandatory
- This method must be implemented. void setIntegerValue(long value)
value
- the new integer valueIllegalStateException
- Parameter.getSyntax() !=
INTEGER
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getSpatialUnitValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
SPATIALUNIT
mandatory
- This method must be implemented. void setSpatialUnitValue(SpatialUnit value)
value
- the new spatial unit valueIllegalStateException
- Parameter.getSyntax() !=
SPATIALUNIT
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getSpeedValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
SPEED
mandatory
- This method must be implemented. void setSpeedValue(Speed value)
value
- the new speed valueIllegalStateException
- Parameter.getSyntax() !=
SPEED
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedmandatory
- This method must be implemented. Metadata getStringValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
STRING
mandatory
- This method must be implemented. void setStringValue(java.lang.String value)
value
- the new string valueIllegalStateException
- Parameter.getSyntax() !=
STRING
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getTimeValueMetadata()
Time
value. Time
IllegalStateException
- Parameter.getSyntax() !=
TIME
mandatory
- This method must be implemented. void setTimeValue(Time value)
Time
value.value
- the new Time
valueIllegalStateException
- Parameter.getSyntax() !=
TIME
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getTypeValueMetadata()
Type
value. Type
IllegalStateException
- Parameter.getSyntax() !=
TYPE
mandatory
- This method must be implemented. void setTypeValue(Type value)
Type
value.value
- the new Type
valueIllegalStateException
- Parameter.getSyntax() !=
TYPE
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getVersionValueMetadata()
Version
value. Version
IllegalStateException
- Parameter.getSyntax() !=
VERSION
mandatory
- This method must be implemented. void setVersionValue(Version value)
Version
value.value
- the new Version
valueIllegalStateException
- Parameter.getSyntax() !=
VERSION
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
is
null
mandatory
- This method must be implemented. Metadata getObjectValueMetadata()
IllegalStateException
- Parameter.getSyntax() !=
OBJECT
mandatory
- This method must be implemented. void setObjectValue(java.lang.Object value, Type objectType)
value
- the new object valueobjectType
- the object typeIllegalStateException
- Parameter.getSyntax() !=
OBJECT
InvalidArgumentException
- value
is
invalidNoAccessException
- value
cannot be
modifiedNullArgumentException
- value
or
objectType
is null
UnsupportedException
-
Metadata.supportsObjectType(objectType)
is
false
mandatory
- This method must be implemented. void clearValue()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ValueFormRecord getValueFormRecord(Type valueRecordType) throws OperationFailedException
ValueFormRecord
corresponding to the given
value record Type.
valueRecordType
- a value record typeNullArgumentException
- valueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueRecordType)
is false
mandatory
- This method must be implemented.