qofquery.h

Go to the documentation of this file.

/********************************************************************\
 * qofquery.h -- find objects that match a certain expression.      *
 *                                                                  *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef QOF_QUERYNEW_H
#define QOF_QUERYNEW_H

#include "guid.h"
#include "qofbook.h"
#include "qofquerycore.h"
#include "qofchoice.h"

#define QOF_MOD_QUERY "qof.query"

typedef struct _QofQuery QofQuery;

typedef enum
{
    QOF_QUERY_AND = 1,
    QOF_QUERY_OR,
    QOF_QUERY_NAND,
    QOF_QUERY_NOR,
    QOF_QUERY_XOR
} QofQueryOp;

#define QOF_QUERY_FIRST_TERM QOF_QUERY_AND

#define QUERY_DEFAULT_SORT      "QofQueryDefaultSort"

#define QOF_PARAM_BOOK    "book"
#define QOF_PARAM_GUID    "guid"

#define QOF_PARAM_KVP     "kvp"
#define QOF_PARAM_ACTIVE  "active"
#define QOF_PARAM_VERSION "version"

/* --------------------------------------------------------- */
// @{
void qof_query_init (void);
void qof_query_shutdown (void);
// @}

/* --------------------------------------------------------- */
// @{

QofQueryParamList * qof_query_build_param_list (char const *param, ...);

QofQuery * qof_query_create (void);
QofQuery * qof_query_create_for (QofIdTypeConst obj_type);

void qof_query_destroy (QofQuery *q);

void qof_query_search_for (QofQuery *query, QofIdTypeConst obj_type);

void qof_query_set_book (QofQuery *q, QofBook *book);


void qof_query_add_term (QofQuery *query, QofQueryParamList *param_list,
                         QofQueryPredData *pred_data, QofQueryOp op);

void qof_query_add_guid_match (QofQuery *q, QofQueryParamList *param_list,
                               const GncGUID *guid, QofQueryOp op);
void qof_query_add_guid_list_match (QofQuery *q, QofQueryParamList *param_list,
                                    GList *guid_list, QofGuidMatch options,
                                    QofQueryOp op);

void qof_query_add_boolean_match (QofQuery *q,
                                  QofQueryParamList *param_list,
                                  gboolean value,
                                  QofQueryOp op);

GList * qof_query_run (QofQuery *query);

GList * qof_query_last_run (QofQuery *query);

GList * qof_query_run_subquery (QofQuery *subquery,
                                const QofQuery* primary_query);

void qof_query_clear (QofQuery *query);

void qof_query_purge_terms (QofQuery *q, QofQueryParamList *param_list);

int qof_query_has_terms (QofQuery *q);

int qof_query_num_terms (QofQuery *q);

gboolean qof_query_has_term_type (QofQuery *q, QofQueryParamList *term_param);
GSList * qof_query_get_term_type (QofQuery *q, QofQueryParamList *term_param);

QofQuery * qof_query_copy (QofQuery *q);

QofQuery * qof_query_invert(QofQuery *q);

QofQuery * qof_query_merge(QofQuery *q1, QofQuery *q2, QofQueryOp op);

void qof_query_merge_in_place(QofQuery *q1, QofQuery *q2, QofQueryOp op);

void qof_query_set_sort_order (QofQuery *q,
                               QofQueryParamList *primary_sort_params,
                               QofQueryParamList *secondary_sort_params,
                               QofQueryParamList *tertiary_sort_params);

void qof_query_set_sort_options (QofQuery *q, gint prim_op, gint sec_op,
                                 gint tert_op);

void qof_query_set_sort_increasing (QofQuery *q, gboolean prim_inc,
                                    gboolean sec_inc, gboolean tert_inc);


void qof_query_set_max_results (QofQuery *q, int n);

gboolean qof_query_equal (const QofQuery *q1, const QofQuery *q2);

void qof_query_print (QofQuery *query);

/*@ dependent @*/
QofIdType qof_query_get_search_for (const QofQuery *q);

GList * qof_query_get_books (QofQuery *q);

// @}
/* @} */
#endif /* QOF_QUERYNEW_H */