OSID - osid.course.chronicle.CredentialEntrySearchOrder Service Interface Definition

Interface	osid.course.chronicle.CredentialEntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.chronicle.CredentialEntrySearchSession`
Used By	`osid.course.chronicle.CredentialEntrySmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByStudent
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	supportsStudentSearchOrder
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	getStudentSearchOrder
Description	Gets the resource order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsStudentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentSearchOrder()` is `true`.
Method	orderByCredential
Description	Specifies a preference for ordering the result set by the credential.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialSearchOrder
Description	Tests if a credential order is available.
Return	`boolean`		`true` if a credential order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialSearchOrder
Description	Gets the credential order.
Return	`osid.course.program.CredentialSearchOrder`		the credential search order
Errors	UNIMPLEMENTED		`supportsCredentialSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCredentialSearchOrder()` is `true`.
Method	orderByIsMatriculationKnown
Description	Specifies a preference for ordering the result set by the matriculation known flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStartDate
Description	Specifies a preference for ordering the result set by the start date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStartTerm
Description	Specifies a preference for ordering the result set by the start term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartTermSearchOrder
Description	Tests if a start term order is available.
Return	`boolean`		`true` if a start term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartTermSearchOrder
Description	Gets the start term order.
Return	`osid.course.TermSearchOrder`		the start term search order
Errors	UNIMPLEMENTED		`supportsStartTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartTermSearchOrder()` is `true`.
Method	orderByIsExpectedToComplete
Description	Specifies a preference for ordering the result set by the is expected to complete flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExpectedCompletionDate
Description	Specifies a preference for ordering the result set by the expected completion date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExpectedCompletionTerm
Description	Specifies a preference for ordering the result set by the expected completion term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsExpectedCompletionTermSearchOrder
Description	Tests if a expected completion term order is available.
Return	`boolean`		`true` if a expected completion term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermSearchOrder
Description	Gets the expected completion term order.
Return	`osid.course.TermSearchOrder`		the expected completion term search order
Errors	UNIMPLEMENTED		`supportsExpectedCompletionTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExpectedCompletionTermSearchOrder()` is `true`.
Method	orderByIsActivelyPursuing
Description	Specifies a preference for ordering the result set by the actively pursuing flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByIsPaused
Description	Specifies a preference for ordering the result set by the is paused flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByIsAbandoned
Description	Specifies a preference for ordering the result set by the is abandoned flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAbandonDate
Description	Specifies a preference for ordering the result set by the abandon date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAbandonTerm
Description	Specifies a preference for ordering the result set by the abandon term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAbandonTermSearchOrder
Description	Tests if a abandon term order is available.
Return	`boolean`		`true` if a abandon term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonTermSearchOrder
Description	Gets the abandon term order.
Return	`osid.course.TermSearchOrder`		the abandon term search order
Errors	UNIMPLEMENTED		`supportsAbandonTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAbandonTermSearchOrder()` is `true`.
Method	orderByIsAwarded
Description	Specifies a preference for ordering the result set by the is awarded flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAwardDate
Description	Specifies a preference for ordering the result set by the award date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAwardTerm
Description	Specifies a preference for ordering the result set by the award term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardTermSearchOrder
Description	Tests if a award term order is available.
Return	`boolean`		`true` if a award term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardTermSearchOrder
Description	Gets the award term order.
Return	`osid.course.TermSearchOrder`		the award term search order
Errors	UNIMPLEMENTED		`supportsAwardTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAwardTermSearchOrder()` is `true`.
Method	orderByDateAwarded
Description	Specifies a preference for ordering the result set by the award date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByProgram
Description	Specifies a preference for ordering the result set by the program.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearchOrder
Description	Tests if a program order is available.
Return	`boolean`		`true` if a program order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchOrder
Description	Gets the program order.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Errors	UNIMPLEMENTED		`supportsProgramSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramSearchOrder()` is `true`.
Method	getCredentialEntrySearchOrderRecord
Description	Gets the chronicle search order record corresponding to the given credential entry record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`credentialEntryRecordType`	a credential entry record type
Return	`osid.course.chronicle.records.CredentialEntrySearchOrderRecord`		the credential entry search order record
Errors	NULL_ARGUMENT		`credentialEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(credentialEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.