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

Interface	osid.course.chronicle.CredentialEntrySmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CredentialEntryQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `CredentialEntries` . The courses may be sequenced using the `CredentialEntrySearchOrder` 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 `CredentialEntryQueryInspector` . The query may be modified by converting the inspector back to a `CredentialEntryQuery` .
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	getCredentialEntryQuery
Description	Gets a credential entry query.
Return	`osid.course.chronicle.CredentialEntryQuery`		the credential entry query
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntrySearchOrder
Description	Gets a credential entry search order.
Return	`osid.course.chronicle.CredentialEntrySearchOrder`		the credential entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCredentialEntryQuery
Description	Applies a credential entry query to this course catalog.
Parameters	`osid.course.chronicle.CredentialEntryQuery`	`credentialEntryQuery`	the credential entry query
Errors	NULL_ARGUMENT		`credentialEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`credentialEntryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCredentialEntryQuery
Description	Gets a credential entry query inspector for this course catalog.
Return	`osid.course.chronicle.CredentialEntryQueryInspector`		the credential entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCredentialEntrySequencing
Description	Applies a credential entry search order to this course catalog.
Parameters	`osid.course.chronicle.CredentialEntrySearchOrder`	`credentialEntrySearchOrder`	the credential entry search order
Errors	NULL_ARGUMENT		`credentialEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`credentialEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryQueryFromInspector
Description	Gets a credential entry query from an inspector.
Parameters	`osid.course.chronicle.CredentialEntryQueryInspector`	`credentialEntryQueryInspector`	a query inspector
Return	`osid.course.chronicle.CredentialEntryQuery`		the credential entry query
Errors	NULL_ARGUMENT		`credentialEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`credentialEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.