OSID - osid.course.registration.RegistrationTargetQuerySession Service Interface Definition

Interface	osid.course.registration.RegistrationTargetQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.course.registration.RegistrationTargetSearchSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for searching among `RegistrationTargets` . The search query is constructed using the `RegistrationTargetQuery` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include registration targets in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to registration targets in this course catalog Registration Targets may have a query record indicated by their respective record types. The query record is accessed via the `RegistrationTargetQuery` .
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	canSearchRegistrationTargets
Description	Tests if this user can perform `RegistrationT` arget lookups. 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 not offer lookup 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 registration targets in 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 searches to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRegistrationTargetQuery
Description	Gets a registration target query.
Return	`osid.course.registration.RegistrationTargetQuery`		the registration target query
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetsByQuery
Description	Gets a list of `RegistrationTargets` matching the given search.
Parameters	`osid.course.registration.RegistrationTargetQuery`	`registrationTargetQuery`	the registration target query
Return	`osid.course.registration.RegistrationTargetList`		the returned `RegistrationTargetList`
Errors	NULL_ARGUMENT		`registrationTargetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`registrationTargetQuery` did not originate from `getRegistrationTargetQuery()`
Compliance	`mandatory`		This method must be implemented.