OSID - osid.control.Controller Service Interface Definition

Interface	osid.control.Controller
Implements	`osid.OsidObject`
Implements	`osid.Operable`
Used By	`osid.control.Action`
	`osid.control.ControllerAdminSession`
	`osid.control.ControllerList`
	`osid.control.ControllerLookupSession`
	`osid.control.Input`
	`osid.control.Setting`
	`osid.control.Trigger`
Description	A `Controller` is an addressable `Operable` that executes an action. `Controllers` are related to `Devices` through `Inputs`. A few typical controller modes are defined such as a toggle, a variable amount, and a set of discreet states. Other kinds of controllers may be defined in a `ControllerRecord`.
Method	getAddress
Description	Gets the controller address.
Return	`string`		the address
Compliance	`mandatory`		This method must be implemented.
Method	getModelId
Description	Gets the controller model `Id`.
Return	`osid.id.Id`		the model `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getModel
Description	Gets the controller model.
Return	`osid.inventory.Model`		the model
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getVersion
Description	Gets the controller version.
Return	`osid.installation.Version`		the version
Compliance	`mandatory`		This method must be implemented.
Method	isToggleable
Description	Tests if this controller can be turned on and off. A controller that may also be variable if the minimum and maximum settings correspond to ON and OFF. A controller that defines discreet states may also presnet itself as toggleable if there are ON and OFF states.
Return	`boolean`		`true` if this controller can be toggled, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isVariable
Description	Tests if this controller supports levels between on and off. A variable controller may also be toggleable but does not define discreet states.
Return	`boolean`		`true` if this controller has levels, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isVariableByPercentage
Description	Tests if the levels represent a percentage.
Return	`boolean`		`true` if this controller has levels as a percentage, false otherwise
Errors	ILLEGAL_STATE		`isVariable()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableMinimum
Description	Gets the minimum level.
Return	`decimal`		the minimum level
Errors	ILLEGAL_STATE		`isVariable()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableMaximum
Description	Gets the maximum level.
Return	`decimal`		the maximum level
Errors	ILLEGAL_STATE		`isVariable()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getVariableIncrement
Description	Gets the increments in the level.
Return	`decimal`		the increment
Errors	ILLEGAL_STATE		`isVariable()` is `false` or `isVariableByPercentage()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	hasDiscreetStates
Description	Tests if this controller supports discreet states. A state controller may also be toggleable but not variable.
Return	`boolean`		`true` if this controller has discreet states, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStateIds
Description	Gets the discreet `State` `Ids`.
Return	`osid.id.IdList`		a list of state `Ids`
Errors	ILLEGAL_STATE		`hasDiscreetStates()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStates
Description	Gets the discreet `States`.
Return	`osid.process.StateList`		a list of states
Errors	ILLEGAL_STATE		`hasDiscreetStates()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isRampable
Description	Tests if this controller supports a ramp rate for a transition from off to on.
Return	`boolean`		`true` if this controller supports ramp rates, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getControllerRecord
Description	Gets the controller record corresponding to the given `Controller` record `Type`. This method is used to retrieve an object implementing the requested record. The `controllerRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(controllerRecordType)` is `true`.
Parameters	`osid.type.Type`	`controllerRecordType`	the type of controller record to retrieve
Return	`osid.control.records.ControllerRecord`		the controller 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.