OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingForm
Implementsosid.OsidObjectForm
osid.OsidSubjugateableForm
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.

MethodgetOnMetadata
Description

Gets the metadata for the on status.

Returnosid.Metadatametadata for the on status
CompliancemandatoryThis method must be implemented.
MethodsetOn
Description

Sets the on status.

Parametersbooleanonthe new on status
ErrorsINVALID_ARGUMENT on is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOn
Description

Removes the on status.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOffMetadata
Description

Gets the metadata for the off status.

Returnosid.Metadatametadata for the off status
CompliancemandatoryThis method must be implemented.
MethodsetOff
Description

Sets the off status.

Parametersbooleanoffthe new off status
ErrorsINVALID_ARGUMENT off is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOff
Description

Removes the off status.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetVariablePercentageMetadata
Description

Gets the metadata for the percentage amount.

Returnosid.Metadatametadata for the percentage amount
CompliancemandatoryThis method must be implemented.
MethodsetVariablePercentage
Description

Sets the percentage amount.

Parametersdecimalamountthe new percentage amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT amount is null
CompliancemandatoryThis method must be implemented.
MethodclearVariablePercentage
Description

Removes the percentage amount.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetVariableAmountMetadata
Description

Gets the metadata for the variable amount.

Returnosid.Metadatametadata for the variable amount
CompliancemandatoryThis method must be implemented.
MethodsetVariableAmount
Description

Sets the variable amount.

Parametersdecimalamountthe new variable amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT amount is null
CompliancemandatoryThis method must be implemented.
MethodclearVariableAmount
Description

Removes the variable amount.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetMetadata
Description

Gets the metadata for the state.

Returnosid.Metadatametadata for the state
CompliancemandatoryThis method must be implemented.
MethodsetDiscreetState
Description

Sets the state.

Parametersosid.id.IdstateIdthe new state
ErrorsINVALID_ARGUMENT stateId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetState
Description

Removes the discreet state.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRampRateMetadata
Description

Gets the metadata for the ramp rate.

Returnosid.Metadatametadata for the ramp rate
CompliancemandatoryThis method must be implemented.
MethodsetRampRate
Description

Sets the ramp rate.

Parametersosid.calendaring.Durationratethe new ramp rate
ErrorsINVALID_ARGUMENT rate is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT rate is null
CompliancemandatoryThis method must be implemented.
MethodclearRampRate
Description

Removes the ramp rate.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSettingFormRecord
Description

Gets the SettingFormRecord corresponding to the given setting record Type.

Parametersosid.type.TypesettingRecordTypea setting record type
Returnosid.control.records.SettingFormRecordthe setting form record
ErrorsNULL_ARGUMENT settingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(settingRecordType) is false
CompliancemandatoryThis method must be implemented.