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

Interface	osid.course.syllabus.ModuleLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving modules. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated course catalog view: All module methods in this session operate, retrieve and pertain to modules defined explicitly in the current course catalog. Using an isolated view is useful for managing modules with the `ModuleAdminSession.` federated course catalog view: All module lookup methods in this session operate, retrieve and pertain to all modules defined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence. active module view: active modules are returned from methods in this session any status module view: active and inactive modules are returned from methods in this session The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupModules
Description	Tests if this user can lookup modules. 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 these operations.
Return	`boolean`		`false` if module lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeModuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryModuleView
Description	A complete view of the `Module` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include modules 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 retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveModuleView
Description	Only active modules are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusModuleView
Description	Borth active and inactive modules are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getModule
Description	Gets the `Module` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Module` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Module` and retained for compatibility. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of the `Module` to retrieve
Return	`osid.course.syllabus.Module`		the returned `Module`
Errors	NOT_FOUND		no `Module` found with the given `Id`
	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesByIds
Description	Gets a `ModuleList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the modules specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible modules may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.id.IdList`	`moduleIds`	the list of `Ids` to retrieve
Return	`osid.course.syllabus.ModuleList`		the returned `Module list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`moduleIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesByGenusType
Description	Gets a `ModuleList` corresponding to the given module genus `Type` which does not include modules of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.type.Type`	`moduleGenusType`	a module genus type
Return	`osid.course.syllabus.ModuleList`		the returned `Module` list
Errors	NULL_ARGUMENT		`moduleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesByParentGenusType
Description	Gets a `ModuleList` corresponding to the given module genus `Type` and include any additional modules with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.type.Type`	`moduleGenusType`	a module genus type
Return	`osid.course.syllabus.ModuleList`		the returned `Module` list
Errors	NULL_ARGUMENT		`moduleGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesByRecordType
Description	Gets a `ModuleList` containing the given module record `Type.` In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.type.Type`	`moduleRecordType`	a module record type
Return	`osid.course.syllabus.ModuleList`		the returned `Module` list
Errors	NULL_ARGUMENT		`moduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesByProvider
Description	Gets a `ModuleList` for the given provider. In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.syllabus.ModuleList`		the returned `Module` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModulesForSyllabus
Description	Gets a `ModuleList` for the given syllabus `Id.` In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
Return	`osid.course.syllabus.ModuleList`		the returned `Module` list
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getModules
Description	Gets all modules. In plenary mode, the returned list contains all known modules or an error results. Otherwise, the returned list may contain only those modules that are accessible through this session. In active mode, modeules are returned that are currently active. In any status mode, active and inactive modules are returned.
Return	`osid.course.syllabus.ModuleList`		a list of modules
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.