inc/FBaseTypes.h

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