<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libgdamm: Gnome::Gda::ServerOperation Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgdamm  <span id="projectnumber">4.99.6</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1-20110925 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGnome.html">Gnome</a> </li> <li class="navelem"><a class="el" href="namespaceGnome_1_1Gda.html">Gda</a> </li> <li class="navelem"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html">ServerOperation</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#related">Related Functions</a> </div> <div class="headertitle"> <div class="title">Gnome::Gda::ServerOperation Class Reference<div class="ingroups"><a class="el" href="group__DDL.html">Data definition (DDL) queries</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Gnome::Gda::ServerOperation" --><!-- doxytag: inherits="Glib::Object" --> <p>Handles any DDL query in an abstract way. <a href="classGnome_1_1Gda_1_1ServerOperation.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for Gnome::Gda::ServerOperation:</div> <div class="dyncontent"> <div class="center"><img src="classGnome_1_1Gda_1_1ServerOperation__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1ServerOperation_inherit__map" alt="Inheritance graph"/></div> <map name="Gnome_1_1Gda_1_1ServerOperation_inherit__map" id="Gnome_1_1Gda_1_1ServerOperation_inherit__map"> <area shape="rect" id="node2" /></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for Gnome::Gda::ServerOperation:</div> <div class="dyncontent"> <div class="center"><img src="classGnome_1_1Gda_1_1ServerOperation__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1ServerOperation_coll__map" alt="Collaboration graph"/></div> <map name="Gnome_1_1Gda_1_1ServerOperation_coll__map" id="Gnome_1_1Gda_1_1ServerOperation_coll__map"> <area shape="rect" id="node2" /></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGnome_1_1Gda_1_1ServerOperation-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#ad58648702a14ab2982ba3dd8e4dc0f30">~ServerOperation</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GdaServerOperation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#ae8b506e01473d1b650456879bf230576">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ae8b506e01473d1b650456879bf230576"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GdaServerOperation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#ad9b38f2fdb547b6f328c0a9577de24d4">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ad9b38f2fdb547b6f328c0a9577de24d4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GdaServerOperation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#af4ffc5075f0d8dffe695afdb41edc93c">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#af4ffc5075f0d8dffe695afdb41edc93c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#ab5f57db262a665c4c89a03723a5297f1">perform_drop_database</a> (const <a class="elRef" >Glib::ustring</a>& provider)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#acf66e32ac33618c88f766aec9c4808b9">perform_create_database</a> (const <a class="elRef" >Glib::ustring</a>& provider)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a0caea3884c97e02ca001f836da6ee49b">get_value_at</a> (const <a class="elRef" >Glib::ustring</a>& path_format) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value for the node at the path formed using <em>path_format</em> and ... <a href="#a0caea3884c97e02ca001f836da6ee49b"></a><br/></td></tr> <tr><td class="memTemplParams" colspan="2">template<class ValueType > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a8bddd180b7d438e451274e66ea9c1450">set_value_at</a> (const <a class="elRef" >value</a>)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a021ef8766dc4da2929dbb206846a40a2">set_value_at_as_value</a> (const <a class="elRef" >value</a>)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libgdammEnums.html#ga3b421ad2be1e30fe7151a2b07c7364a5">ServerOperationNodeType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a07a8d43f68d52b86eb2ba2c7c64e281b">get_node_type</a> (const <a class="elRef" >ServerOperationNodeStatus</a>& status) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to get the type of a node. <a href="#a07a8d43f68d52b86eb2ba2c7c64e281b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#ae9c8cb023b0aa970e724ed8a65393238">get_sequence_size</a> (const <a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a842246e4196cf89d66e7ad9a4dc5b874">get_sequence_max_size</a> (const <a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a339aa3b54a5e1d75a2a0ed603a027995">get_sequence_min_size</a> (const <a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the contents of a sequence. <a href="#af5eb84fbfcbe762f7b8a95cf7bab8ea6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >std::string</a>& path) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a26776816758b83557f92921fb7fa53b2">is_valid</a> (const <a class="elRef" >std::string</a>& xml_file) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Tells if all the required values in <em>op</em> have been defined. <a href="#a26776816758b83557f92921fb7fa53b2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#aff203cdb9f543ef47c8887614535173b">load_data_from_xml</a> (xmlNodePtr node)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the contents of <em>node</em> into <em>op</em>. <a href="#aff203cdb9f543ef47c8887614535173b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a91670f857780470427dad44d438a3462">save_data_to_xml</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last part of <em>path</em>. <a href="#a48f9f7efcc7964da8cfafa445e512045"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >Glib::ustring</a>& path) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the complete path to the parent of the node defined by <em>path</em>. <a href="#a5302ecc565ab3f0047e24996135c7747"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libgdammEnums.html#ga0837bde71f4fee1ea3f06a0c22a04d68">ServerOperationType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a581002a6383db2dd09ac686e42c073f4">get_op_type</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of operation <em>op</em> is for. <a href="#a581002a6383db2dd09ac686e42c073f4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a8de5040c7b330f78b1519eab22c579aa">del_item_from_sequence</a> (const <a class="elRef" >std::string</a>& item_path)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a2517ba9aa5c9738c7f506749f3c0e577">add_item_to_sequence</a> (const <a class="elRef" >std::string</a>& item_path)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >get_root_nodes</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get an array of strings containing the paths of nodes situated at the root of <em>op</em>. <a href="#a4502f9a48417ad9d211e47901cff5840"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> <a class="elRef" >signal_signal_sequence_item_added</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> <a class="elRef" >signal_signal_sequence_item_remove</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> < <a class="elRef" >property_connection</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classGnome_1_1Gda_1_1Connection.html" title="Manages a connection to a data source.">Connection</a> to use. <a href="#a13e2cd70de6627d85350331a096e03ab"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> < gint > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a374cba8af2ab4c187598966dc7c45925">property_op_type</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Type of operation to be done. <a href="#a374cba8af2ab4c187598966dc7c45925"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" /> < <a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html">ServerOperation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a541e46af5603ee55ff1431cefc284021">prepare_create_database</a> (const <a class="elRef" >Glib::ustring</a>& db_name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" /> < <a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html">ServerOperation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a421d49b758c906e9a58ce97b67f9f0a1">prepare_drop_database</a> (const <a class="elRef" >Glib::ustring</a>& db_name)</td></tr> <tr><td colspan="2"><h2><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> < <a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html">Gnome::Gda::ServerOperation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a70dabea139041b39325be33f226a4ffa">wrap</a> (GdaServerOperation* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" ></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Handles any DDL query in an abstract way. </p> <p>Basically this object is just a named data store: it can store named values, the values being organized hirarchically. A value can be read from its path (similar to a Unix file path) using the <a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a0caea3884c97e02ca001f836da6ee49b" title="Get the value for the node at the path formed using path_format and ...">get_value_at()</a> method. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad58648702a14ab2982ba3dd8e4dc0f30"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::~ServerOperation" ref="ad58648702a14ab2982ba3dd8e4dc0f30" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gnome::Gda::ServerOperation::~ServerOperation </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a2517ba9aa5c9738c7f506749f3c0e577"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::add_item_to_sequence" ref="a2517ba9aa5c9738c7f506749f3c0e577" args="(const std::string &item_path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">guint Gnome::Gda::ServerOperation::add_item_to_sequence </td> <td>(</td> <td class="paramtype">const <a class="elRef" >std::string</a> & </td> <td class="paramname"><em>item_path</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">seq_path</td><td>The path to the sequence to which an item must be added (like "/SEQ_NAME" for instance). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The index of the new entry in the sequence (like 5 for example if a 6th item has been added to the sequence. </dd></dl> </div> </div> <a class="anchor" id="a8de5040c7b330f78b1519eab22c579aa"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::del_item_from_sequence" ref="a8de5040c7b330f78b1519eab22c579aa" args="(const std::string &item_path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gnome::Gda::ServerOperation::del_item_from_sequence </td> <td>(</td> <td class="paramtype">const <a class="elRef" >std::string</a> & </td> <td class="paramname"><em>item_path</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">item_path</td><td>The path to the sequence's item to remove (like "/SEQ_NAME/5" for instance). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the specified node has been removed from the sequence. </dd></dl> </div> </div> <a class="anchor" id="a5302ecc565ab3f0047e24996135c7747"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_node_parent" ref="a5302ecc565ab3f0047e24996135c7747" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a> Gnome::Gda::ServerOperation::get_node_parent </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the complete path to the parent of the node defined by <em>path</em>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A new string or <code>0</code> if the node does not have any parent or does not exist. </dd></dl> </div> </div> <a class="anchor" id="a48f9f7efcc7964da8cfafa445e512045"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_node_path_portion" ref="a48f9f7efcc7964da8cfafa445e512045" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a> Gnome::Gda::ServerOperation::get_node_path_portion </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the last part of <em>path</em>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A new string, or <code>0</code> if an error occurred. </dd></dl> </div> </div> <a class="anchor" id="a07a8d43f68d52b86eb2ba2c7c64e281b"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_node_type" ref="a07a8d43f68d52b86eb2ba2c7c64e281b" args="(const Glib::ustring &path, ServerOperationNodeStatus &status) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__libgdammEnums.html#ga3b421ad2be1e30fe7151a2b07c7364a5">ServerOperationNodeType</a> Gnome::Gda::ServerOperation::get_node_type </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__libgdammEnums.html#ga83461a54f48e1f163e82ba1548deb20c">ServerOperationNodeStatus</a>& </td> <td class="paramname"><em>status</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Convenience function to get the type of a node. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a node (starting with "/"). </td></tr> <tr><td class="paramname">status</td><td>A place to store the status of the node, or <code>0</code>. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The type of node, or GDA_SERVER_OPERATION_NODE_UNKNOWN if the node was not found. </dd></dl> </div> </div> <a class="anchor" id="a581002a6383db2dd09ac686e42c073f4"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_op_type" ref="a581002a6383db2dd09ac686e42c073f4" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__libgdammEnums.html#ga0837bde71f4fee1ea3f06a0c22a04d68">ServerOperationType</a> Gnome::Gda::ServerOperation::get_op_type </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the type of operation <em>op</em> is for. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="group__libgdammEnums.html#ga0837bde71f4fee1ea3f06a0c22a04d68">Gda::ServerOperationType</a> enum. </dd></dl> </div> </div> <a class="anchor" id="a4502f9a48417ad9d211e47901cff5840"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_root_nodes" ref="a4502f9a48417ad9d211e47901cff5840" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a>> Gnome::Gda::ServerOperation::get_root_nodes </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get an array of strings containing the paths of nodes situated at the root of <em>op</em>. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A new array, which must be freed with Glib::strfreev(). </dd></dl> </div> </div> <a class="anchor" id="af5eb84fbfcbe762f7b8a95cf7bab8ea6"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_sequence_item_names" ref="af5eb84fbfcbe762f7b8a95cf7bab8ea6" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a>> Gnome::Gda::ServerOperation::get_sequence_item_names </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Fetch the contents of a sequence. </p> <p><em>path</em> can describe either a sequence (for example "/SEQNAME") or an item in a sequence (for example "/SEQNAME/3") </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a sequence node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A array of strings containing the complete paths of the nodes contained at <em>path</em> (free with Glib::strfreev()). </dd></dl> </div> </div> <a class="anchor" id="a842246e4196cf89d66e7ad9a4dc5b874"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_sequence_max_size" ref="a842246e4196cf89d66e7ad9a4dc5b874" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">guint Gnome::Gda::ServerOperation::get_sequence_max_size </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a sequence node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The maximum number of items in the sequence at <em>path</em>, or 0 if <em>path</em> is not a sequence node. </dd></dl> </div> </div> <a class="anchor" id="a339aa3b54a5e1d75a2a0ed603a027995"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_sequence_min_size" ref="a339aa3b54a5e1d75a2a0ed603a027995" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">guint Gnome::Gda::ServerOperation::get_sequence_min_size </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a sequence node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The minimum number of items in the sequence at <em>path</em>, or 0 if <em>path</em> is not a sequence node. </dd></dl> </div> </div> <a class="anchor" id="a9a26f248b64d1f2a96d4660f8ccdbd0c"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_sequence_name" ref="a9a26f248b64d1f2a96d4660f8ccdbd0c" args="(const std::string &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a> Gnome::Gda::ServerOperation::get_sequence_name </td> <td>(</td> <td class="paramtype">const <a class="elRef" >std::string</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a sequence node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The name of the sequence at <em>path</em>. </dd></dl> </div> </div> <a class="anchor" id="ae9c8cb023b0aa970e724ed8a65393238"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_sequence_size" ref="ae9c8cb023b0aa970e724ed8a65393238" args="(const Glib::ustring &path) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">guint Gnome::Gda::ServerOperation::get_sequence_size </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>A complete path to a sequence node (starting with "/"). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The number of items in the sequence at <em>path</em>, or 0 if <em>path</em> is not a sequence node. </dd></dl> </div> </div> <a class="anchor" id="a0caea3884c97e02ca001f836da6ee49b"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_value_at" ref="a0caea3884c97e02ca001f836da6ee49b" args="(const Glib::ustring &path_format) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a> Gnome::Gda::ServerOperation::get_value_at </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path_format</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the value for the node at the path formed using <em>path_format</em> and ... </p> <p>(the rules are the same as for Glib::strdup_printf()) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path_format</td><td>A complete path to a node (starting with "/"). </td></tr> <tr><td class="paramname">Varargs</td><td>Arguments to use with <em>path_format</em> to make a complete path. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A constant <a class="el" href="classGnome_1_1Gda_1_1Value.html" title="Use value_type() to identify the value type at runtime.">Value</a> if a value has been defined, or <code>0</code> if the value is undefined or if the <em>path</em> is not defined or <em>path</em> does not hold any value. </dd></dl> </div> </div> <a class="anchor" id="ae8b506e01473d1b650456879bf230576"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj" ref="ae8b506e01473d1b650456879bf230576" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GdaServerOperation* Gnome::Gda::ServerOperation::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="elRef" >Glib::ObjectBase</a>.</p> </div> </div> <a class="anchor" id="ad9b38f2fdb547b6f328c0a9577de24d4"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj" ref="ad9b38f2fdb547b6f328c0a9577de24d4" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GdaServerOperation* Gnome::Gda::ServerOperation::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="elRef" >Glib::ObjectBase</a>.</p> </div> </div> <a class="anchor" id="af4ffc5075f0d8dffe695afdb41edc93c"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj_copy" ref="af4ffc5075f0d8dffe695afdb41edc93c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GdaServerOperation* Gnome::Gda::ServerOperation::gobj_copy </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p> </div> </div> <a class="anchor" id="a26776816758b83557f92921fb7fa53b2"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::is_valid" ref="a26776816758b83557f92921fb7fa53b2" args="(const std::string &xml_file) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gnome::Gda::ServerOperation::is_valid </td> <td>(</td> <td class="paramtype">const <a class="elRef" >std::string</a> & </td> <td class="paramname"><em>xml_file</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Tells if all the required values in <em>op</em> have been defined. </p> <p>if <em>xml_file</em> is not <code>0</code>, the validity of <em>op</em> is tested against that specification, and not against the current <em>op's</em> specification. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">xml_file</td><td>An XML specification file (see new()). </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>op</em> is valid. </dd></dl> </div> </div> <a class="anchor" id="aff203cdb9f543ef47c8887614535173b"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::load_data_from_xml" ref="aff203cdb9f543ef47c8887614535173b" args="(xmlNodePtr node)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gnome::Gda::ServerOperation::load_data_from_xml </td> <td>(</td> <td class="paramtype">xmlNodePtr </td> <td class="paramname"><em>node</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Loads the contents of <em>node</em> into <em>op</em>. </p> <p>The XML tree passed through the <em>node</em> argument must correspond to an XML tree saved using <a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#a91670f857780470427dad44d438a3462">save_data_to_xml()</a>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">node</td><td>A #xmlNodePtr. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl> </div> </div> <a class="anchor" id="acf66e32ac33618c88f766aec9c4808b9"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::perform_create_database" ref="acf66e32ac33618c88f766aec9c4808b9" args="(const Glib::ustring &provider)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gnome::Gda::ServerOperation::perform_create_database </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>provider</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab5f57db262a665c4c89a03723a5297f1"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::perform_drop_database" ref="ab5f57db262a665c4c89a03723a5297f1" args="(const Glib::ustring &provider)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gnome::Gda::ServerOperation::perform_drop_database </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>provider</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a541e46af5603ee55ff1431cefc284021"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::prepare_create_database" ref="a541e46af5603ee55ff1431cefc284021" args="(const Glib::ustring &provider, const Glib::ustring &db_name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" >ServerOperation</a>> Gnome::Gda::ServerOperation::prepare_create_database </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>provider</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>db_name</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a421d49b758c906e9a58ce97b67f9f0a1"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::prepare_drop_database" ref="a421d49b758c906e9a58ce97b67f9f0a1" args="(const Glib::ustring &provider, const Glib::ustring &db_name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" >ServerOperation</a>> Gnome::Gda::ServerOperation::prepare_drop_database </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>provider</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>db_name</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a13e2cd70de6627d85350331a096e03ab"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::property_connection" ref="a13e2cd70de6627d85350331a096e03ab" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Connection</a>> > Gnome::Gda::ServerOperation::property_connection </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classGnome_1_1Gda_1_1Connection.html" title="Manages a connection to a data source.">Connection</a> to use. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a374cba8af2ab4c187598966dc7c45925"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::property_op_type" ref="a374cba8af2ab4c187598966dc7c45925" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::PropertyProxy_ReadOnly</a><gint> Gnome::Gda::ServerOperation::property_op_type </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Type of operation to be done. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a91670f857780470427dad44d438a3462"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::save_data_to_xml" ref="a91670f857780470427dad44d438a3462" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">xmlNodePtr Gnome::Gda::ServerOperation::save_data_to_xml </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8bddd180b7d438e451274e66ea9c1450"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::set_value_at" ref="a8bddd180b7d438e451274e66ea9c1450" args="(const Glib::ustring &path_format, const ValueType &value)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <class ValueType > </div> <table class="memname"> <tr> <td class="memname">void Gnome::Gda::ServerOperation::set_value_at </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path_format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const ValueType & </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a021ef8766dc4da2929dbb206846a40a2"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::set_value_at_as_value" ref="a021ef8766dc4da2929dbb206846a40a2" args="(const Glib::ustring &path_format, const Glib::ValueBase &value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gnome::Gda::ServerOperation::set_value_at_as_value </td> <td>(</td> <td class="paramtype">const <a class="elRef" >Glib::ustring</a> & </td> <td class="paramname"><em>path_format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" >Glib::ValueBase</a> & </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac3a38522fbed18d4906717d37b9f0f07"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::signal_signal_sequence_item_added" ref="ac3a38522fbed18d4906717d37b9f0f07" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a>,int > Gnome::Gda::ServerOperation::signal_signal_sequence_item_added </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_signal_sequence_item_added(<a class="elRef" >Glib::ustring</a> arg1, int arg2)</code> </dd></dl> </div> </div> <a class="anchor" id="a5e994031ad8b5954b926ade46bcfcd46"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::signal_signal_sequence_item_remove" ref="a5e994031ad8b5954b926ade46bcfcd46" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Glib::ustring</a>,int > Gnome::Gda::ServerOperation::signal_signal_sequence_item_remove </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_signal_sequence_item_remove(<a class="elRef" >Glib::ustring</a> arg1, int arg2)</code> </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a70dabea139041b39325be33f226a4ffa"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::wrap" ref="a70dabea139041b39325be33f226a4ffa" args="(GdaServerOperation *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Gnome::Gda::ServerOperation</a> > wrap </td> <td>(</td> <td class="paramtype">GdaServerOperation * </td> <td class="paramname"><em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>take_copy</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" >Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">object</td><td>The C instance. </td></tr> <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>libgdamm/serveroperation.h</li> </ul> </div> <hr class="footer"/><address class="footer"><small> Generated on Sun Nov 20 2011 22:38:13 for libgdamm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.5.1-20110925 </small></address> </body> </html>