Fix batch remove API

[platform/core/api/media-content.git] / include / media_filter.h

diff --git a/include/media_filter.h b/include/media_filter.h
index 41777dd..3e5f580 100755 (executable)
--- a/include/media_filter.h
+++ b/include/media_filter.h
@@ -44,19 +44,18 @@ extern "C" {
  * @details This function creates a media filter handle. The handle can be
  *          used to get the filtered information based on filter properties i.e. offset, count, condition for searching and order.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release the @a filter handle using media_info_filter_destroy().
  *
  * @param[out] filter A handle to the media filter
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_destroy()
  */
@@ -68,16 +67,15 @@ int media_filter_create(filter_h *filter);
  *          handle no longer can be used to perform any operation. A new filter handle
  *          has to be created before the next usage.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] filter The handle to the media filter
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  */
@@ -88,18 +86,17 @@ int media_filter_destroy(filter_h filter);
  * @details This function sets the @a offset and @a count for the given filter used to limit number of items returned.
  *          For example, if you set the @a offset as @c 10 and @a count as @c 5, then only searched data from @c 10 to @c 14 will be returned when the filter is used with foreach functions.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] filter The handle to the media filter
  * @param[in] offset The start position of the given filter (Starting from zero)
  * @param[in] count  The number of items to be searched with respect to the offset
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -108,19 +105,18 @@ int media_filter_set_offset(filter_h filter, int offset, int count);
 
 /**
  * @brief Sets the @a condition for the given @a filter.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] filter       The handle to the media filter
  * @param[in] condition    The condition which is used WHERE clause on a query
  * @param[in] collate_type The collate type for comparing two strings
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -129,19 +125,18 @@ int media_filter_set_condition(filter_h filter, const char *condition, media_con
 
 /**
  * @brief Sets the media filter content @a order and order keyword i.e. either descending or ascending.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] filter        The handle to the media filter
  * @param[in] order_type    The search order type
  * @param[in] order_keyword The search order keyword
  * @param[in] collate_type  The collate type for comparing two strings
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -150,7 +145,9 @@ int media_filter_set_order(filter_h filter, media_content_order_e order_type, co
 
 /**
  * @brief Sets the @a storage id for the given @a filter.
- * @since_tizen 2.4
+ * @details You can use this API when you want to search items only in the specific storage
+ *
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] filter       The handle to the media filter
  * @param[in] storage_id    The storage_id for browsing or searching
@@ -161,7 +158,6 @@ int media_filter_set_order(filter_h filter, media_content_order_e order_type, co
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -170,7 +166,7 @@ int media_filter_set_storage(filter_h filter, const char *storage_id);
 
 /**
  * @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  filter The handle to the media filter
  * @param[out] offset The start position of the given filter (Starting from zero)
@@ -181,7 +177,6 @@ int media_filter_set_storage(filter_h filter, const char *storage_id);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -190,7 +185,7 @@ int media_filter_get_offset(filter_h filter, int *offset, int *count);
 
 /**
  * @brief Gets the @a condition for the given @a filter.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a condition using free().
  *
@@ -198,13 +193,12 @@ int media_filter_get_offset(filter_h filter, int *offset, int *count);
  * @param[out] condition    The condition which is used WHERE clause on a query
  * @param[out] collate_type The collate type for comparing two strings
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -213,7 +207,7 @@ int media_filter_get_condition(filter_h filter, char **condition, media_content_
 
 /**
  * @brief Gets the media filter's content @a order and order keyword i.e. either descending or ascending.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a order_keyword using free().
  *
@@ -222,12 +216,11 @@ int media_filter_get_condition(filter_h filter, char **condition, media_content_
  * @param[out] order_keyword The search order keyword
  * @param[out] collate_type  The collate type for comparing two strings
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()
@@ -236,7 +229,7 @@ int media_filter_get_order(filter_h filter, media_content_order_e* order_type, c
 
 /**
  * @brief Get the @a storage id for given @a filter.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_id using free().
  *
@@ -244,11 +237,10 @@ int media_filter_get_order(filter_h filter, media_content_order_e* order_type, c
  * @param[out] storage_id The storage_id which is used in filter
  *
  * @return @c 0 on success,
- *             otherwise a negative error value
+ *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @see media_filter_create()
  * @see media_filter_destroy()