OSID - osid.configuration.ValueForm Service Interface Definition

Interface	osid.configuration.ValueForm
Implements	`osid.OsidObjectForm`
	`osid.OsidOperableForm`
	`osid.OsidSubjugateableForm`
Implemented By	`osid.configuration.batch.ValueBatchForm`
Used By	`osid.configuration.ValueAdminSession`
Description	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	getPriorityMetadata
Description	Gets the metadata for the value priority. The metadata returned may depend on the state of the shuffle behavior.
Return	`osid.Metadata`		metadata for the priority
Compliance	`mandatory`		This method must be implemented.
Method	setPriority
Description	Sets the priority.
Parameters	`cardinal`	`priority`	the new priority
Errors	INVALID_ARGUMENT		`priority` is invalid
Errors	NO_ACCESS		`priority` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearPriority
Description	Clears the priority.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBooleanValueMetadata
Description	Gets the metadata for a boolean value.
Return	`osid.Metadata`		metadata for a boolean
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= BOOLEAN`
Compliance	`mandatory`		This method must be implemented.
Method	setBooleanValue
Description	Sets a boolean value.
Parameters	`boolean`	`value`	the new boolean value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= BOOLEAN`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getByteValueMetadata
Description	Gets the metadata for a byte value.
Return	`osid.Metadata`		metadata for a byte
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= BYTE`
Compliance	`mandatory`		This method must be implemented.
Method	setBytesValue
Description	Sets a byte value.
Parameters	`byte[]`	`value`	the new byte value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= BYTE`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCardinalValueMetadata
Description	Gets the metadata for a cardinal value.
Return	`osid.Metadata`		metadata for a cardinal
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= CARDINAL`
Compliance	`mandatory`		This method must be implemented.
Method	setCardinalValue
Description	Sets a cardinal value.
Parameters	`cardinal`	`value`	the new cardinal value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= CARDINAL`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateValueMetadata
Description	Gets the metadata for a coordinate value.
Return	`osid.Metadata`		metadata for a coordinate
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= COORDINATE`
Compliance	`mandatory`		This method must be implemented.
Method	setCoordinateValue
Description	Sets a coordinate value.
Parameters	`osid.mapping.Coordinate`	`value`	the new coordinate value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= COORDINATE`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getCurrencyValueMetadata
Description	Gets the metadata for a currency value.
Return	`osid.Metadata`		metadata for a currency
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= CURRENCY`
Compliance	`mandatory`		This method must be implemented.
Method	setCurrencyValue
Description	Sets a currency value.
Parameters	`osid.financials.Currency`	`value`	the new currency value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= CURRENCY`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getDateTimeValueMetadata
Description	Gets the metadata for a `DateTime` value.
Return	`osid.Metadata`		metadata for a datetime
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DATETIME`
Compliance	`mandatory`		This method must be implemented.
Method	setDateTimeValue
Description	Sets a `DateTime` value.
Parameters	`osid.calendaring.DateTime`	`value`	the new datetime value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DATETIME`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDecimalValueMetadata
Description	Gets the metadata for a decimal value.
Return	`osid.Metadata`		metadata for a decimal
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DECIMAL`
Compliance	`mandatory`		This method must be implemented.
Method	setDecimalValue
Description	Sets a decimal value.
Parameters	`decimal`	`value`	the new decimal value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DECIMAL`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getDisplayTextValueMetadata
Description	Gets the metadata for a text value.
Return	`osid.Metadata`		metadata for a display text
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DISPLAYTEXT`
Compliance	`mandatory`		This method must be implemented.
Method	setDisplayTextValue
Description	Sets a text value.
Parameters	`osid.locale.DisplayText`	`value`	the new display text value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DISPLAYTEXT`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDistanceValueMetadata
Description	Gets the metadata for a `Distance` value.
Return	`osid.Metadata`		metadata for a distance
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DISTANCE`
Compliance	`mandatory`		This method must be implemented.
Method	setDistanceValue
Description	Sets a `Distance` value.
Parameters	`osid.mapping.Distance`	`value`	the new distance value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DISTANCE`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDurationValueMetadata
Description	Gets the metadata for a `Duration` value.
Return	`osid.Metadata`		metadata for a duration
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DURATION`
Compliance	`mandatory`		This method must be implemented.
Method	setDurationValue
Description	Sets a `Duration` value.
Parameters	`osid.calendaring.Duration`	`value`	the new duration value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= DURATION`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIdValueMetadata
Description	Gets the metadata for an `Id` value.
Return	`osid.Metadata`		metadata for an `Id`
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= ID`
Compliance	`mandatory`		This method must be implemented.
Method	setIdValue
Description	Sets an `Id` value.
Parameters	`osid.id.Id`	`value`	the new `Id` value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= ID`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIntegerValueMetadata
Description	Gets the metadata for an integer value.
Return	`osid.Metadata`		metadata for an integer
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= INTEGER`
Compliance	`mandatory`		This method must be implemented.
Method	setIntegerValue
Description	Sets an integer value.
Parameters	`integer`	`value`	the new integer value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= INTEGER`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getSpatialUnitValueMetadata
Description	Gets the metadata for a spatial unit value.
Return	`osid.Metadata`		metadata for a spatial unit
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= SPATIALUNIT`
Compliance	`mandatory`		This method must be implemented.
Method	setSpatialUnitValue
Description	Sets a spatial unit value.
Parameters	`osid.mapping.SpatialUnit`	`value`	the new spatial unit value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= SPATIALUNIT`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedValueMetadata
Description	Gets the metadata for a speed value.
Return	`osid.Metadata`		metadata for a speed
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= SPEED`
Compliance	`mandatory`		This method must be implemented.
Method	setSpeedValue
Description	Sets a speed value.
Parameters	`osid.mapping.Speed`	`value`	the new speed value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= SPEED`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getStringValueMetadata
Description	Gets the metadata for a string value.
Return	`osid.Metadata`		metadata for a string
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= STRING`
Compliance	`mandatory`		This method must be implemented.
Method	setStringValue
Description	Sets a string value.
Parameters	`string`	`value`	the new string value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= STRING`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeValueMetadata
Description	Gets the metadata for a `Time` value.
Return	`osid.Metadata`		metadata for a `Time`
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= TIME`
Compliance	`mandatory`		This method must be implemented.
Method	setTimeValue
Description	Sets a `Time` value.
Parameters	`osid.calendaring.Time`	`value`	the new `Time` value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= TIME`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTypeValueMetadata
Description	Gets the metadata for a `Type` value.
Return	`osid.Metadata`		metadata for a `Type`
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= TYPE`
Compliance	`mandatory`		This method must be implemented.
Method	setTypeValue
Description	Sets a `Type` value.
Parameters	`osid.type.Type`	`value`	the new `Type` value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= TYPE`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVersionValueMetadata
Description	Gets the metadata for a `Version` value.
Return	`osid.Metadata`		metadata for a `Version`
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= VERSION`
Compliance	`mandatory`		This method must be implemented.
Method	setVersionValue
Description	Sets a `Version` value.
Parameters	`osid.installation.Version`	`value`	the new `Version` value
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= VERSION`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectValueMetadata
Description	Gets the metadata for an object value.
Return	`osid.Metadata`		metadata for an object
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= OBJECT`
Compliance	`mandatory`		This method must be implemented.
Method	setObjectValue
Description	Sets an object value.
Parameters	`object`	`value`	the new object value
Parameters	`osid.type.Type`	`objectType`	the object type
Errors	ILLEGAL_STATE		`Parameter.getSyntax()!= OBJECT`
	INVALID_ARGUMENT		`value` is invalid
	NO_ACCESS		`value` cannot be modified
	NULL_ARGUMENT		`value` or `objectType` is `null`
	UNSUPPORTED		`Metadata.supportsObjectType(objectType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearValue
Description	Clears the value.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getValueFormRecord
Description	Gets the `ValueFormRecord` corresponding to the given value record `Type`.
Parameters	`osid.type.Type`	`valueRecordType`	a value record type
Return	`osid.configuration.records.ValueFormRecord`		the value form record
Errors	NULL_ARGUMENT		`valueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(valueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.