OSID - osid.course.syllabus.DocetQuerySession Service Interface Definition

Interface	osid.course.syllabus.DocetQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.syllabus.DocetSearchSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session provides methods for searching `Docets`. The search query is constructed using the `DocetQuery`. The docet record `Type` also specifies the record for the docet query. Docetsmay have a query record indicated by their respective record types. The query record is accessed via the `DocetQuery`. The returns in this session may not be cast directly to these interfaces.
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	canSearchDocets
Description	Tests if this user can perform `Docet` 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 docetsin course catalogs 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 retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDocetQuery
Description	Gets a docet query.
Return	`osid.course.syllabus.DocetQuery`		the docet query
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsByQuery
Description	Gets a list of `Docets` matching the given search.
Parameters	`osid.course.syllabus.DocetQuery`	`docetQuery`	the docet query
Return	`osid.course.syllabus.DocetList`		the returned `DocetList`
Errors	NULL_ARGUMENT		`docetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`docetQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.