Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > b3a1f4d91c26f535919e39e25606614a > files > 1460

wt-doc-3.2.3-1.fc18.noarch.rpm

<!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>Wt: Wt::Payment::Customer Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</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">Wt
   &#160;<span id="projectnumber">3.2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a>      </li>
      <li class="navelem"><a class="el" href="namespaceWt_1_1Payment.html">Payment</a>      </li>
      <li class="navelem"><a class="el" href="classWt_1_1Payment_1_1Customer.html">Customer</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wt::Payment::Customer Class Reference<div class="ingroups"><a class="el" href="group__payment.html">Payment module (Wt::Payment)</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Payment::Customer" -->
<p>Contains customer information.  
 <a href="classWt_1_1Payment_1_1Customer.html#details">More...</a></p>

<p><code>#include &lt;Wt/Payment/Customer&gt;</code></p>

<p><a href="classWt_1_1Payment_1_1Customer-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#abfa142d3a223494aa35fb73dfb8fea5f">Customer</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#abfa142d3a223494aa35fb73dfb8fea5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a1dd728c891488c8a6fda806abbca49"></a><!-- doxytag: member="Wt::Payment::Customer::setFirstName" ref="a9a1dd728c891488c8a6fda806abbca49" args="(const WString &amp;firstName)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a9a1dd728c891488c8a6fda806abbca49">setFirstName</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;firstName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the first name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a56f27af5f4cc158c7965406ba07e4b2f">firstName</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the first name.  <a href="#a56f27af5f4cc158c7965406ba07e4b2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74416a4171e395986bc8d8df922d97ab"></a><!-- doxytag: member="Wt::Payment::Customer::setLastName" ref="a74416a4171e395986bc8d8df922d97ab" args="(const WString &amp;lastName)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a74416a4171e395986bc8d8df922d97ab">setLastName</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;lastName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the last name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#ab44d960193e475b015c3ecbc3d2ae848">lastName</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last name.  <a href="#ab44d960193e475b015c3ecbc3d2ae848"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affe8248291a3028298145898d334b72e"></a><!-- doxytag: member="Wt::Payment::Customer::setEmail" ref="affe8248291a3028298145898d334b72e" args="(const std::string &amp;email)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#affe8248291a3028298145898d334b72e">setEmail</a> (const std::string &amp;email)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the email address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#acafe7a5aa4c939c3735e0663aae03d08">email</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the email address.  <a href="#acafe7a5aa4c939c3735e0663aae03d08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48d8d792b5fed0abed456b6a45f90d4e"></a><!-- doxytag: member="Wt::Payment::Customer::setShippingAddress" ref="a48d8d792b5fed0abed456b6a45f90d4e" args="(const Address &amp;address)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a48d8d792b5fed0abed456b6a45f90d4e">setShippingAddress</a> (const <a class="el" href="classWt_1_1Payment_1_1Address.html">Address</a> &amp;address)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the shipping address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Payment_1_1Address.html">Address</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a61ca71014c768286e63760ff08e13727">shippingAddress</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns shipping address.  <a href="#a61ca71014c768286e63760ff08e13727"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a9e27e95aac03d909cb95e78608832716">setLocale</a> (const std::string &amp;locale)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the customer locale.  <a href="#a9e27e95aac03d909cb95e78608832716"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#ad152cdaa3ee82fa6c4a2c8b426cf2d9a">locale</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns locale.  <a href="#ad152cdaa3ee82fa6c4a2c8b426cf2d9a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a615abc3571fa671a989215280cf5c50d">setPayerId</a> (const std::string &amp;payerId)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the payerId field.  <a href="#a615abc3571fa671a989215280cf5c50d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1Customer.html#a45de27c15aa664bd61fc8f60435b9651">payerId</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns payerId.  <a href="#a45de27c15aa664bd61fc8f60435b9651"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Contains customer information. </p>
<div class="fragment"><pre class="fragment">   <a class="code" href="classWt_1_1Payment_1_1Customer.html" title="Contains customer information.">Wt::Payment::Customer</a> customer;

   customer.<a class="code" href="classWt_1_1Payment_1_1Customer.html#affe8248291a3028298145898d334b72e" title="Sets the email address.">setEmail</a>(<span class="stringliteral">&quot;joe.birkenberg@emweb.be&quot;</span>);
   customer.<a class="code" href="classWt_1_1Payment_1_1Customer.html#a9a1dd728c891488c8a6fda806abbca49" title="Sets the first name.">setFirstName</a>(<span class="stringliteral">&quot;Joe&quot;</span>);
   customer.<a class="code" href="classWt_1_1Payment_1_1Customer.html#a74416a4171e395986bc8d8df922d97ab" title="Sets the last name.">setLastName</a>(<span class="stringliteral">&quot;Birkenberg&quot;</span>);

   <a class="code" href="classWt_1_1Payment_1_1Address.html" title="Contains address information.">Wt::Payment::Address</a> address;
   address.<a class="code" href="classWt_1_1Payment_1_1Address.html#a426b49b31c9a18a3ce593205e984534c" title="Sets the city.">setCity</a>(<span class="stringliteral">&quot;Leuven&quot;</span>);
   address.<a class="code" href="classWt_1_1Payment_1_1Address.html#ae958dd95b11c720672de619ba7372438" title="Sets the country code.">setCountryCode</a>(<span class="stringliteral">&quot;BE&quot;</span>);
   address.<a class="code" href="classWt_1_1Payment_1_1Address.html#a535e340f2db731ba8538e1c7516147f7" title="Sets the phone number.">setPhoneNumber</a>(<span class="stringliteral">&quot;123456789&quot;</span>);
   address.<a class="code" href="classWt_1_1Payment_1_1Address.html#a0819cb594d861471678741c23fc63b0d" title="Sets first street line.">setStreet1</a>(<span class="stringliteral">&quot;Brusselsestraat 14&quot;</span>);

   customer.<a class="code" href="classWt_1_1Payment_1_1Customer.html#a48d8d792b5fed0abed456b6a45f90d4e" title="Sets the shipping address.">setShippingAddress</a>(address);
</pre></div> </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abfa142d3a223494aa35fb73dfb8fea5f"></a><!-- doxytag: member="Wt::Payment::Customer::Customer" ref="abfa142d3a223494aa35fb73dfb8fea5f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Wt::Payment::Customer::Customer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default constructor. </p>
<p>All information is blank. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acafe7a5aa4c939c3735e0663aae03d08"></a><!-- doxytag: member="Wt::Payment::Customer::email" ref="acafe7a5aa4c939c3735e0663aae03d08" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Wt::Payment::Customer::email </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the email address. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#affe8248291a3028298145898d334b72e" title="Sets the email address.">setEmail()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a56f27af5f4cc158c7965406ba07e4b2f"></a><!-- doxytag: member="Wt::Payment::Customer::firstName" ref="a56f27af5f4cc158c7965406ba07e4b2f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::Payment::Customer::firstName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the first name. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#a9a1dd728c891488c8a6fda806abbca49" title="Sets the first name.">setFirstName()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ab44d960193e475b015c3ecbc3d2ae848"></a><!-- doxytag: member="Wt::Payment::Customer::lastName" ref="ab44d960193e475b015c3ecbc3d2ae848" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::Payment::Customer::lastName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the last name. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#a74416a4171e395986bc8d8df922d97ab" title="Sets the last name.">setLastName()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ad152cdaa3ee82fa6c4a2c8b426cf2d9a"></a><!-- doxytag: member="Wt::Payment::Customer::locale" ref="ad152cdaa3ee82fa6c4a2c8b426cf2d9a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Wt::Payment::Customer::locale </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns locale. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#a9e27e95aac03d909cb95e78608832716" title="Sets the customer locale.">setLocale()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a45de27c15aa664bd61fc8f60435b9651"></a><!-- doxytag: member="Wt::Payment::Customer::payerId" ref="a45de27c15aa664bd61fc8f60435b9651" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Wt::Payment::Customer::payerId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns payerId. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#a615abc3571fa671a989215280cf5c50d" title="Sets the payerId field.">setPayerId()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a9e27e95aac03d909cb95e78608832716"></a><!-- doxytag: member="Wt::Payment::Customer::setLocale" ref="a9e27e95aac03d909cb95e78608832716" args="(const std::string &amp;locale)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Payment::Customer::setLocale </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>locale</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the customer locale. </p>
<p>The customer locale must be specified according to the payment broker (usually to help the user being served in his native language), which is usually a language code like <a href="http://en.wikipedia.org/wiki/BCP_47">http://en.wikipedia.org/wiki/BCP_47</a> </p>

</div>
</div>
<a class="anchor" id="a615abc3571fa671a989215280cf5c50d"></a><!-- doxytag: member="Wt::Payment::Customer::setPayerId" ref="a615abc3571fa671a989215280cf5c50d" args="(const std::string &amp;payerId)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Payment::Customer::setPayerId </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>payerId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the payerId field. </p>
<p>This is the identification of the user with a payment broker which also keeps login information (and other information like shipping addresses) on the user.</p>
<p>Not all payment brokers support (or need this). </p>

</div>
</div>
<a class="anchor" id="a61ca71014c768286e63760ff08e13727"></a><!-- doxytag: member="Wt::Payment::Customer::shippingAddress" ref="a61ca71014c768286e63760ff08e13727" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classWt_1_1Payment_1_1Address.html">Address</a>&amp; Wt::Payment::Customer::shippingAddress </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns shipping address. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Customer.html#a48d8d792b5fed0abed456b6a45f90d4e" title="Sets the shipping address.">setShippingAddress()</a> </dd></dl>

</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by&nbsp;<a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>