lms.lib.courseware_search package

lms.lib.courseware_search package#

Submodules#

lms.lib.courseware_search.lms_filter_generator module#

This file contains implementation override of SearchFilterGenerator which will allow

  • Filter by all courses in which the user is enrolled in

class lms.lib.courseware_search.lms_filter_generator.LmsSearchFilterGenerator#

Bases: SearchFilterGenerator

SearchFilterGenerator for LMS Search

exclude_dictionary(**kwargs)#

Exclude any courses defined outside the current org.

field_dictionary(**kwargs)#

add course if provided otherwise add courses in which the user is enrolled in

lms.lib.courseware_search.lms_result_processor module#

This file contains implementation override of SearchResultProcessor which will allow

  • Blends in “location” property

  • Confirms user access to object

class lms.lib.courseware_search.lms_result_processor.LmsSearchResultProcessor(dictionary, match_phrase)#

Bases: SearchResultProcessor

SearchResultProcessor for LMS Search

get_course_blocks(user)#

fetch cached blocks for course - retain for subsequent use

get_course_key()#

fetch course key object from string representation - retain result for subsequent uses

get_module_store()#

module store accessor - retain result for subsequent uses

get_usage_key()#

fetch usage key for component from string representation - retain result for subsequent uses

should_remove(user)#

Test to see if this result should be removed due to access restriction

property url#

Property to display the url for the given location, useful for allowing navigation

lms.lib.courseware_search.lms_search_initializer module#

This file contains implementation override of SearchInitializer which will allow

  • To set initial set of masquerades and other parameters

class lms.lib.courseware_search.lms_search_initializer.LmsSearchInitializer#

Bases: SearchInitializer

SearchInitializer for LMS Search

initialize(**kwargs)#

empty base implementation