Interface SettingBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, SettingForm, Suppliable

public interface SettingBatchForm
extends SettingForm

This is the form for creating and updating settings in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SettingBatchAdminSession . 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	getControllerId()	Gets the Id of the controller if this is a create transaction.
Id	getSettingId()	Gets the Id of the setting 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 SettingForm

clearDiscreetState, clearOff, clearOn, clearRampRate, clearVariableAmount, clearVariablePercentage, getDiscreetMetadata, getOffMetadata, getOnMetadata, getRampRateMetadata, getSettingFormRecord, getVariableAmountMetadata, getVariablePercentageMetadata, setDiscreetState, setOff, setOn, setRampRate, setVariableAmount, setVariablePercentage

Modifier and Type	Method	Description
void	clearDiscreetState()	Removes the discreet state.
void	clearOff()	Removes the off status.
void	clearOn()	Removes the on status.
void	clearRampRate()	Removes the ramp rate.
void	clearVariableAmount()	Removes the variable amount.
void	clearVariablePercentage()	Removes the percentage amount.
Metadata	getDiscreetMetadata()	Gets the metadata for the state.
Metadata	getOffMetadata()	Gets the metadata for the off status.
Metadata	getOnMetadata()	Gets the metadata for the on status.
Metadata	getRampRateMetadata()	Gets the metadata for the ramp rate.
SettingFormRecord	getSettingFormRecord(Type settingRecordType)	Gets the SettingFormRecord corresponding to the given setting record Type .
Metadata	getVariableAmountMetadata()	Gets the metadata for the variable amount.
Metadata	getVariablePercentageMetadata()	Gets the metadata for the percentage amount.
void	setDiscreetState(Id stateId)	Sets the state.
void	setOff(boolean off)	Sets the off status.
void	setOn(boolean on)	Sets the on status.
void	setRampRate(Duration rate)	Sets the ramp rate.
void	setVariableAmount(BigDecimal amount)	Sets the variable amount.
void	setVariablePercentage(BigDecimal amount)	Sets the percentage amount.

Method Details

getSettingId

Id getSettingId()

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

Returns:

the setting Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.

getControllerId

Id getControllerId()

Gets the Id of the controller if this is a create transaction.

Returns:

the controller Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.