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

Interface	osid.course.program.ProgramSearchSession
Implements	`osid.course.program.ProgramQuerySession`
Description	This session provides methods for searching among `Programs.` The search query is constructed using the `ProgramQuery.` `getProgramsByQuery()` is the basic search method and returns a list of `Programs.` A more advanced search may be performed with `getProgramsBySearch().` It accepts a `ProgramSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProgramsBySearch()` returns a `ProgramSearchResults` that can be used to access the resulting `ProgramList` or be used to perform a search within the result set through `ProgramSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include programs 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 Programs may have a query record indicated by their respective record types. The query record is accessed via the `ProgramQuery.`
Method	getProgramSearch
Description	Gets a program search.
Return	`osid.course.program.ProgramSearch`		the program search
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchOrder
Description	Gets a program search order. The `ProgramSearchOrder` is supplied to a `ProgramSearch` to specify the ordering of results.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Compliance	`mandatory`		This method must be implemented.
Method	getProgramsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.program.ProgramQuery`	`programQuery`	the program query
Parameters	`osid.course.program.ProgramSearch`	`programSearch`	the program search
Return	`osid.course.program.ProgramSearchResults`		the program search results
Errors	NULL_ARGUMENT		`programQuery` or `programSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programQuery` or `programSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProgramQueryFromInspector
Description	Gets a program query from an inspector. The inspector is available from a `ProgramSearchResults.`
Parameters	`osid.course.program.ProgramQueryInspector`	`programQueryInspector`	a program query inspector
Return	`osid.course.program.ProgramQuery`		the program query
Errors	NULL_ARGUMENT		`programQueryInspector` is `null`
Errors	UNSUPPORTED		`programQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.