OSID - osid.resourcing.EffortSearchOrder Service Interface Definition

Interface	osid.resourcing.EffortSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.resourcing.EffortSearchSession`
Used By	`osid.resourcing.EffortSmartFoundrySession`
Description	An interface for specifying the ordering of search results.
Method	orderByResource
Description	Orders the results by resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsResourceSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCommission
Description	Orders the results by the commission.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommissionSearchOrder
Description	Tests if a commission search order is available.
Return	`boolean`		`true` if a commission search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionSearchOrder
Description	Gets the commission search order.
Return	`osid.resourcing.CommissionSearchOrder`		the commission search order
Errors	ILLEGAL_STATE		`supportsCommissionSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTimeSpent
Description	Orders the results by the time spent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEffortSearchOrderRecord
Description	Gets the effort search order record corresponding to the given effort record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`effortRecordType`	an effort record type
Return	`osid.resourcing.records.EffortSearchOrderRecord`		the effort search order record
Errors	NULL_ARGUMENT		`effortRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(effortRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.