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

Interface	osid.course.program.ProgramQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.program.ProgramSearchSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session provides methods for searching among `Programs`. The search query is constructed using the `ProgramQuery`. 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 programs 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	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchPrograms
Description	Tests if this user can perform `Program` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include programs in course catalog which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getProgramQuery
Description	Gets a program query.
Return	`osid.course.program.ProgramQuery`		the program query
Compliance	`mandatory`		This method must be implemented.
Method	getProgramsByQuery
Description	Gets a list of `Programs` matching the given program query.
Parameters	`osid.course.program.ProgramQuery`	`programQuery`	the program query
Return	`osid.course.program.ProgramList`		the returned `ProgramList`
Errors	NULL_ARGUMENT		`programQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.