OSID - osid.OsidRequestSearchOrder Service Interface Definition

Interface	osid.OsidRequestSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implemented By	`osid.course.registration.request.RegistrationRequestSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByPostingDate
Description	Orders results by the posting date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRequester
Description	Specifies a preference for ordering the results by the requester.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequesterSearchOrder
Description	Tests if a `ResourceSearchOrder` is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequesterSearchOrder
Description	Gets the search order for a requester resource.
Return	`osid.resource.ResourceSearchOrder`		the requester search order
Errors	UNIMPLEMENTED		`supportsRequesterSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRequesterSearchOrder()` is `true` .
Method	orderBySubmittedDate
Description	Orders results by the submitted date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySubmitter
Description	Specifies a preference for ordering the results by the submitter.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmitterSearchOrder
Description	Tests if a `ResourceSearchOrder` is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubmitterSearchOrder
Description	Gets the search order for a submitter resource.
Return	`osid.resource.ResourceSearchOrder`		the submitter search order
Errors	UNIMPLEMENTED		`supportsSubmitterSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmitterSearchOrder()` is `true` .
Method	orderBySubmittingAgent
Description	Specifies a preference for ordering the results by the submitting agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmittingAgentSearchOrder
Description	Tests if a `ResourceSearchOrder` is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubmittingAgentSearchOrder
Description	Gets the search order for a submitting agent.
Return	`osid.authentication.AgentSearchOrder`		the submitting agent search order
Errors	UNIMPLEMENTED		`supportsSubmittingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmittingAgentSearchOrder()` is `true` .
Method	orderByCanceledDate
Description	Orders results by the canceled date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByProcessedDate
Description	Orders results by the processed date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByError
Description	Orders results by the error state.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsErrorSearchOrder
Description	Tests if a `StateSearchOrder` is available.
Return	`boolean`		`true` if a state search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getErrorSearchOrder
Description	Gets the search order for an error state.
Return	`osid.process.StateSearchOrder`		the error state search order
Errors	UNIMPLEMENTED		`supportsErrorSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsErrorSearchOrder()` is `true` .