OSID - osid.hold.HoldSearchOrder Service Interface Definition

Interface	osid.hold.HoldSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
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	orderByAgent
Description	Orders the results by agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByIssue
Description	Orders the results by issue.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSearchOrder
Description	Tests if an issue search order is available.
Return	`boolean`		`true` if an issue search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchOrder
Description	Gets the issue search order.
Return	`osid.hold.IssueSearchOrder`		the issue search order
Errors	ILLEGAL_STATE		`supportsIssueSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldSearchOrderRecord
Description	Gets the hold search order record corresponding to the given hold record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`holdRecordType`	a hold record type
Return	`osid.hold.records.HoldSearchOrderRecord`		the hold search order record
Errors	NULL_ARGUMENT		`holdRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(holdRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.