include/anna/ldap/Scope.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_ldap_Scope_hpp
  38 #define anna_ldap_Scope_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41 #include <anna/config/defines.hpp>
  42 #include <anna/core/define.autoenum.hpp>
  43
  44 namespace anna {
  45
  46 namespace ldap {
  47
  48 /**
  49    Modela los ambitos de busqueda usados en las consultas LDAP.
  50
  51    \see ldap::Search
  52 */
  53 struct Scope {
  54   enum _v {
  55     None = -1, /**< Requerido por la declaracion automática */
  56     Base, /**< Busca solo en el nivel indicado por el DN. */
  57     OneLevel, /**< Busca en el nivel indicado por el DN y sus dependencias inmediatas */
  58     SubTree  /**< Busca en el nivel indicador por el DN y todas sus dependencias */
  59   };
  60
  61   anna_declare_enum(ldap::Scope);
  62
  63   /**
  64      Devuelve una cadena que identifica el tipo de ambito.
  65      \param v Codigo de ambito a traducir.
  66      \return Una cadena que identifica el tipo de ambito.
  67   */
  68   static const char* asText(const Scope::_v v) throw(RuntimeException) {
  69     return asCString(v);
  70   }
  71 };
  72
  73 }
  74 }
  75
  76 #endif
  77