OSID - osid.control.ControllerForm Service Interface Definition

Interface	osid.control.ControllerForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidOperableForm`
Implemented By	`osid.control.batch.ControllerBatchForm`
Used By	`osid.control.ControllerAdminSession`
Description	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.
Method	getAddressMetadata
Description	Gets the metadata for the address.
Return	`osid.Metadata`		metadata for the address
Compliance	`mandatory`		This method must be implemented.
Method	setAddress
Description	Sets the address.
Parameters	`string`	`address`	the new address
Errors	INVALID_ARGUMENT		`address` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`address` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddress
Description	Removes the address.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getModelMetadata
Description	Gets the metadata for the model.
Return	`osid.Metadata`		metadata for the model
Compliance	`mandatory`		This method must be implemented.
Method	setModel
Description	Sets the model.
Parameters	`osid.id.Id`	`modelId`	the new model
Errors	INVALID_ARGUMENT		`modelId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`modelId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearModel
Description	Removes the model.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVersionMetadata
Description	Gets the metadata for the version.
Return	`osid.Metadata`		metadata for the version
Compliance	`mandatory`		This method must be implemented.
Method	setVersion
Description	Sets the version.
Parameters	`osid.installation.Version`	`version`	the new version
Errors	INVALID_ARGUMENT		`version` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`version` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVersion
Description	Removes the version.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getToggleableMetadata
Description	Gets the metadata for the toggle capability.
Return	`osid.Metadata`		metadata for the toggle
Compliance	`mandatory`		This method must be implemented.
Method	setToggleable
Description	Sets the toggleable capability.
Parameters	`boolean`	`toggle`	the new toggle flag
Errors	INVALID_ARGUMENT		`toggle` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearToggleable
Description	Removes the toggle.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableMetadata
Description	Gets the metadata for the variable capability.
Return	`osid.Metadata`		metadata for the variable
Compliance	`mandatory`		This method must be implemented.
Method	setVariable
Description	Sets the variable capability.
Parameters	`boolean`	`variable`	the new variable flag
Errors	INVALID_ARGUMENT		`variable` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearVariable
Description	Removes the variable flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableByPercentageMetadata
Description	Gets the metadata for the variable by percentage capability.
Return	`osid.Metadata`		metadata for the percentage
Compliance	`mandatory`		This method must be implemented.
Method	setVariablePercentage
Description	Sets the variable bt percentage capability.
Parameters	`boolean`	`percentage`	the new percentage flag
Errors	INVALID_ARGUMENT		`percentage` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearVariablePercentage
Description	Removes the variable by percentage flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableMinimumMetadata
Description	Gets the metadata for the minimum variable amount.
Return	`osid.Metadata`		metadata for the minimum variable amount
Compliance	`mandatory`		This method must be implemented.
Method	setVariableMinimum
Description	Sets the minimum variable amount.
Parameters	`decimal`	`amount`	the new minimum 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	clearVariableMinimum
Description	Removes the minimum variable amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableMaximumMetadata
Description	Gets the metadata for the maximum variable amount.
Return	`osid.Metadata`		metadata for the maximum variable amount
Compliance	`mandatory`		This method must be implemented.
Method	setVariableMaximum
Description	Sets the maximum variable amount.
Parameters	`decimal`	`amount`	the new maximum 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	clearVariableMaximum
Description	Removes the maximum variable amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStatesMetadata
Description	Gets the metadata for the discreet states.
Return	`osid.Metadata`		metadata for the discreet states
Compliance	`mandatory`		This method must be implemented.
Method	setDiscreetStates
Description	Sets the maximum variable amount.
Parameters	`osid.id.Id[]`	`stateIds`	the new discreet states
Errors	INVALID_ARGUMENT		`stateIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDiscreetStates
Description	Removes the discreet states.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getControllerFormRecord
Description	Gets the `ControllerFormRecord` corresponding to the given controller record `Type`.
Parameters	`osid.type.Type`	`controllerRecordType`	a controller record type
Return	`osid.control.records.ControllerFormRecord`		the controller form record
Errors	NULL_ARGUMENT		`controllerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(controllerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.