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

Interface	osid.course.program.CredentialSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CredentialQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Credentials`. The credentials may be sequenced using the `CredentialSearchOrder` from this session. This `CourseCatalog` has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a `CredentialQueryInspector`. The query may be modified by converting the inspector back to a `CredentialQuery`.
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	canManageSmartCourseCatalogs
Description	Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart course catalog management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQuery
Description	Gets a credential query.
Return	`osid.course.program.CredentialQuery`		the credential query
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialSearchOrder
Description	Gets a credential search order.
Return	`osid.course.program.CredentialSearchOrder`		the credential search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCredentialQuery
Description	Applies a credential query to this course catalog.
Parameters	`osid.course.program.CredentialQuery`	`credentialQuery`	the credential query
Errors	NULL_ARGUMENT		`credentialQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`credentialQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCredentialQuery
Description	Gets a credential query inspector for this course catalog.
Return	`osid.course.program.CredentialQueryInspector`		the credential query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCredentialSequencing
Description	Applies a credential search order to this course catalog.
Parameters	`osid.course.program.CredentialSearchOrder`	`credentialSearchOrder`	the credential search order
Errors	NULL_ARGUMENT		`credentialSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`credentialSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQueryFromInspector
Description	Gets a credential query from an inspector.
Parameters	`osid.course.program.CredentialQueryInspector`	`credentialQueryInspector`	a query inspector
Return	`osid.course.program.CredentialQuery`		the credential query
Errors	NULL_ARGUMENT		`credentialQueryInspector` is `null`
Errors	UNSUPPORTED		`credentialQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.