doc/www/doxygen/html/ldif_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: ldif.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>ldif.h</h1><a href="ldif_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       ldif.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Routines for reading and writing LDAP LDIF data.</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_LDIF_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_LDIF_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;string&gt;</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;map&gt;</span>
  50 <a name="l00028"></a>00028
  51 <a name="l00029"></a>00029 <span class="comment">// forward declarations</span>
  52 <a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
  53 <a name="l00031"></a>00031         <span class="keyword">class </span>Contact;
  54 <a name="l00032"></a>00032 }
  55 <a name="l00033"></a>00033
  56 <a name="l00034"></a>00034 <span class="keyword">namespace </span>Barry {
  57 <a name="l00035"></a>00035
  58 <a name="l00036"></a>00036 <span class="comment">//</span>
  59 <a name="l00037"></a>00037 <span class="comment">// ContactLdif</span>
  60 <a name="l00038"></a>00038 <span class="comment">//</span><span class="comment"></span>
  61 <a name="l00039"></a>00039 <span class="comment">/// Class for generating LDIF output based on a Barry::Contact record object.</span>
  62 <a name="l00040"></a>00040 <span class="comment">/// This class supports LDIF attribute mapping, and a heuristics mechanism</span>
  63 <a name="l00041"></a>00041 <span class="comment">/// for parsing LDIF fields that may not have consistent data.</span>
  64 <a name="l00042"></a>00042 <span class="comment">///</span>
  65 <a name="l00043"></a>00043 <span class="comment">/// To use this class, create an instance of it, then call DumpLdif(), passing</span>
  66 <a name="l00044"></a>00044 <span class="comment">/// the Contact record object to base the work on.  Output will be written</span>
  67 <a name="l00045"></a>00045 <span class="comment">/// to the stream you provide.  ReadLdif() goes in the other direction.</span>
  68 <a name="l00046"></a>00046 <span class="comment">///</span>
  69 <a name="l00047"></a>00047 <span class="comment">/// To override LDIF attribute mapping, call Map() or Unmap() as appropriate.</span>
  70 <a name="l00048"></a>00048 <span class="comment">///</span>
  71 <a name="l00049"></a>00049 <span class="comment">/// To get a list of supported Barry::Contact field names, call GetFieldNames().</span>
  72 <a name="l00050"></a>00050 <span class="comment">/// This function returns a pointer to an array of ContactLdif::NameToFunc</span>
  73 <a name="l00051"></a>00051 <span class="comment">/// structures, ending with NameToFunc::name as null.  You can cycle through the</span>
  74 <a name="l00052"></a>00052 <span class="comment">/// array with code like this:</span>
  75 <a name="l00053"></a>00053 <span class="comment">///</span>
  76 <a name="l00054"></a>00054 <span class="comment">/// &lt;pre&gt;</span>
  77 <a name="l00055"></a>00055 <span class="comment">///     for( ContactLdif::NameToFunc *n = o.GetFieldNames(); n-&gt;name; n++ ) {</span>
  78 <a name="l00056"></a>00056 <span class="comment">///             ...</span>
  79 <a name="l00057"></a>00057 <span class="comment">///     }</span>
  80 <a name="l00058"></a>00058 <span class="comment">/// &lt;/pre&gt;</span>
  81 <a name="l00059"></a>00059 <span class="comment">///</span>
  82 <a name="l00060"></a>00060 <span class="comment">/// Note that all Get/Set functions used in attribute mapping are virtual,</span>
  83 <a name="l00061"></a>00061 <span class="comment">/// and can be overridden by a derived class.  This includes the heuristics</span>
  84 <a name="l00062"></a>00062 <span class="comment">/// functions, which are called by DumpLdif().</span>
  85 <a name="l00063"></a>00063 <span class="comment">///</span>
  86 <a name="l00064"></a><a class="code" href="classBarry_1_1ContactLdif.html">00064</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1ContactLdif.html" title="Class for generating LDIF output based on a Barry::Contact record object.">ContactLdif</a>
  87 <a name="l00065"></a>00065 {
  88 <a name="l00066"></a>00066 <span class="keyword">public</span>:
  89 <a name="l00067"></a>00067         <span class="keyword">typedef</span> std::string (<a class="code" href="classBarry_1_1ContactLdif.html" title="Class for generating LDIF output based on a Barry::Contact record object.">ContactLdif</a>::*GetFunctionType)(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a>&amp;) <span class="keyword">const</span>;
  90 <a name="l00068"></a>00068         <span class="keyword">typedef</span> void (<a class="code" href="classBarry_1_1ContactLdif.html" title="Class for generating LDIF output based on a Barry::Contact record object.">ContactLdif</a>::*SetFunctionType)(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a>&amp;, <span class="keyword">const</span> std::string &amp;) <span class="keyword">const</span>;
  91 <a name="l00069"></a>00069 <span class="comment"></span>
  92 <a name="l00070"></a>00070 <span class="comment">        /// Used to create a List of supported Barry field names, including</span>
  93 <a name="l00071"></a>00071 <span class="comment">        /// calculated names, such as full postal address.</span>
  94 <a name="l00072"></a><a class="code" href="structBarry_1_1ContactLdif_1_1NameToFunc.html">00072</a> <span class="comment"></span>        <span class="keyword">struct </span><a class="code" href="structBarry_1_1ContactLdif_1_1NameToFunc.html" title="Used to create a List of supported Barry field names, including calculated names...">NameToFunc</a>
  95 <a name="l00073"></a>00073         {
  96 <a name="l00074"></a>00074                 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
  97 <a name="l00075"></a>00075                 <span class="keyword">const</span> <span class="keywordtype">char</span> *description;
  98 <a name="l00076"></a>00076                 GetFunctionType read;
  99 <a name="l00077"></a>00077                 SetFunctionType write;
 100 <a name="l00078"></a>00078         };
 101 <a name="l00079"></a>00079
 102 <a name="l00080"></a>00080         <span class="keyword">struct </span>LdifAttribute
 103 <a name="l00081"></a>00081         {
 104 <a name="l00082"></a>00082                 std::string name;
 105 <a name="l00083"></a>00083                 std::string objectClass;
 106 <a name="l00084"></a>00084                 <span class="keywordtype">int</span> order;
 107 <a name="l00085"></a>00085
 108 <a name="l00086"></a>00086                 LdifAttribute() : order(0) {}
 109 <a name="l00087"></a>00087                 LdifAttribute(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> std::string &amp;oc = <span class="stringliteral">""</span>)
 110 <a name="l00088"></a>00088                         : name(name), objectClass(oc), order(0)
 111 <a name="l00089"></a>00089                         {}
 112 <a name="l00090"></a>00090                 LdifAttribute(<span class="keyword">const</span> std::string &amp;name, <span class="keyword">const</span> std::string &amp;oc = <span class="stringliteral">""</span>)
 113 <a name="l00091"></a>00091                         : name(name), objectClass(oc), order(0)
 114 <a name="l00092"></a>00092                         {}
 115 <a name="l00093"></a>00093
 116 <a name="l00094"></a>00094                 <span class="keywordtype">bool</span> operator&lt;(<span class="keyword">const</span> LdifAttribute &amp;other) <span class="keyword">const</span>;
 117 <a name="l00095"></a>00095                 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> LdifAttribute &amp;other) <span class="keyword">const</span>;
 118 <a name="l00096"></a>00096         };
 119 <a name="l00097"></a>00097
 120 <a name="l00098"></a>00098         <span class="keyword">struct </span>AccessPair
 121 <a name="l00099"></a>00099         {
 122 <a name="l00100"></a>00100                 GetFunctionType read;
 123 <a name="l00101"></a>00101                 SetFunctionType write;
 124 <a name="l00102"></a>00102
 125 <a name="l00103"></a>00103                 AccessPair() : read(0), write(0) {}
 126 <a name="l00104"></a>00104                 AccessPair(GetFunctionType r, SetFunctionType w)
 127 <a name="l00105"></a>00105                         : read(r), write(w)
 128 <a name="l00106"></a>00106                         {}
 129 <a name="l00107"></a>00107         };
 130 <a name="l00108"></a>00108
 131 <a name="l00109"></a>00109         <span class="keyword">typedef</span> std::map&lt;LdifAttribute, AccessPair&gt;   AccessMapType;
 132 <a name="l00110"></a>00110         <span class="keyword">typedef</span> std::map&lt;std::string, std::string*&gt;   HookMapType;
 133 <a name="l00111"></a>00111
 134 <a name="l00112"></a>00112 <span class="keyword">protected</span>:
 135 <a name="l00113"></a>00113         <span class="keyword">static</span> <span class="keyword">const</span> NameToFunc FieldMap[];
 136 <a name="l00114"></a>00114         AccessMapType m_map;
 137 <a name="l00115"></a>00115         std::string m_baseDN;
 138 <a name="l00116"></a>00116         HookMapType m_hookMap;
 139 <a name="l00117"></a>00117         LdifAttribute m_dnAttr;
 140 <a name="l00118"></a>00118
 141 <a name="l00119"></a>00119         <span class="keywordtype">void</span> DoWrite(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;attr,
 142 <a name="l00120"></a>00120                 <span class="keyword">const</span> std::string &amp;data);
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122         <span class="comment">// Array getter state</span>
 145 <a name="l00123"></a>00123         <span class="keyword">mutable</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_emailIndex;
 146 <a name="l00124"></a>00124
 147 <a name="l00125"></a>00125         <span class="comment">// name heuristics</span>
 148 <a name="l00126"></a>00126         std::string m_cn, m_displayName, m_sn, m_givenName;
 149 <a name="l00127"></a>00127
 150 <a name="l00128"></a>00128         <span class="comment">// heuristics hooking - saves each found value in the variable</span>
 151 <a name="l00129"></a>00129         <span class="comment">// pointed at by var</span>
 152 <a name="l00130"></a>00130         <span class="keywordtype">void</span> Hook(<span class="keyword">const</span> std::string &amp;ldifname, std::string *var);
 153 <a name="l00131"></a>00131
 154 <a name="l00132"></a>00132 <span class="keyword">public</span>:
 155 <a name="l00133"></a>00133         <span class="keyword">explicit</span> ContactLdif(<span class="keyword">const</span> std::string &amp;baseDN);
 156 <a name="l00134"></a>00134         <span class="keyword">virtual</span> ~ContactLdif();
 157 <a name="l00135"></a>00135
 158 <a name="l00136"></a>00136         <span class="keyword">const</span> NameToFunc* GetFieldNames()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> FieldMap; }
 159 <a name="l00137"></a>00137         <span class="keyword">const</span> NameToFunc* GetField(<span class="keyword">const</span> std::string &amp;fieldname) <span class="keyword">const</span>;
 160 <a name="l00138"></a>00138         std::string GetFieldReadName(GetFunctionType read) <span class="keyword">const</span>;
 161 <a name="l00139"></a>00139         std::string GetFieldWriteName(SetFunctionType write) <span class="keyword">const</span>;
 162 <a name="l00140"></a>00140
 163 <a name="l00141"></a>00141         <span class="keywordtype">bool</span> Map(<span class="keyword">const</span> LdifAttribute &amp;ldifname, <span class="keyword">const</span> std::string &amp;readField,
 164 <a name="l00142"></a>00142                 <span class="keyword">const</span> std::string &amp;writeField);
 165 <a name="l00143"></a>00143         <span class="keywordtype">void</span> Map(<span class="keyword">const</span> LdifAttribute &amp;ldifname, GetFunctionType read,
 166 <a name="l00144"></a>00144                 SetFunctionType write);
 167 <a name="l00145"></a>00145         <span class="keywordtype">void</span> Unmap(<span class="keyword">const</span> LdifAttribute &amp;ldifname);
 168 <a name="l00146"></a>00146
 169 <a name="l00147"></a>00147         <span class="keywordtype">void</span> SetBaseDN(<span class="keyword">const</span> std::string &amp;baseDN) { m_baseDN = baseDN; }
 170 <a name="l00148"></a>00148         <span class="keywordtype">bool</span> SetDNAttr(<span class="keyword">const</span> LdifAttribute &amp;name);
 171 <a name="l00149"></a>00149         <span class="keywordtype">bool</span> SetObjectClass(<span class="keyword">const</span> LdifAttribute &amp;name, <span class="keyword">const</span> std::string &amp;objectClass);
 172 <a name="l00150"></a>00150         <span class="keywordtype">bool</span> SetObjectOrder(<span class="keyword">const</span> LdifAttribute &amp;name, <span class="keywordtype">int</span> order);
 173 <a name="l00151"></a>00151
 174 <a name="l00152"></a>00152         <span class="comment">//</span>
 175 <a name="l00153"></a>00153         <span class="comment">// Access functions</span>
 176 <a name="l00154"></a>00154         <span class="comment">//</span>
 177 <a name="l00155"></a>00155
 178 <a name="l00156"></a>00156         <span class="keyword">virtual</span> std::string Email(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 179 <a name="l00157"></a>00157         <span class="keyword">virtual</span> std::string Phone(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 180 <a name="l00158"></a>00158         <span class="keyword">virtual</span> std::string Fax(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 181 <a name="l00159"></a>00159         <span class="keyword">virtual</span> std::string WorkPhone(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 182 <a name="l00160"></a>00160         <span class="keyword">virtual</span> std::string HomePhone(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 183 <a name="l00161"></a>00161         <span class="keyword">virtual</span> std::string MobilePhone(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 184 <a name="l00162"></a>00162         <span class="keyword">virtual</span> std::string Pager(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 185 <a name="l00163"></a>00163         <span class="keyword">virtual</span> std::string PIN(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 186 <a name="l00164"></a>00164         <span class="keyword">virtual</span> std::string FirstName(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 187 <a name="l00165"></a>00165         <span class="keyword">virtual</span> std::string LastName(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 188 <a name="l00166"></a>00166         <span class="keyword">virtual</span> std::string Company(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 189 <a name="l00167"></a>00167         <span class="keyword">virtual</span> std::string DefaultCommunicationsMethod(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 190 <a name="l00168"></a>00168         <span class="keyword">virtual</span> std::string WorkAddress1(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 191 <a name="l00169"></a>00169         <span class="keyword">virtual</span> std::string WorkAddress2(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 192 <a name="l00170"></a>00170         <span class="keyword">virtual</span> std::string WorkAddress3(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 193 <a name="l00171"></a>00171         <span class="keyword">virtual</span> std::string WorkCity(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 194 <a name="l00172"></a>00172         <span class="keyword">virtual</span> std::string WorkProvince(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 195 <a name="l00173"></a>00173         <span class="keyword">virtual</span> std::string WorkPostalCode(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 196 <a name="l00174"></a>00174         <span class="keyword">virtual</span> std::string WorkCountry(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 197 <a name="l00175"></a>00175         <span class="keyword">virtual</span> std::string JobTitle(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 198 <a name="l00176"></a>00176         <span class="keyword">virtual</span> std::string PublicKey(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 199 <a name="l00177"></a>00177         <span class="keyword">virtual</span> std::string Notes(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 200 <a name="l00178"></a>00178         <span class="comment">// calculated values...</span>
 201 <a name="l00179"></a>00179         <span class="keyword">virtual</span> std::string WorkPostalAddress(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 202 <a name="l00180"></a>00180         <span class="keyword">virtual</span> std::string HomePostalAddress(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 203 <a name="l00181"></a>00181         <span class="keyword">virtual</span> std::string FullName(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 204 <a name="l00182"></a>00182         <span class="keyword">virtual</span> std::string FQDN(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con) <span class="keyword">const</span>;
 205 <a name="l00183"></a>00183
 206 <a name="l00184"></a>00184         <span class="comment">//</span>
 207 <a name="l00185"></a>00185         <span class="comment">// Array modifier functions for above Access functions</span>
 208 <a name="l00186"></a>00186         <span class="comment">//</span>
 209 <a name="l00187"></a>00187
 210 <a name="l00188"></a>00188         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsArrayFunc(GetFunctionType getf) <span class="keyword">const</span>;
 211 <a name="l00189"></a>00189         <span class="keywordtype">void</span> ClearArrayState() <span class="keyword">const</span>;
 212 <a name="l00190"></a>00190
 213 <a name="l00191"></a>00191         <span class="comment">//</span>
 214 <a name="l00192"></a>00192         <span class="comment">// Write functions</span>
 215 <a name="l00193"></a>00193         <span class="comment">//</span>
 216 <a name="l00194"></a>00194
 217 <a name="l00195"></a>00195         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetEmail(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 218 <a name="l00196"></a>00196         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPhone(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 219 <a name="l00197"></a>00197         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFax(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 220 <a name="l00198"></a>00198         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkPhone(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 221 <a name="l00199"></a>00199         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetHomePhone(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 222 <a name="l00200"></a>00200         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMobilePhone(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 223 <a name="l00201"></a>00201         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPager(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 224 <a name="l00202"></a>00202         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPIN(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 225 <a name="l00203"></a>00203         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFirstName(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 226 <a name="l00204"></a>00204         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLastName(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 227 <a name="l00205"></a>00205         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetCompany(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 228 <a name="l00206"></a>00206         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetDefaultCommunicationsMethod(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 229 <a name="l00207"></a>00207         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkAddress1(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 230 <a name="l00208"></a>00208         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkAddress2(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 231 <a name="l00209"></a>00209         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkAddress3(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 232 <a name="l00210"></a>00210         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkCity(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 233 <a name="l00211"></a>00211         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkProvince(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 234 <a name="l00212"></a>00212         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkPostalCode(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 235 <a name="l00213"></a>00213         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkCountry(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 236 <a name="l00214"></a>00214         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetJobTitle(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 237 <a name="l00215"></a>00215         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPublicKey(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 238 <a name="l00216"></a>00216         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetNotes(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 239 <a name="l00217"></a>00217         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetWorkPostalAddress(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 240 <a name="l00218"></a>00218         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetHomePostalAddress(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 241 <a name="l00219"></a>00219         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFullName(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 242 <a name="l00220"></a>00220         <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFQDN(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con, <span class="keyword">const</span> std::string &amp;val) <span class="keyword">const</span>;
 243 <a name="l00221"></a>00221
 244 <a name="l00222"></a>00222
 245 <a name="l00223"></a>00223         <span class="comment">//</span>
 246 <a name="l00224"></a>00224         <span class="comment">// Name heuristics</span>
 247 <a name="l00225"></a>00225         <span class="comment">//</span>
 248 <a name="l00226"></a>00226
 249 <a name="l00227"></a>00227         <span class="keyword">virtual</span> <span class="keywordtype">void</span> ClearHeuristics();
 250 <a name="l00228"></a>00228         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> RunHeuristics(<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;con);
 251 <a name="l00229"></a>00229
 252 <a name="l00230"></a>00230         <span class="comment">//</span>
 253 <a name="l00231"></a>00231         <span class="comment">// Operations</span>
 254 <a name="l00232"></a>00232         <span class="comment">//</span>
 255 <a name="l00233"></a>00233
 256 <a name="l00234"></a>00234         <span class="keywordtype">void</span> DumpLdif(std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;contact) <span class="keyword">const</span>;
 257 <a name="l00235"></a>00235         <span class="keywordtype">bool</span> ReadLdif(std::istream &amp;is, <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> &amp;contact);
 258 <a name="l00236"></a>00236                                                         <span class="comment">// returns true on success</span>
 259 <a name="l00237"></a>00237         <span class="keywordtype">void</span> DumpMap(std::ostream &amp;os) <span class="keyword">const</span>;
 260 <a name="l00238"></a>00238
 261 <a name="l00239"></a>00239
 262 <a name="l00240"></a>00240         <span class="keyword">static</span> std::string MakeLdifData(<span class="keyword">const</span> std::string &amp;str);
 263 <a name="l00241"></a>00241         <span class="keyword">static</span> <span class="keywordtype">bool</span> NeedsEncoding(<span class="keyword">const</span> std::string &amp;str);
 264 <a name="l00242"></a>00242 };
 265 <a name="l00243"></a>00243
 266 <a name="l00244"></a>00244 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> ContactLdif &amp;ldif) {
 267 <a name="l00245"></a>00245         ldif.DumpMap(os);
 268 <a name="l00246"></a>00246         <span class="keywordflow">return</span> os;
 269 <a name="l00247"></a>00247 }
 270 <a name="l00248"></a>00248
 271 <a name="l00249"></a>00249 } <span class="comment">// namespace Barry</span>
 272 <a name="l00250"></a>00250
 273 <a name="l00251"></a>00251 <span class="preprocessor">#endif</span>
 274 <a name="l00252"></a>00252 <span class="preprocessor"></span>
 275 </pre></div></div>
 276 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:52 2009 for Barry by&nbsp;
 277 <a href="http://www.doxygen.org/index.html">
 278 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 279 </body>
 280 </html>