public interface ControllerForm extends OsidObjectForm, OsidOperableForm
This is the form for creating and updating Controllers.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
ControllerAdminSession.
For each data element that may be set,
metadata may be examined to provide display hints or data constraints.
Some data may be automatically derived from the controller segments.
Modifier and Type | Method and Description |
---|---|
void |
clearAddress()
Removes the address.
|
void |
clearDiscreetStates()
Removes the discreet states.
|
void |
clearModel()
Removes the model.
|
void |
clearToggleable()
Removes the toggle.
|
void |
clearVariable()
Removes the variable flag.
|
void |
clearVariableMaximum()
Removes the maximum variable amount.
|
void |
clearVariableMinimum()
Removes the minimum variable amount.
|
void |
clearVariablePercentage()
Removes the variable by percentage flag.
|
void |
clearVersion()
Removes the version.
|
Metadata |
getAddressMetadata()
Gets the metadata for the address.
|
ControllerFormRecord |
getControllerFormRecord(Type controllerRecordType)
Gets the
ControllerFormRecord corresponding to the
given controller record Type. |
Metadata |
getDiscreetStatesMetadata()
Gets the metadata for the discreet states.
|
Metadata |
getModelMetadata()
Gets the metadata for the model.
|
Metadata |
getToggleableMetadata()
Gets the metadata for the toggle capability.
|
Metadata |
getVariableByPercentageMetadata()
Gets the metadata for the variable by percentage capability.
|
Metadata |
getVariableMaximumMetadata()
Gets the metadata for the maximum variable amount.
|
Metadata |
getVariableMetadata()
Gets the metadata for the variable capability.
|
Metadata |
getVariableMinimumMetadata()
Gets the metadata for the minimum variable amount.
|
Metadata |
getVersionMetadata()
Gets the metadata for the version.
|
void |
setAddress(java.lang.String address)
Sets the address.
|
void |
setDiscreetStates(Id[] stateIds)
Sets the maximum variable amount.
|
void |
setModel(Id modelId)
Sets the model.
|
void |
setToggleable(boolean toggle)
Sets the toggleable capability.
|
void |
setVariable(boolean variable)
Sets the variable capability.
|
void |
setVariableMaximum(java.math.BigDecimal amount)
Sets the maximum variable amount.
|
void |
setVariableMinimum(java.math.BigDecimal amount)
Sets the minimum variable amount.
|
void |
setVariablePercentage(boolean percentage)
Sets the variable bt percentage capability.
|
void |
setVersion(Version version)
Sets the version.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getAddressMetadata()
mandatory
- This method must be implemented. void setAddress(java.lang.String address)
address
- the new addressInvalidArgumentException
- address
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- address
is
null
mandatory
- This method must be implemented. void clearAddress()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getModelMetadata()
mandatory
- This method must be implemented. void setModel(Id modelId)
modelId
- the new modelInvalidArgumentException
- modelId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- modelId
is
null
mandatory
- This method must be implemented. void clearModel()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVersionMetadata()
mandatory
- This method must be implemented. void setVersion(Version version)
version
- the new versionInvalidArgumentException
- version
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- version
is
null
mandatory
- This method must be implemented. void clearVersion()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getToggleableMetadata()
mandatory
- This method must be implemented. void setToggleable(boolean toggle)
toggle
- the new toggle flagInvalidArgumentException
- toggle
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearToggleable()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVariableMetadata()
mandatory
- This method must be implemented. void setVariable(boolean variable)
variable
- the new variable flagInvalidArgumentException
- variable
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearVariable()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVariableByPercentageMetadata()
mandatory
- This method must be implemented. void setVariablePercentage(boolean percentage)
percentage
- the new percentage flagInvalidArgumentException
- percentage
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
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 getVariableMinimumMetadata()
mandatory
- This method must be implemented. void setVariableMinimum(java.math.BigDecimal amount)
amount
- the new minimum variable amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearVariableMinimum()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getVariableMaximumMetadata()
mandatory
- This method must be implemented. void setVariableMaximum(java.math.BigDecimal amount)
amount
- the new maximum variable amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearVariableMaximum()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDiscreetStatesMetadata()
mandatory
- This method must be implemented. void setDiscreetStates(Id[] stateIds)
stateIds
- the new discreet statesInvalidArgumentException
- stateIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stateIds
is
null
mandatory
- This method must be implemented. void clearDiscreetStates()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ControllerFormRecord getControllerFormRecord(Type controllerRecordType) throws OperationFailedException
ControllerFormRecord
corresponding to the
given controller record Type.
controllerRecordType
- a controller record typeNullArgumentException
- controllerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(controllerRecordType)
is false
mandatory
- This method must be implemented.