NAME

       Octopussy::Search_Template - Octopussy Search Template module

FUNCTIONS

   New($user, \%conf)
       Create a new Search Template

       Parameters:

       $user - user who create this template \%conf - hashref of the new Search Template configuration

   Remove($user, $search_tpl)
       Remove the Search Template '$search_tpl'

       Parameters:

       $user - user who created this template $search_tpl - Name of the Search Template to remove

   List($user)
       Get list of Search Templates

       Parameters:

       $user - user who created this template

       Returns:

       @tpls - Array of Search Templates names

   List_Any_User($sort)
       Get template name / user List

       Parameters:

       $sort - selected field to sort List (default: 'name')

       Returns:

       @sorted_list - Array of Search Templates names for all users

   Filename($user, $search_tpl)
       Get the XML filename for the Search Template '$search_tpl'

       Parameters:

       $user - user who created this template $search_tpl - Name of the Search Template

       Returns:

       $filename - Filename of the XML file for Search Template '$search_tpl'

   Configuration($user, $search_tpl)
       Get the configuration for the Search Template '$search_tpl'

       Parameters:

       $user - user who created this template $search_tpl - Name of the Search Template

       Returns:

       \%conf - Hashref of the Search Template configuration

   Configurations($user, $sort)
       Get the configuration for all Search Templates from User $user

       Parameters:

       $user - user who created this template $sort - selected field to sort configurations

       Returns:

       @configurations - Array of Hashref Search Template configurations

   Valid_Name($name)
       Checks that '$name' is valid for a Search Template name

AUTHOR

       Sebastien Thebert <octo.devel@gmail.com>

perl v5.14.2                                       2012-06-24                      Octopussy::Search_Template(3)