gnucash/src/business/business-core/gncOrderP.h

/********************************************************************\
 * gncOrderP.h -- the Core Busines Order Interface                  *
 *                                                                  *
 * 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       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

/*
 * Copyright (C) 2001 Derek Atkins
 * Copyright (C) 2003 Linas Vepstas <linas@linas.org>
 * Author: Derek Atkins <warlord@MIT.EDU>
 */

#ifndef GNC_ORDERP_H_
#define GNC_ORDERP_H_

#include "gncOrder.h"

gboolean gncOrderRegister (void);
gint64 gncOrderNextID (QofBook *book);

/** The gncCloneOrder() routine makes a copy of the indicated
 *  order, placing it in the indicated book.  It copies
 *  the id, notes, reference, etc.
 *  It then adds a pair of 'gemini' kvp pointers so that each copy
 *  can be found from the other.
 */

GncOrder * gncCloneOrder (GncOrder *from, QofBook *);

/** The gncOrderObtainTwin() will find the 'twin' of the
 *  indicated order in the indicated book.  If the twin doesn't
 *  yet exist in the book, it will be created (by calling
 *  gncCloneOrder()) and placed into the book.
 *
 * We called this routine 'Obtain' instead of "Get" to distinguish
 * it from the other Get routines, which work in fundamentally  
 * different ways.
 */
GncOrder * gncOrderObtainTwin (GncOrder *from, QofBook *book);

#define gncOrderSetGUID(O,G) qof_entity_set_guid(QOF_ENTITY(O),(G))

#endif /* GNC_ORDERP_H_ */