Interface ValueBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSubjugateableForm, Suppliable, ValueForm

public interface ValueBatchForm
extends ValueForm

This is the form for creating and updating values in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ValueBatchAdminSession . 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
Id	getParameterId()	Gets the Id of the parameter given to getValueFormsForCreate() if this is a create transaction.
Id	getValueId()	Gets the Id of the value to be updated if this is an update transaction.

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.

Methods inherited from interface ValueForm

clearPriority, clearValue, getBooleanValueMetadata, getByteValueMetadata, getCardinalValueMetadata, getCoordinateValueMetadata, getCurrencyValueMetadata, getDateTimeValueMetadata, getDecimalValueMetadata, getDisplayTextValueMetadata, getDistanceValueMetadata, getDurationValueMetadata, getIdValueMetadata, getIntegerValueMetadata, getObjectValueMetadata, getPriorityMetadata, getSpatialUnitValueMetadata, getSpeedValueMetadata, getStringValueMetadata, getTimeValueMetadata, getTypeValueMetadata, getValueFormRecord, getVersionValueMetadata, setBooleanValue, setBytesValue, setCardinalValue, setCoordinateValue, setCurrencyValue, setDateTimeValue, setDecimalValue, setDisplayTextValue, setDistanceValue, setDurationValue, setIdValue, setIntegerValue, setObjectValue, setPriority, setSpatialUnitValue, setSpeedValue, setStringValue, setTimeValue, setTypeValue, setVersionValue

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.

Method Details

getParameterId

Id getParameterId()

Gets the Id of the parameter given to getValueFormsForCreate() if this is a create transaction.

Returns:

the parameter Id

Throws:

IllegalStateException - isForCreate() is false

Compliance:

mandatory - This method must be implemented.

getValueId

Id getValueId()

Gets the Id of the value to be updated if this is an update transaction.

Returns:

the value Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.