inc/FBaseTypes.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FBaseTypes.h
  19  * @brief               This is the header file for the built-in data types.
  20  *
  21  * This header file contains the declarations of the commonly used built-in data types.
  22  *
  23  */
  24 #ifndef _FBASE_TYPES_H_
  25 #define _FBASE_TYPES_H_
  26
  27 #include <FBaseLog.h>
  28 #include <FBaseDataType.h>
  29
  30
  31 namespace Tizen { namespace Base
  32 {
  33
  34 /**
  35  *      @enum   SortOrder
  36  *
  37  *      Defines the order of sorting.
  38  *
  39  *      @since 2.0
  40  */
  41 enum SortOrder
  42 {
  43         SORT_ORDER_ASCENDING = 0,   /**< A constant for sorting the results in ascending order */
  44         SORT_ORDER_DESCENDING,      /**< A constant for sorting the results in descending order */
  45         SORT_ORDER_NONE             /**< A constant for indicating the results are not sorted */
  46 };
  47
  48
  49 /**
  50  *      @enum   StringMatchCriteria
  51  *
  52  *      Defines the matching criteria for strings.
  53  *
  54  *      @since 2.0
  55  */
  56 enum StringMatchCriteria
  57 {
  58         STRING_MATCH_CRITERIA_EXACT = 0,    /**< A constant for matching the strings exactly */
  59         STRING_MATCH_CRITERIA_START_WITH,   /**< A constant for matching the strings starting with the specified characters */
  60         STRING_MATCH_CRITERIA_CONTAIN,      /**< A constant for matching the strings partially */
  61         STRING_MATCH_CRITERIA_WILDCARD      /**< A constant for matching the strings supporting the wildcard characters */
  62 };
  63
  64
  65 /**
  66  * @enum ComparisonOperator
  67  *
  68  * Defines a set of comparison operators whose semantics follow the SQL standards by default,
  69  * but can be overridden by each API that uses this type, depending on the semantics and intention of the API.
  70  *
  71  * @since 2.0
  72  */
  73 enum ComparisonOperator
  74 {
  75         COMPARISON_OP_EQUAL = 0,                /**< A comparison operator that checks the value equality */
  76         COMPARISON_OP_NOT_EQUAL,                /**< A comparison operator that checks the value inequality */
  77         COMPARISON_OP_GREATER_THAN,             /**< A comparison operator that checks whether a value is greater than the other */
  78         COMPARISON_OP_LESS_THAN,                /**< A comparison operator that checks whether a value is less than the other */
  79         COMPARISON_OP_GREATER_THAN_EQUAL_TO,    /**< A comparison operator that checks whether a value is greater than or equal to the other */
  80         COMPARISON_OP_LESS_THAN_EQUAL_TO,       /**< A comparison operator that checks whether a value is less than or equal to the other */
  81         COMPARISON_OP_LIKE,                     /**< A comparison operator that checks whether a value is like the other, where the exact matching condition may vary depending on the definition of each specific API */
  82         COMPARISON_OP_IS_NULL,                  /**< A comparison operator that returns @c true when a value does not exist for the given operand */
  83         COMPARISON_OP_IS_NOT_NULL               /**< A comparison operator that returns @c true when a value exists for the given operand */
  84 };
  85
  86 }} // Tizen::Base
  87
  88 #endif // _FBASE_TYPES_H_