Interface SettingForm

All Superinterfaces:

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

All Known Subinterfaces:

SettingBatchForm

public interface SettingForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating settings. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SettingAdminSession . 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	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.

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.

Method Details

getOnMetadata

Metadata getOnMetadata()

Gets the metadata for the on status.

Returns:

metadata for the on status

Compliance:

mandatory - This method must be implemented.

setOn

void setOn(boolean on)

Sets the on status.

Parameters:

on - the new on status

Throws:

InvalidArgumentException - on is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearOn

void clearOn()

Removes the on status.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getOffMetadata

Metadata getOffMetadata()

Gets the metadata for the off status.

Returns:

metadata for the off status

Compliance:

mandatory - This method must be implemented.

setOff

void setOff(boolean off)

Sets the off status.

Parameters:

off - the new off status

Throws:

InvalidArgumentException - off is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearOff

void clearOff()

Removes the off status.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getVariablePercentageMetadata

Metadata getVariablePercentageMetadata()

Gets the metadata for the percentage amount.

Returns:

metadata for the percentage amount

Compliance:

mandatory - This method must be implemented.

setVariablePercentage

void setVariablePercentage(BigDecimal amount)

Sets the percentage amount.

Parameters:

amount - the new percentage amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - amount is null

Compliance:

mandatory - This method must be implemented.

clearVariablePercentage

void clearVariablePercentage()

Removes the percentage amount.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getVariableAmountMetadata

Metadata getVariableAmountMetadata()

Gets the metadata for the variable amount.

Returns:

metadata for the variable amount

Compliance:

mandatory - This method must be implemented.

setVariableAmount

void setVariableAmount(BigDecimal amount)

Sets the variable amount.

Parameters:

amount - the new variable amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - amount is null

Compliance:

mandatory - This method must be implemented.

clearVariableAmount

void clearVariableAmount()

Removes the variable amount.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDiscreetMetadata

Metadata getDiscreetMetadata()

Gets the metadata for the state.

Returns:

metadata for the state

Compliance:

mandatory - This method must be implemented.

setDiscreetState

void setDiscreetState(Id stateId)

Sets the state.

Parameters:

stateId - the new state

Throws:

InvalidArgumentException - stateId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearDiscreetState

void clearDiscreetState()

Removes the discreet state.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRampRateMetadata

Metadata getRampRateMetadata()

Gets the metadata for the ramp rate.

Returns:

metadata for the ramp rate

Compliance:

mandatory - This method must be implemented.

setRampRate

void setRampRate(Duration rate)

Sets the ramp rate.

Parameters:

rate - the new ramp rate

Throws:

InvalidArgumentException - rate is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - rate is null

Compliance:

mandatory - This method must be implemented.

clearRampRate

void clearRampRate()

Removes the ramp rate.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSettingFormRecord

SettingFormRecord getSettingFormRecord(Type settingRecordType)
                                throws OperationFailedException

Gets the SettingFormRecord corresponding to the given setting record Type .

Parameters:

settingRecordType - a setting record type

Returns:

the setting form record

Throws:

NullArgumentException - settingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(settingRecordType) is false

Compliance:

mandatory - This method must be implemented.