NAME

Kernel::WebApp::Util::DocumentSearch – Helper class for the document search functionality.

PUBLIC INTERFACE

has Namespace

Contains the namespace for the type objects.

has TypeObjects

Contains the instantiated document search type objects, that potentially perform search queries, preparations and provide information for the handling inside business object widgets in the search result screen.

has DocumentSearchDriverList

Provides the list of available document search drivers.

has IndexSearchObject

Provides the index search object.

Search()

The /Search() method should return the documents based on the given query.

_EmptySearch()

Walks through all existing document types and creates empty result sets.

LookupBusinessObjectType()

Looks up the business object type based on a given document type.

    my $BusinessObjectType = $DocumentSearch->LookupBusinessObjectType( DocumentType => 'Appointment' );

DocumentSearchTypeResultFields()

The /DocumentSearchTypeResultFields() method returns the required fields for the different document search types or only for the given document search type.

DocumentSearchTypeMergeFixedLanguageFilter()

The /DocumentSearchTypeMergeFixedLanguageFilter() method should merge the given language filter to the given predefined filters if needed.

TransformDocumentData()

The /TransformDocumentData() method transforms the given document data for the frontend.

HasFixedLanguageFilter()

The /HasFixedLanguageFilter() method returns the information if the given document type has a fixed language filter.

ChildDocumentSearchTypes()

The /ChildDocumentSearchTypes() method returns the child document search type for the given document search type.

PRIVATE INTERFACE

_SortByToSort()

The /_SortByToSort() method that transform `SortBy` from business object into `Sort` for elastic.

_CombineDocumentSearchTypes()

The /_CombineDocumentSearchTypes() method combines document types.