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

Interface	osid.course.program.ProgramOfferingSearchSession
Implements	`osid.course.program.ProgramOfferingQuerySession`
Description	This session provides methods for searching among `ProgramOffering` objects. The search query is constructed using the `ProgramOfferingQuery.` `getProgramOfferingsByQuery()` is the basic search method and returns a list of `ProgramOfferings.` A more advanced search may be performed with `getProgramOfferingsBySearch().` It accepts a `ProgramOfferingSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProgramOfferingsBySearch()` returns a `ProgramOfferingSearchResults` that can be used to access the resulting `ProgramOfferingList` or be used to perform a search within the result set through `ProgramOfferingSearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include program offerings in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to program offerings in this course catalog Program offerings may have a query record indicated by their respective record types. The queryrecord is accessed via the `ProgramOfferingQuery.`
Method	getProgramOfferingSearch
Description	Gets a program offering search.
Return	`osid.course.program.ProgramOfferingSearch`		the program offering search
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingSearchOrder
Description	Gets a program offering search order. The `ProgramOfferingSearchOrder` is supplied to a `ProgramOfferingSearch` to specify the ordering of results.
Return	`osid.course.program.ProgramOfferingSearchOrder`		the program offering search order
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.program.ProgramOfferingQuery`	`programOfferingQuery`	the program offering query
Parameters	`osid.course.program.ProgramOfferingSearch`	`programOfferingSearch`	the program offering search
Return	`osid.course.program.ProgramOfferingSearchResults`		the program offering search results
Errors	NULL_ARGUMENT		`programOfferingQuery` or `programOfferingSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programOfferingQuery` or `programOfferingSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingQueryFromInspector
Description	Gets a program offering query from an inspector. The inspector is available from a `ProgramOfferingSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`programOfferingQueryInspector`	a program offering query inspector
Return	`osid.course.program.ProgramOfferingQuery`		the program offering query
Errors	NULL_ARGUMENT		`programOfferingQueryInspector` is `null`
Errors	UNSUPPORTED		`programOfferingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.