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

Interface	osid.course.chronicle.CredentialEntrySearchSession
Implements	`osid.course.chronicle.CredentialEntryQuerySession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session provides methods for searching among `CredentialEntries`. The search query is constructed using the `CredentialEntryQuery`. `getCredentialEntriesByQuery()` is the basic search method and returns a list of `CredentialEntries`. A more advanced search may be performed with `getCredentialEntriesBySearch()`. It accepts a `CredentialEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCredentialEntriesBySearch()` returns a `CredentialEntrySearchResults` that can be used to access the resulting `CredentialEntryList` or be used to perform a search within the result set through `CredentialEntrySearch`. This session defines views that offer differing behaviors for searching. federated course catalog view: searches include credential entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to courses in this course catalog CredentialEntries may have a query record indicated by their respective record types. The query record is accessed via the `CredentialEntryQuery`.
Method	getCredentialEntrySearch
Description	Gets a credential entry search.
Return	`osid.course.chronicle.CredentialEntrySearch`		the credential entry search
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntrySearchOrder
Description	Gets a credential entry search order. The `CredentialEntrySearchOrder` is supplied to a `CredentialEntrySearch` to specify the ordering of results.
Return	`osid.course.chronicle.CredentialEntrySearchOrder`		the credential entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.chronicle.CredentialEntryQuery`	`credentialEntryQuery`	the credential entry query
Parameters	`osid.course.chronicle.CredentialEntrySearch`	`credentialEntrySearch`	the credential entry search
Return	`osid.course.chronicle.CredentialEntrySearchResults`		the credential entry search results
Errors	NULL_ARGUMENT		`credentialEntryQuery` or `credentialEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialEntryQuery` or `CredentialEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryQueryFromInspector
Description	Gets a credential entry query from an inspector. The inspector is available from a `CredentialEntrySearchResults`.
Parameters	`osid.course.chronicle.CredentialEntryQueryInspector`	`credentialEntryQueryInspector`	a credential entry query inspector
Return	`osid.course.chronicle.CredentialEntryQuery`		the credential entry query
Errors	NULL_ARGUMENT		`credentialEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`credentialEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.