NAME

Kernel::WebApp::Util::DocumentSearch::Attachment – Wrapper for document search types supporting attachments.

has TicketObject

Attribute that holds the ticket object.

has TicketHook

Attribute that holds the ticket hook.

has ChildDocumentSearchTypes

The /ChildDocumentSearchTypes() attribute holds the child document search types.

BusinessObjectType()

The /BusinessObjectType() which the module belongs to.

ResultFields()

The /ResultFields() method should return the required fields for the different document search types.

Search()

Performs a search on all indices that support attachments. The search will be executed just on the attachment related fields, so are the result fields.

Returns:

    {
        Attachment => => {
            SearchAfter => [ '4.0277452', undef ],
            Label       => 'Articles (MIME)',
            TotalHits   => 17,
            Hits        => 7,
            Documents   => [
                {
                    'ArticleID'     => 123,
                    'DocumentID'    => 123,
                    'DocumentTitle' => 'MIME Title',
                    'DocumentType'  => 'ArticleMIME',
                    'Score'         => '4.0277452',
                    'Subject'       => 'First MIME subject',
                    'TicketID'      => 123,
                    'TicketNumber'  => '2019042354000037',
                    'Highlight'     => {
                        'Subject' => ['First MIME subject <em>text</em>!']
                    },
                },
            ]
        },
    }

TransformDocumentData()

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

ChildDocumentSearchTypes()

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

PRIVATE INTERFACE

_BuildConfigObject()

The /_BuildConfigObject() method retrieves the config object.

_BuildTicketObject()

The /_BuildTicketObject() method retrieves the ticket object.

_BuildTicketHook()

The /_BuildTicketHook() method constructs the ticket hook.

_BuildChildDocumentSearchTypes()

The /_BuildChildDocumentSearchTypes() method gets child document search types.