<!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::OrderItem 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
 <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 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>
<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 List</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="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_1OrderItem.html">OrderItem</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::OrderItem 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::OrderItem" -->
<p>Describes an item in an order.
<a href="classWt_1_1Payment_1_1OrderItem.html#details">More...</a></p>
<p><code>#include <Wt/Payment/OrderItem></code></p>
<p><a href="classWt_1_1Payment_1_1OrderItem-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"><a class="anchor" id="ae9924346a6cac8b5b7dce78264a7543a"></a><!-- doxytag: member="Wt::Payment::OrderItem::setName" ref="ae9924346a6cac8b5b7dce78264a7543a" args="(const WString &name)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ae9924346a6cac8b5b7dce78264a7543a">setName</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the item name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a9a99d730f691e57ef0999b8cf5f4ca4a">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns item name. <a href="#a9a99d730f691e57ef0999b8cf5f4ca4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6092887cb709b5235c56f2c5ee59b4b2"></a><!-- doxytag: member="Wt::Payment::OrderItem::setNumber" ref="a6092887cb709b5235c56f2c5ee59b4b2" args="(const std::string &number)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a6092887cb709b5235c56f2c5ee59b4b2">setNumber</a> (const std::string &number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the item number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ad977f91fdc6f5685acb62b0a23423bd8">number</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns item number. <a href="#ad977f91fdc6f5685acb62b0a23423bd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abee604fd22f7f0ddd6895525debb61fe"></a><!-- doxytag: member="Wt::Payment::OrderItem::setDescription" ref="abee604fd22f7f0ddd6895525debb61fe" args="(const WString &description)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#abee604fd22f7f0ddd6895525debb61fe">setDescription</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &description)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the item description. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a1505e7992f601fd6fb520a67f6c74ebf">description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the item description. <a href="#a1505e7992f601fd6fb520a67f6c74ebf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ad1874e089bf9d24a5f83d7a4227a62e1">setQuantity</a> (double quantity)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the item quantity. <a href="#ad1874e089bf9d24a5f83d7a4227a62e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#af1b6d4ec7604271b5aaed459ff0bd5eb">quantity</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the item quantity. <a href="#af1b6d4ec7604271b5aaed459ff0bd5eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ad89cfdf117b21011d81afea315bd0aab">setUnitCost</a> (const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> &unitCost)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the item unit cost field. <a href="#ad89cfdf117b21011d81afea315bd0aab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a6e9249312a005995c196e5a93436829e">unitCost</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns item unit cost. <a href="#a6e9249312a005995c196e5a93436829e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a1b57d3b7333a64f3eec4b8f839dc8672">computeTotal</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total cost for this order item. <a href="#a1b57d3b7333a64f3eec4b8f839dc8672"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Describes an item in an order. </p>
<p>Usage example: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1Payment_1_1OrderItem.html" title="Describes an item in an order.">Wt::Payment::OrderItem</a> item1, item2;
item1.<a class="code" href="classWt_1_1Payment_1_1OrderItem.html#ae9924346a6cac8b5b7dce78264a7543a" title="Sets the item name.">setName</a>(<span class="stringliteral">"Waffle Maker"</span>);
item1.<a class="code" href="classWt_1_1Payment_1_1OrderItem.html#a6092887cb709b5235c56f2c5ee59b4b2" title="Sets the item number.">setNumber</a>(<span class="stringliteral">"00001"</span>);
item1.<a class="code" href="classWt_1_1Payment_1_1OrderItem.html#abee604fd22f7f0ddd6895525debb61fe" title="Sets the item description.">setDescription</a>(<span class="stringliteral">"Emweb FlipSide Belgian Waffle Maker"</span>);
item1.<a class="code" href="classWt_1_1Payment_1_1OrderItem.html#ad1874e089bf9d24a5f83d7a4227a62e1" title="Sets the item quantity.">setQuantity</a>(1);
item1.<a class="code" href="classWt_1_1Payment_1_1OrderItem.html#ad89cfdf117b21011d81afea315bd0aab" title="Changes the item unit cost field.">setUnitCost</a>(<a class="code" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Wt::Payment::Money</a>(49, 99, <span class="stringliteral">"USD"</span>));
<a class="code" href="classWt_1_1Payment_1_1Order.html" title="Contains information of a sales order.">Wt::Payment::Order</a> order;
order.<a class="code" href="classWt_1_1Payment_1_1Order.html#a19817c2901f64fd3341be70f528055f5" title="Returns all items in the order.">items</a>().push_back(item1);
order.<a class="code" href="classWt_1_1Payment_1_1Order.html#ab1c39884c02391c58d5a6c3e633d1eea" title="Sets shipping cost.">setShipping</a>(<a class="code" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Wt::Payment::Money</a>(7, 1, <span class="stringliteral">"USD"</span>));
order.<a class="code" href="classWt_1_1Payment_1_1Order.html#a42953a3e3b0c6d42195ad3bd42639f87" title="Sets the shipping discount.">setShippingDiscount</a>(<a class="code" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Wt::Payment::Money</a>(-7, 0, <span class="stringliteral">"USD"</span>));
order.<a class="code" href="classWt_1_1Payment_1_1Order.html#aca46367d6d8fcf14e9eae92917f0cdeb" title="Sets shipping insurance.">setShippingInsurance</a>(<a class="code" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Wt::Payment::Money</a>(2, 23, <span class="stringliteral">"USD"</span>));
order.<a class="code" href="classWt_1_1Payment_1_1Order.html#a4ac47656095d4b73902e86ed762193c7" title="Sets sales taxes.">setTax</a>(<a class="code" href="classWt_1_1Payment_1_1Money.html" title="A value class which describes a monetary value.">Wt::Payment::Money</a>(500, 99, <span class="stringliteral">"USD"</span>));
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1Order.html" title="Contains information of a sales order.">Order</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1b57d3b7333a64f3eec4b8f839dc8672"></a><!-- doxytag: member="Wt::Payment::OrderItem::computeTotal" ref="a1b57d3b7333a64f3eec4b8f839dc8672" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> Wt::Payment::OrderItem::computeTotal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the total cost for this order item. </p>
<p>This returns <a class="el" href="classWt_1_1Payment_1_1OrderItem.html#af1b6d4ec7604271b5aaed459ff0bd5eb" title="Returns the item quantity.">quantity()</a> * <a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a6e9249312a005995c196e5a93436829e" title="Returns item unit cost.">unitCost()</a> </p>
</div>
</div>
<a class="anchor" id="a1505e7992f601fd6fb520a67f6c74ebf"></a><!-- doxytag: member="Wt::Payment::OrderItem::description" ref="a1505e7992f601fd6fb520a67f6c74ebf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a>& Wt::Payment::OrderItem::description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the item description. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#abee604fd22f7f0ddd6895525debb61fe" title="Sets the item description.">setDescription()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9a99d730f691e57ef0999b8cf5f4ca4a"></a><!-- doxytag: member="Wt::Payment::OrderItem::name" ref="a9a99d730f691e57ef0999b8cf5f4ca4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WString.html">WString</a>& Wt::Payment::OrderItem::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns item name. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ae9924346a6cac8b5b7dce78264a7543a" title="Sets the item name.">setName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad977f91fdc6f5685acb62b0a23423bd8"></a><!-- doxytag: member="Wt::Payment::OrderItem::number" ref="ad977f91fdc6f5685acb62b0a23423bd8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Payment::OrderItem::number </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns item number. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a6092887cb709b5235c56f2c5ee59b4b2" title="Sets the item number.">setNumber()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af1b6d4ec7604271b5aaed459ff0bd5eb"></a><!-- doxytag: member="Wt::Payment::OrderItem::quantity" ref="af1b6d4ec7604271b5aaed459ff0bd5eb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Wt::Payment::OrderItem::quantity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the item quantity. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ad1874e089bf9d24a5f83d7a4227a62e1" title="Sets the item quantity.">setQuantity()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad1874e089bf9d24a5f83d7a4227a62e1"></a><!-- doxytag: member="Wt::Payment::OrderItem::setQuantity" ref="ad1874e089bf9d24a5f83d7a4227a62e1" args="(double quantity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Payment::OrderItem::setQuantity </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>quantity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the item quantity. </p>
<p>This is either an integer quantity (number of items) or a fractional quantity (e.g. 1.5 times 1 kilogram).</p>
<p>The total price for this item in the order will be the <a class="el" href="classWt_1_1Payment_1_1OrderItem.html#af1b6d4ec7604271b5aaed459ff0bd5eb" title="Returns the item quantity.">quantity()</a> times the <a class="el" href="classWt_1_1Payment_1_1OrderItem.html#a6e9249312a005995c196e5a93436829e" title="Returns item unit cost.">unitCost()</a>. </p>
</div>
</div>
<a class="anchor" id="ad89cfdf117b21011d81afea315bd0aab"></a><!-- doxytag: member="Wt::Payment::OrderItem::setUnitCost" ref="ad89cfdf117b21011d81afea315bd0aab" args="(const Money &unitCost)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Payment::OrderItem::setUnitCost </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> & </td>
<td class="paramname"><em>unitCost</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the item unit cost field. </p>
<p>This is the unit cost. </p>
</div>
</div>
<a class="anchor" id="a6e9249312a005995c196e5a93436829e"></a><!-- doxytag: member="Wt::Payment::OrderItem::unitCost" ref="a6e9249312a005995c196e5a93436829e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Payment_1_1Money.html">Money</a> Wt::Payment::OrderItem::unitCost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns item unit cost. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Payment_1_1OrderItem.html#ad89cfdf117b21011d81afea315bd0aab" title="Changes the item unit cost field.">setUnitCost()</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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 <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>
