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.
Modifier and Type | Method and 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(java.math.BigDecimal amount)
Sets the variable amount.
|
void |
setVariablePercentage(java.math.BigDecimal amount)
Sets the percentage amount.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getOnMetadata()
mandatory
- This method must be implemented. void setOn(boolean on)
on
- the new on statusInvalidArgumentException
- on
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOn()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOffMetadata()
mandatory
- This method must be implemented. void setOff(boolean off)
off
- the new off statusInvalidArgumentException
- off
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOff()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVariablePercentageMetadata()
mandatory
- This method must be implemented. void setVariablePercentage(java.math.BigDecimal amount)
amount
- the new percentage amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearVariablePercentage()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVariableAmountMetadata()
mandatory
- This method must be implemented. void setVariableAmount(java.math.BigDecimal amount)
amount
- the new variable amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearVariableAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDiscreetMetadata()
mandatory
- This method must be implemented. void setDiscreetState(Id stateId)
stateId
- the new stateInvalidArgumentException
- stateId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDiscreetState()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRampRateMetadata()
mandatory
- This method must be implemented. void setRampRate(Duration rate)
rate
- the new ramp rateInvalidArgumentException
- rate
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- rate
is
null
mandatory
- This method must be implemented. void clearRampRate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. SettingFormRecord getSettingFormRecord(Type settingRecordType) throws OperationFailedException
SettingFormRecord
corresponding to the given
setting record Type.
settingRecordType
- a setting record typeNullArgumentException
- settingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(settingRecordType)
is false
mandatory
- This method must be implemented.