#############
SearchProfile
#############


****
NAME
****


Kernel::System::SearchProfile - module to manage search profiles


***********
DESCRIPTION
***********


module with all functions to manage search profiles


****************
PUBLIC INTERFACE
****************


new()
=====


Don't use the constructor directly, use the ObjectManager instead:


.. code-block:: perl

     my $SearchProfileObject = $Kernel::OM->Get('Kernel::System::SearchProfile');



SearchProfileAdd()
==================


to add a search profile item


.. code-block:: perl

     $SearchProfileObject->SearchProfileAdd(
         Base      => 'TicketSearch',
         Name      => 'last-search',
         Key       => 'Body',
         Value     => $String,    # SCALAR|ARRAYREF
         UserLogin => 123,
     );



SearchProfileGet()
==================


returns hash with search profile.


.. code-block:: perl

     my %SearchProfileData = $SearchProfileObject->SearchProfileGet(
         Base      => 'TicketSearch',
         Name      => 'last-search',
         UserLogin => 'me',
     );



SearchProfileDelete()
=====================


deletes a search profile.


.. code-block:: perl

     $SearchProfileObject->SearchProfileDelete(
         Base      => 'TicketSearch',
         Name      => 'last-search',
         UserLogin => 'me',
     );



SearchProfileList()
===================


returns a hash of all profiles for the given user.


.. code-block:: perl

     my %SearchProfiles = $SearchProfileObject->SearchProfileList(
         Base      => 'TicketSearch',
         UserLogin => 'me',
     );



SearchProfileUpdateUserLogin()
==============================


changes the UserLogin of SearchProfiles


.. code-block:: perl

     my $Result = $SearchProfileObject->SearchProfileUpdateUserLogin(
         Base         => 'TicketSearch',
         UserLogin    => 'me',
         NewUserLogin => 'newme',
     );