OSID - osid.checklist.ChecklistSearchSession Service Interface Definition

Interface	osid.checklist.ChecklistSearchSession
Implements	`osid.checklist.ChecklistQuerySession`
Used By	`osid.checklist.ChecklistManager`
Used By	`osid.checklist.ChecklistProxyManager`
Description	This session provides methods for searching `Checklists` . The search query is constructed using the `ChecklistQuery` . The checklist record `Type` also specifies the record for the checklist query. `getChecklistsByQuery()` is the basic search method and returns a list of `Checklist` elements. A more advanced search may be performed with `getChecklistsBySearch()` . It accepts a `ChecklistSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getChecklistsBySearch()` returns a `ChecklistSearchResults` that can be used to access the resulting `ChecklistList` or be used to perform a search within the result set through `ChecklistSearch` . Checklists may have a query record indicated by their respective record types. The query record is accessed via the `ChecklistQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getChecklistSearch
Description	Gets a checklist search.
Return	`osid.checklist.ChecklistSearch`		the checklist search
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistSearchOrder
Description	Gets a checklist search order. The `ChecklistSearchOrder` is supplied to a `ChecklistSearch` to specify the ordering of results.
Return	`osid.checklist.ChecklistSearchOrder`		the checklist search order
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.checklist.ChecklistQuery`	`checklistQuery`	the checklist query
Parameters	`osid.checklist.ChecklistSearch`	`checklistSearch`	the checklist search
Return	`osid.checklist.ChecklistSearchResults`		the search results
Errors	NULL_ARGUMENT		`checklistQuery` or `checklistSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`checklistQuery` or `checklistSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getChecklistQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `ChecklistSearchResults` .
Parameters	`osid.checklist.ChecklistQueryInspector`	`checklistQueryInspector`	a checklist query inspector
Return	`osid.checklist.ChecklistQuery`		the checklist query
Errors	NULL_ARGUMENT		`checklistQueryInspector` is `null`
Errors	UNSUPPORTED		`checklistQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.