OSID - osid.control.TriggerSearchOrder Service Interface Definition

Interface	osid.control.TriggerSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.control.TriggerSearchSession`
Used By	`osid.control.TriggerSmartSystemSession`
Description	An interface for specifying the ordering of search results.
Method	orderByController
Description	Orders the results by controller.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsControllerSearchOrder
Description	Tests if a controller search order is available.
Return	`boolean`		`true` if a controller search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getControllerSearchOrder
Description	Gets the controller search order.
Return	`osid.control.ControllerSearchOrder`		the controller search order
Errors	ILLEGAL_STATE		`supportsControllerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTurnedOn
Description	Orders the results by ON event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTurnedOff
Description	Orders the results by OFF event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByChangedVariableAmount
Description	Orders the results by changed variable amount event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExceedsVariableAmount
Description	Orders the results by exceeds variable amount event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDeceedsVariableAmount
Description	Orders the results by deceeds variable amount event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByChangedDiscreetState
Description	Orders the results by state change event listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDiscreetState
Description	Orders the results by state listeners.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsDiscreetStateSearchOrder
Description	Tests if a state search order is available.
Return	`boolean`		`true` if a state search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStateSearchOrder
Description	Gets the discreet state search order.
Return	`osid.process.StateSearchOrder`		the state search order
Errors	ILLEGAL_STATE		`supportsDiscreetStateSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerSearchOrderRecord
Description	Gets the trigger search order record corresponding to the given trigger `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`triggerRecordType`	a trigger record type
Return	`osid.control.records.TriggerSearchOrderRecord`		the trigger search order record
Errors	NULL_ARGUMENT		`triggerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(triggerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.