OSID - osid.course.chronicle.ProgramEntrySearchSession Service Interface Definition

Interface	osid.course.chronicle.ProgramEntrySearchSession
Implements	`osid.course.chronicle.ProgramEntryQuerySession`
Description	This session provides methods for searching among `ProgramEntries.` The search query is constructed using the `ProgramEntryQuery.` `getProgramEntriesByQuery()` is the basic search method and returns a list of `ProgramEntries.` A more advanced search may be performed with `getProgramEntriesBySearch().` It accepts a `ProgramEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProgramEntriesBySearch()` returns a `ProgramEntrySearchResults` that can be used to access the resulting `ProgramEntryList` or be used to perform a search within the result set through `ProgramEntrySearch.` This session defines views that offer differing behaviors for searching. federated course catalog view: searches include program entries 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 ProgramEntries may have a query record indicated by their respective record types. The query record is accessed via the `ProgramEntryQuery.`
Method	getProgramEntrySearch
Description	Gets a program entry search.
Return	`osid.course.chronicle.ProgramEntrySearch`		the program entry search
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntrySearchOrder
Description	Gets a program entry search order. The `ProgramEntrySearchOrder` is supplied to a `ProgramEntrySearch` to specify the ordering of results.
Return	`osid.course.chronicle.ProgramEntrySearchOrder`		the program entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.chronicle.ProgramEntryQuery`	`programEntryQuery`	the program entry query
Parameters	`osid.course.chronicle.ProgramEntrySearch`	`programEntrySearch`	the program entry search
Return	`osid.course.chronicle.ProgramEntrySearchResults`		the program entry search results
Errors	NULL_ARGUMENT		`programEntryQuery` or `programEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programEntryQuery` or `ProgramEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryQueryFromInspector
Description	Gets a program entry query from an inspector. The inspector is available from a `ProgramEntrySearchResults.`
Parameters	`osid.course.chronicle.ProgramEntryQueryInspector`	`programEntryQueryInspector`	a program entry query inspector
Return	`osid.course.chronicle.ProgramEntryQuery`		the program entry query
Errors	NULL_ARGUMENT		`programEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`programEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.