OSID - osid.control.SettingForm Service Interface Definition

Interface	osid.control.SettingForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.control.batch.SettingBatchForm`
Used By	`osid.control.SettingAdminSession`
Description	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	getOnMetadata
Description	Gets the metadata for the on status.
Return	`osid.Metadata`		metadata for the on status
Compliance	`mandatory`		This method must be implemented.
Method	setOn
Description	Sets the on status.
Parameters	`boolean`	`on`	the new on status
Errors	INVALID_ARGUMENT		`on` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearOn
Description	Removes the on status.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getOffMetadata
Description	Gets the metadata for the off status.
Return	`osid.Metadata`		metadata for the off status
Compliance	`mandatory`		This method must be implemented.
Method	setOff
Description	Sets the off status.
Parameters	`boolean`	`off`	the new off status
Errors	INVALID_ARGUMENT		`off` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearOff
Description	Removes the off status.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariablePercentageMetadata
Description	Gets the metadata for the percentage amount.
Return	`osid.Metadata`		metadata for the percentage amount
Compliance	`mandatory`		This method must be implemented.
Method	setVariablePercentage
Description	Sets the percentage amount.
Parameters	`decimal`	`amount`	the new percentage amount
Errors	INVALID_ARGUMENT		`amount` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`amount` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVariablePercentage
Description	Removes the percentage amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableAmountMetadata
Description	Gets the metadata for the variable amount.
Return	`osid.Metadata`		metadata for the variable amount
Compliance	`mandatory`		This method must be implemented.
Method	setVariableAmount
Description	Sets the variable amount.
Parameters	`decimal`	`amount`	the new variable amount
Errors	INVALID_ARGUMENT		`amount` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`amount` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVariableAmount
Description	Removes the variable amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetMetadata
Description	Gets the metadata for the state.
Return	`osid.Metadata`		metadata for the state
Compliance	`mandatory`		This method must be implemented.
Method	setDiscreetState
Description	Sets the state.
Parameters	`osid.id.Id`	`stateId`	the new state
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDiscreetState
Description	Removes the discreet state.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRampRateMetadata
Description	Gets the metadata for the ramp rate.
Return	`osid.Metadata`		metadata for the ramp rate
Compliance	`mandatory`		This method must be implemented.
Method	setRampRate
Description	Sets the ramp rate.
Parameters	`osid.calendaring.Duration`	`rate`	the new ramp rate
Errors	INVALID_ARGUMENT		`rate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`rate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRampRate
Description	Removes the ramp rate.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSettingFormRecord
Description	Gets the `SettingFormRecord` corresponding to the given setting record `Type`.
Parameters	`osid.type.Type`	`settingRecordType`	a setting record type
Return	`osid.control.records.SettingFormRecord`		the setting form record
Errors	NULL_ARGUMENT		`settingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(settingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.