OSID - osid.journaling.JournalEntrySearchOrder Service Interface Definition

Interface	osid.journaling.JournalEntrySearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.journaling.BranchSearchOrder`
Used By	`osid.journaling.JournalEntrySearchSession`
Description	An interface for specifying the ordering of search results.
Method	orderByBranch
Description	Specifies a preference for ordering the result set by the branch.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchSearchOrder
Description	Tests if a branch search order is available.
Return	`boolean`		`true` if a branch order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchOrder
Description	Gets the branch search order.
Return	`osid.journaling.BranchSearchOrder`		the branch search order
Errors	UNIMPLEMENTED		`supportsBranchSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBranchSearchOrder()` is `true`.
Method	orderBySource
Description	Specifies a preference for ordering the result set by the source.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTimestamp
Description	Specifies a preference for ordering the result set by the timestamp.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResource
Description	Specifies a preference for ordering the result set by the 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 order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets the resource order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsResourceSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSearchOrder()` is `true`.
Method	orderByAgent
Description	Specifies a preference for ordering the result set by the 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 order is available.
Return	`boolean`		`true` if an agent order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentSearchOrder
Description	Gets the agent order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSearchOrder()` is `true`.
Method	getJournalEntrySearchOrderRecord
Description	Gets the journal entry search order record corresponding to the given journal entry record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`journalEntryRecordType`	a journal entry record type
Return	`osid.journaling.records.JournalEntrySearchOrderRecord`		the journal entry search order record
Errors	NULL_ARGUMENT		`journalEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(journalEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.