OSID - osid.course.program.CredentialSearchSession Service Interface Definition

Interface	osid.course.program.CredentialSearchSession
Implements	`osid.course.program.CredentialQuerySession`
Description	This session provides methods for searching among `credential` objects. The search query is constructed using the `CredentialQuery.` `getCredentialsByQuery()` is the basic search method and returns a list of `Credentials.` A more advanced search may be performed with `getCredentialsBySearch().` It accepts a `CredentialSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCredentialsBySearch()` returns a `CredentialSearchResults` that can be used to access the resulting `CredentialList` or be used to perform a search within the result set through `CredentialSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include credentials in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to credentials in this course catalog Credentials may have a query record indicated by their respective record types. The query record is accessed via the `CredentialQuery.`
Method	getCredentialSearch
Description	Gets a credential search.
Return	`osid.course.program.CredentialSearch`		the credential search
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialSearchOrder
Description	Gets a credential search order. The `CredentialSearchOrder` is supplied to a `CredentialSearch` to specify the ordering of results.
Return	`osid.course.program.CredentialSearchOrder`		the credential search order
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.program.CredentialQuery`	`credentialQuery`	the credential query
Parameters	`osid.course.program.CredentialSearch`	`credentialSearch`	the credential search
Return	`osid.course.program.CredentialSearchResults`		the credential search results
Errors	NULL_ARGUMENT		`credentialQuery` or `credentialSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialQuery` or `credentialSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQueryFromInspector
Description	Gets a credential query from an inspector. The inspector is available from a `CredentialSearchResults.`
Parameters	`osid.course.program.CredentialQueryInspector`	`credentialQueryInspector`	a credential query inspector
Return	`osid.course.program.CredentialQuery`		the credential query
Errors	NULL_ARGUMENT		`credentialQueryInspector` is `null`
Errors	UNSUPPORTED		`credentialQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.