OSID - osid.calendaring.CommitmentSearchSession Service Interface Definition

Interface	osid.calendaring.CommitmentSearchSession
Implements	`osid.calendaring.CommitmentQuerySession`
Description	This session provides methods for searching `Commitment` objects. The search query is constructed using the `CommitmentQuery.` The commitment record `Type` also specifies the record for the commitment query. `getCommitmentsByQuery()` is the basic search method and returns a list of `Commitments.` A more advanced search may be performed with `getCommitmentsBySearch().` It accepts a `CommitmentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCommitmentsBySearch()` returns an `CommitmentSearchResults` that can be used to access the resulting `CommitmentList` or be used to perform a search within the result set through `CommitmentSearch.` This session defines views that offer differing behaviors for searching. federated calendar view: searches include commitments in calendars of which this calendar is a ancestor in the calendar hierarchy isolated calendar view: searches are restricted to commitments in this calendar only Commitments may have a query record indicated by their respective record types. The query record is accessed via the `CommitmentQuery.`
Method	getCommitmentSearch
Description	Gets a commitment search.
Return	`osid.calendaring.CommitmentSearch`		the commitment search
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentSearchOrder
Description	Gets a commitment search order. The `CommitmentSearchOrder` is supplied to a `CommitmentSearch` to specify the ordering of results.
Return	`osid.calendaring.CommitmentSearchOrder`		the commitment search order
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.CommitmentQuery`	`commitmentQuery`	the commitment search query
Parameters	`osid.calendaring.CommitmentSearch`	`commitmentSearch`	the commitment search
Return	`osid.calendaring.CommitmentSearchResults`		the commitment search results
Errors	NULL_ARGUMENT		`commitmentQuery` or `commitmentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentSearch` or `commitmentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentQueryFromInspector
Description	Gets a commitment query from an inspector. The inspector is available from an `CommitmentSearchResults.`
Parameters	`osid.calendaring.CommitmentQueryInspector`	`commitmentQueryInspector`	a commitment query inspector
Return	`osid.calendaring.CommitmentQuery`		the commitment query
Errors	NULL_ARGUMENT		`commitmentQueryInspector` is `null`
Errors	UNSUPPORTED		`commitmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.