OSID - osid.offering.OfferingSearchOrder Service Interface Definition

Interface	osid.offering.OfferingSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByCanonicalUnit
Description	Specifies a preference for ordering the result set by canonical unit.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitSearchOrder
Description	Tests if a canonical unit order is available.
Return	`boolean`		`true` if a canonical unit order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitSearchOrder
Description	Gets the canonical unit order.
Return	`osid.offering.CanonicalUnitSearchOrder`		the canonical unit search order
Errors	UNIMPLEMENTED		`supportsCanonicalUnitSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCanonicalUnitSearchOrder()` is `true.`
Method	orderByTimePeriod
Description	Specifies a preference for ordering the result set by time period.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodSearchOrder
Description	Tests if a time period order is available.
Return	`boolean`		`true` if a time period order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodSearchOrder
Description	Gets the time period order.
Return	`osid.calendaring.TimePeriodSearchOrder`		the time period search order
Errors	UNIMPLEMENTED		`supportsTimePeriodSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodSearchOrder()` is `true.`
Method	orderByTitle
Description	Specifies a preference for ordering the result set by offering title.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCode
Description	Specifies a preference for ordering the result set by offering code.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingSearchOrderRecord
Description	Gets the offering search order record corresponding to the given offering record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`offeringRecordType`	an offering record type
Return	`osid.offering.records.OfferingSearchOrderRecord`		the offering search order record
Errors	NULL_ARGUMENT		`offeringRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offeringRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.