All Superinterfaces:: Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:: ValueBatchForm

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.

Method Summary

Modifier and Type

Method

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

getDisplayTextValueMetadata()

Gets the metadata for a text 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(BigDecimal value)

Sets a decimal value.

void

setDisplayTextValue(DisplayText value)

Sets a text 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(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(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.

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Modifier and Type

Method

Description

TypeList

getRecordTypes()

Gets the record types available in this object.

boolean

hasRecordType(Type recordType)

Tests if this object supports the given record Type .

Methods inherited from interface Identifiable
getId, isCurrent

Modifier and Type

Method

Description

Id

getId()

Gets the Id associated with this instance of this OSID object.

boolean

isCurrent()

Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm
getRequiredRecordTypes

Modifier and Type

Method

Description

TypeList

getRequiredRecordTypes()

Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type

Method

Description

Locale

getDefaultLocale()

Gets a default locale for the form.

Metadata[]

getInvalidMetadata()

Gets a list of metadata for the elements in this form which are not valid.

Metadata

getJournalCommentMetadata()

Gets the metadata for the comment corresponding to this form submission.

LocaleList

getLocales()

Gets the locales available for this form.

DisplayText[]

getValidationMessages()

Gets text messages corresponding to additional instructions to pass form validation.

boolean

isForUpdate()

Tests if this form is for an update operation.

boolean

isValid()

Tests if this form is in a valid state for submission.

void

setJournalComment(String comment)

Sets a comment.

void

setLocale(Type languageType, Type scriptType)

Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type

Method

Description

void

clearDescription()

Clears the description.

void

clearDisplayName()

Clears the display name.

void

clearGenusType()

Clears the genus type.

Metadata

getDescriptionMetadata()

Gets the metadata for a description.

Metadata

getDisplayNameMetadata()

Gets the metadata for a display name.

Metadata

getGenusTypeMetadata()

Gets the metadata for a genus type.

void

setDescription(String description)

Sets a description.

void

setDisplayName(String displayName)

Sets a display name.

void

setGenusType(Type genusType)

Sets a genus.

Methods inherited from interface OsidOperableForm
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type

Method

Description

void

clearDisabled()

Removes the administratively disabled flag.

void

clearEnabled()

Removes the administratively enabled flag.

Metadata

getDisabledMetadata()

Gets the metadata for the disabled flag.

Metadata

getEnabledMetadata()

Gets the metadata for the enabled flag.

void

setDisabled(boolean disabled)

Sets the administratively disabled flag.

void

setEnabled(boolean enabled)

Sets the administratively enabled flag.

Method Details
- getPriorityMetadata
  
  Metadata getPriorityMetadata()
  
  Gets the metadata for the value priority. The metadata returned may depend on the state of the shuffle behavior.
  
  Returns:
  
  metadata for the priority
  
  Compliance:
  mandatory - This method must be implemented.
- setPriority
  
  void setPriority(long priority)
  
  Sets the priority.
  
  Parameters:
  
  priority - the new priority
  
  Throws:
  
  InvalidArgumentException - priority is invalid
  
  NoAccessException - priority cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- clearPriority
  
  void clearPriority()
  
  Clears the priority.
  
  Throws:
  
  NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
  
  Compliance:
  mandatory - This method must be implemented.
- getBooleanValueMetadata
  
  Metadata getBooleanValueMetadata()
  
  Gets the metadata for a boolean value.
  
  Returns:
  
  metadata for a boolean
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != BOOLEAN
  
  Compliance:
  mandatory - This method must be implemented.
- setBooleanValue
  
  void setBooleanValue(boolean value)
  
  Sets a boolean value.
  
  Parameters:
  
  value - the new boolean value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != BOOLEAN
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getByteValueMetadata
  
  Metadata getByteValueMetadata()
  
  Gets the metadata for a byte value.
  
  Returns:
  
  metadata for a byte
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != BYTE
  
  Compliance:
  mandatory - This method must be implemented.
- setBytesValue
  
  void setBytesValue(byte[] value)
  
  Sets a byte value.
  
  Parameters:
  
  value - the new byte value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != BYTE
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getCardinalValueMetadata
  
  Metadata getCardinalValueMetadata()
  
  Gets the metadata for a cardinal value.
  
  Returns:
  
  metadata for a cardinal
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != CARDINAL
  
  Compliance:
  mandatory - This method must be implemented.
- setCardinalValue
  
  void setCardinalValue(long value)
  
  Sets a cardinal value.
  
  Parameters:
  
  value - the new cardinal value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != CARDINAL
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getCoordinateValueMetadata
  
  Metadata getCoordinateValueMetadata()
  
  Gets the metadata for a coordinate value.
  
  Returns:
  
  metadata for a coordinate
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != COORDINATE
  
  Compliance:
  mandatory - This method must be implemented.
- setCoordinateValue
  
  void setCoordinateValue(Coordinate value)
  
  Sets a coordinate value.
  
  Parameters:
  
  value - the new coordinate value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != COORDINATE
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getCurrencyValueMetadata
  
  Metadata getCurrencyValueMetadata()
  
  Gets the metadata for a currency value.
  
  Returns:
  
  metadata for a currency
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != CURRENCY
  
  Compliance:
  mandatory - This method must be implemented.
- setCurrencyValue
  
  void setCurrencyValue(Currency value)
  
  Sets a currency value.
  
  Parameters:
  
  value - the new currency value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != CURRENCY
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getDateTimeValueMetadata
  
  Metadata getDateTimeValueMetadata()
  
  Gets the metadata for a DateTime value.
  
  Returns:
  
  metadata for a datetime
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DATETIME
  
  Compliance:
  mandatory - This method must be implemented.
- setDateTimeValue
  
  void setDateTimeValue(DateTime value)
  
  Sets a DateTime value.
  
  Parameters:
  
  value - the new datetime value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DATETIME
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getDecimalValueMetadata
  
  Metadata getDecimalValueMetadata()
  
  Gets the metadata for a decimal value.
  
  Returns:
  
  metadata for a decimal
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DECIMAL
  
  Compliance:
  mandatory - This method must be implemented.
- setDecimalValue
  
  void setDecimalValue(BigDecimal value)
  
  Sets a decimal value.
  
  Parameters:
  
  value - the new decimal value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DECIMAL
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getDisplayTextValueMetadata
  
  Metadata getDisplayTextValueMetadata()
  
  Gets the metadata for a text value.
  
  Returns:
  
  metadata for a display text
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DISPLAYTEXT
  
  Compliance:
  mandatory - This method must be implemented.
- setDisplayTextValue
  
  void setDisplayTextValue(DisplayText value)
  
  Sets a text value.
  
  Parameters:
  
  value - the new display text value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DISPLAYTEXT
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getDistanceValueMetadata
  
  Metadata getDistanceValueMetadata()
  
  Gets the metadata for a Distance value.
  
  Returns:
  
  metadata for a distance
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DISTANCE
  
  Compliance:
  mandatory - This method must be implemented.
- setDistanceValue
  
  void setDistanceValue(Distance value)
  
  Sets a Distance value.
  
  Parameters:
  
  value - the new distance value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DISTANCE
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getDurationValueMetadata
  
  Metadata getDurationValueMetadata()
  
  Gets the metadata for a Duration value.
  
  Returns:
  
  metadata for a duration
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DURATION
  
  Compliance:
  mandatory - This method must be implemented.
- setDurationValue
  
  void setDurationValue(Duration value)
  
  Sets a Duration value.
  
  Parameters:
  
  value - the new duration value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != DURATION
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getIdValueMetadata
  
  Metadata getIdValueMetadata()
  
  Gets the metadata for an Id value.
  
  Returns:
  
  metadata for an Id
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != ID
  
  Compliance:
  mandatory - This method must be implemented.
- setIdValue
  
  void setIdValue(Id value)
  
  Sets an Id value.
  
  Parameters:
  
  value - the new Id value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != ID
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getIntegerValueMetadata
  
  Metadata getIntegerValueMetadata()
  
  Gets the metadata for an integer value.
  
  Returns:
  
  metadata for an integer
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != INTEGER
  
  Compliance:
  mandatory - This method must be implemented.
- setIntegerValue
  
  void setIntegerValue(long value)
  
  Sets an integer value.
  
  Parameters:
  
  value - the new integer value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != INTEGER
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getSpatialUnitValueMetadata
  
  Metadata getSpatialUnitValueMetadata()
  
  Gets the metadata for a spatial unit value.
  
  Returns:
  
  metadata for a spatial unit
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != SPATIALUNIT
  
  Compliance:
  mandatory - This method must be implemented.
- setSpatialUnitValue
  
  void setSpatialUnitValue(SpatialUnit value)
  
  Sets a spatial unit value.
  
  Parameters:
  
  value - the new spatial unit value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != SPATIALUNIT
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getSpeedValueMetadata
  
  Metadata getSpeedValueMetadata()
  
  Gets the metadata for a speed value.
  
  Returns:
  
  metadata for a speed
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != SPEED
  
  Compliance:
  mandatory - This method must be implemented.
- setSpeedValue
  
  void setSpeedValue(Speed value)
  
  Sets a speed value.
  
  Parameters:
  
  value - the new speed value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != SPEED
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  Compliance:
  mandatory - This method must be implemented.
- getStringValueMetadata
  
  Metadata getStringValueMetadata()
  
  Gets the metadata for a string value.
  
  Returns:
  
  metadata for a string
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != STRING
  
  Compliance:
  mandatory - This method must be implemented.
- setStringValue
  
  void setStringValue(String value)
  
  Sets a string value.
  
  Parameters:
  
  value - the new string value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != STRING
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getTimeValueMetadata
  
  Metadata getTimeValueMetadata()
  
  Gets the metadata for a Time value.
  
  Returns:
  
  metadata for a Time
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != TIME
  
  Compliance:
  mandatory - This method must be implemented.
- setTimeValue
  
  void setTimeValue(Time value)
  
  Sets a Time value.
  
  Parameters:
  
  value - the new Time value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != TIME
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getTypeValueMetadata
  
  Metadata getTypeValueMetadata()
  
  Gets the metadata for a Type value.
  
  Returns:
  
  metadata for a Type
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != TYPE
  
  Compliance:
  mandatory - This method must be implemented.
- setTypeValue
  
  void setTypeValue(Type value)
  
  Sets a Type value.
  
  Parameters:
  
  value - the new Type value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != TYPE
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getVersionValueMetadata
  
  Metadata getVersionValueMetadata()
  
  Gets the metadata for a Version value.
  
  Returns:
  
  metadata for a Version
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != VERSION
  
  Compliance:
  mandatory - This method must be implemented.
- setVersionValue
  
  void setVersionValue(Version value)
  
  Sets a Version value.
  
  Parameters:
  
  value - the new Version value
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != VERSION
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value is null
  
  Compliance:
  mandatory - This method must be implemented.
- getObjectValueMetadata
  
  Metadata getObjectValueMetadata()
  
  Gets the metadata for an object value.
  
  Returns:
  
  metadata for an object
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != OBJECT
  
  Compliance:
  mandatory - This method must be implemented.
- setObjectValue
  
  void setObjectValue(Object value, Type objectType)
  
  Sets an object value.
  
  Parameters:
  
  value - the new object value
  
  objectType - the object type
  
  Throws:
  
  IllegalStateException - Parameter.getSyntax() != OBJECT
  
  InvalidArgumentException - value is invalid
  
  NoAccessException - value cannot be modified
  
  NullArgumentException - value or objectType is null
  
  UnsupportedException - Metadata.supportsObjectType(objectType) is false
  
  Compliance:
  mandatory - This method must be implemented.
- clearValue
  
  void clearValue()
  
  Clears the value.
  
  Throws:
  
  NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
  
  Compliance:
  mandatory - This method must be implemented.
- getValueFormRecord
  
  ValueFormRecord getValueFormRecord(Type valueRecordType) throws OperationFailedException
  
  Gets the ValueFormRecord corresponding to the given value record Type .
  
  Parameters:
  
  valueRecordType - a value record type
  
  Returns:
  
  the value form record
  
  Throws:
  
  NullArgumentException - valueRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(valueRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.

Interface ValueForm

Method Summary

Methods inherited from interface Extensible

Methods inherited from interface Identifiable

Methods inherited from interface OsidExtensibleForm

Methods inherited from interface OsidForm

Methods inherited from interface OsidObjectForm

Methods inherited from interface OsidOperableForm

Method Details

getPriorityMetadata

setPriority

clearPriority

getBooleanValueMetadata

setBooleanValue

getByteValueMetadata

setBytesValue

getCardinalValueMetadata

setCardinalValue

getCoordinateValueMetadata

setCoordinateValue

getCurrencyValueMetadata

setCurrencyValue

getDateTimeValueMetadata

setDateTimeValue

getDecimalValueMetadata

setDecimalValue

getDisplayTextValueMetadata

setDisplayTextValue

getDistanceValueMetadata

setDistanceValue

getDurationValueMetadata

setDurationValue

getIdValueMetadata

setIdValue

getIntegerValueMetadata

setIntegerValue

getSpatialUnitValueMetadata

setSpatialUnitValue

getSpeedValueMetadata

setSpeedValue

getStringValueMetadata

setStringValue

getTimeValueMetadata

setTimeValue

getTypeValueMetadata

setTypeValue

getVersionValueMetadata

setVersionValue

getObjectValueMetadata

setObjectValue

clearValue

getValueFormRecord