<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<!-- template designed by Marco Von Ballmoos -->
<title>File Source for IUser.class.inc</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<h1>Source for file IUser.class.inc</h1>
<p>Documentation is available at <a href="../swam/_user---IUser.class.inc.html">IUser.class.inc</a></p>
<div class="src-code">
<div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
<li><div class="src-line"><a name="a2"></a> </div></li>
<li><div class="src-line"><a name="a3"></a><span class="src-comm">/*</span></div></li>
<li><div class="src-line"><a name="a4"></a><span class="src-comm">* SWAM (Simple Web Account Manager) is a personal finance manager</span></div></li>
<li><div class="src-line"><a name="a5"></a><span class="src-comm">* written in PHP.</span></div></li>
<li><div class="src-line"><a name="a6"></a><span class="src-comm">* Copyright (C) 2004-2009 Mathieu Peltier.</span></div></li>
<li><div class="src-line"><a name="a7"></a><span class="src-comm">* Contact: mpeltier at users.sourceforge.net</span></div></li>
<li><div class="src-line"><a name="a8"></a><span class="src-comm">*</span></div></li>
<li><div class="src-line"><a name="a9"></a><span class="src-comm">* This program is free software: you can redistribute it and/or modify</span></div></li>
<li><div class="src-line"><a name="a10"></a><span class="src-comm">* it under the terms of the GNU General Public License as published by</span></div></li>
<li><div class="src-line"><a name="a11"></a><span class="src-comm">* the Free Software Foundation, either version 3 of the License, or</span></div></li>
<li><div class="src-line"><a name="a12"></a><span class="src-comm">* (at your option) any later version.</span></div></li>
<li><div class="src-line"><a name="a13"></a><span class="src-comm">*</span></div></li>
<li><div class="src-line"><a name="a14"></a><span class="src-comm">* This program is distributed in the hope that it will be useful, but</span></div></li>
<li><div class="src-line"><a name="a15"></a><span class="src-comm">* WITHOUT ANY WARRANTY; without even the implied warranty of</span></div></li>
<li><div class="src-line"><a name="a16"></a><span class="src-comm">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div></li>
<li><div class="src-line"><a name="a17"></a><span class="src-comm">* General Public License for more details.</span></div></li>
<li><div class="src-line"><a name="a18"></a><span class="src-comm">*</span></div></li>
<li><div class="src-line"><a name="a19"></a><span class="src-comm">* You should have received a copy of the GNU General Public License</span></div></li>
<li><div class="src-line"><a name="a20"></a><span class="src-comm">* along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div></li>
<li><div class="src-line"><a name="a21"></a><span class="src-comm">*</span></div></li>
<li><div class="src-line"><a name="a22"></a><span class="src-comm">* Initial developer(s): Mathieu Peltier.</span></div></li>
<li><div class="src-line"><a name="a23"></a><span class="src-comm">* Contributor(s):</span></div></li>
<li><div class="src-line"><a name="a24"></a><span class="src-comm">*/</span></div></li>
<li><div class="src-line"><a name="a25"></a> </div></li>
<li><div class="src-line"><a name="a26"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a27"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> swam</span></div></li>
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Mathieu Peltier <hide@address.com></span></div></li>
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a30"></a> </div></li>
<li><div class="src-line"><a name="a31"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a32"></a><span class="src-doc"> * Defines an SWAM user.</span></div></li>
<li><div class="src-line"><a name="a33"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> swam</span></div></li>
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a36"></a><span class="src-key">interface </span><a href="../swam/IUser.html">IUser</a> <span class="src-key">extends </span><a href="../swam/IPersistentObject.html">IPersistentObject</a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a37"></a> </div></li>
<li><div class="src-line"><a name="a38"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a39"></a><span class="src-doc"> * Sets the first name.</span></div></li>
<li><div class="src-line"><a name="a40"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$first_name </span></div></li>
<li><div class="src-line"><a name="a42"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException if the first name is empty.</span></div></li>
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a44"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_first_name">set_first_name</a><span class="src-sym">(</span><span class="src-var">$first_name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a45"></a> </div></li>
<li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> * Returns the first name.</span></div></li>
<li><div class="src-line"><a name="a48"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a51"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_first_name">get_first_name</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a52"></a> </div></li>
<li><div class="src-line"><a name="a53"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a54"></a><span class="src-doc"> * Sets the last name.</span></div></li>
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$last_name </span></div></li>
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException if the last name is empty.</span></div></li>
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a59"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_last_name">set_last_name</a><span class="src-sym">(</span><span class="src-var">$last_name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a60"></a> </div></li>
<li><div class="src-line"><a name="a61"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> * Returns the last name.</span></div></li>
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a66"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_last_name">get_last_name</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a67"></a> </div></li>
<li><div class="src-line"><a name="a68"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * Sets the email.</span></div></li>
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$email </span></div></li>
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException if the email is invalid.</span></div></li>
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a74"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_email">set_email</a><span class="src-sym">(</span><span class="src-var">$email</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a75"></a> </div></li>
<li><div class="src-line"><a name="a76"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a77"></a><span class="src-doc"> * Returns the email.</span></div></li>
<li><div class="src-line"><a name="a78"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$email </span></div></li>
<li><div class="src-line"><a name="a80"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a81"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_email">get_email</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a82"></a> </div></li>
<li><div class="src-line"><a name="a83"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a84"></a><span class="src-doc"> * Sets the login.</span></div></li>
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a86"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$login </span></div></li>
<li><div class="src-line"><a name="a87"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException if the login is invalid or already used.</span></div></li>
<li><div class="src-line"><a name="a88"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a89"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_login">set_login</a><span class="src-sym">(</span><span class="src-var">$login</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a90"></a> </div></li>
<li><div class="src-line"><a name="a91"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> * Returns the login.</span></div></li>
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a94"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a95"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a96"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_login">get_login</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a97"></a> </div></li>
<li><div class="src-line"><a name="a98"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a99"></a><span class="src-doc"> * Sets the crypted password.</span></div></li>
<li><div class="src-line"><a name="a100"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a101"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$crypted_password </span><span class="src-doc">crypted password (using PHP</span></div></li>
<li><div class="src-line"><a name="a102"></a><span class="src-doc"> * crypt() function).</span></div></li>
<li><div class="src-line"><a name="a103"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a104"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a105"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_crypted_password">set_crypted_password</a><span class="src-sym">(</span><span class="src-var">$crypted_password</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a106"></a> </div></li>
<li><div class="src-line"><a name="a107"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a108"></a><span class="src-doc"> * Returns the crypted password.</span></div></li>
<li><div class="src-line"><a name="a109"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a110"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a111"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a112"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_crypted_password">get_crypted_password</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a113"></a> </div></li>
<li><div class="src-line"><a name="a114"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a115"></a><span class="src-doc"> * Sets the password.</span></div></li>
<li><div class="src-line"><a name="a116"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a117"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$password </span><span class="src-doc">password.</span></div></li>
<li><div class="src-line"><a name="a118"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a119"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a120"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_password">set_password</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a121"></a> </div></li>
<li><div class="src-line"><a name="a122"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a123"></a><span class="src-doc"> * Sets the show_closed_accounts flag.</span></div></li>
<li><div class="src-line"><a name="a124"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a125"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span></div></li>
<li><div class="src-line"><a name="a126"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a127"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a128"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_show_closed_accounts">set_show_closed_accounts</a><span class="src-sym">(</span><span class="src-var">$show_closed_accounts</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a129"></a> </div></li>
<li><div class="src-line"><a name="a130"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a131"></a><span class="src-doc"> * Returns true if the closed accounts must be displayed by default.</span></div></li>
<li><div class="src-line"><a name="a132"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a133"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
<li><div class="src-line"><a name="a134"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a135"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_show_closed_accounts_flag">get_show_closed_accounts_flag</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a136"></a> </div></li>
<li><div class="src-line"><a name="a137"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a138"></a><span class="src-doc"> * Sets the is_valid flag.</span></div></li>
<li><div class="src-line"><a name="a139"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a140"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span><span class="src-doc-var">$is_valid </span></div></li>
<li><div class="src-line"><a name="a141"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a142"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a143"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_is_valid">set_is_valid</a><span class="src-sym">(</span><span class="src-var">$is_valid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a144"></a> </div></li>
<li><div class="src-line"><a name="a145"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a146"></a><span class="src-doc"> * Checks if the registration of this user is valid.</span></div></li>
<li><div class="src-line"><a name="a147"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a148"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
<li><div class="src-line"><a name="a149"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a150"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodis_valid">is_valid</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a151"></a> </div></li>
<li><div class="src-line"><a name="a152"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a153"></a><span class="src-doc"> * Sets the confirmation_hash.</span></div></li>
<li><div class="src-line"><a name="a154"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a155"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$confirmation_hash </span></div></li>
<li><div class="src-line"><a name="a156"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a157"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a158"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodset_confirmation_hash">set_confirmation_hash</a><span class="src-sym">(</span><span class="src-var">$confirmation_hash</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a159"></a> </div></li>
<li><div class="src-line"><a name="a160"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a161"></a><span class="src-doc"> * Gets the confirmation hash.</span></div></li>
<li><div class="src-line"><a name="a162"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a163"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a164"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a165"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_confirmation_hash">get_confirmation_hash</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a166"></a> </div></li>
<li><div class="src-line"><a name="a167"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a168"></a><span class="src-doc"> * Resets the confirmation hash and send mail to this user so that</span></div></li>
<li><div class="src-line"><a name="a169"></a><span class="src-doc"> * password can be reset (to be used in case of lost password).</span></div></li>
<li><div class="src-line"><a name="a170"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a171"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodreset_confirmation_hash">reset_confirmation_hash</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a172"></a> </div></li>
<li><div class="src-line"><a name="a173"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a174"></a><span class="src-doc"> * Gets the account identified by the given id.</span></div></li>
<li><div class="src-line"><a name="a175"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a176"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">IUser </span><span class="src-doc-var">$user </span><span class="src-doc">account owner.</span></div></li>
<li><div class="src-line"><a name="a177"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$account_id </span><span class="src-doc">the id of the account to retrieve.</span></div></li>
<li><div class="src-line"><a name="a178"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">IAccount </span></div></li>
<li><div class="src-line"><a name="a179"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a180"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a181"></a><span class="src-doc"> * owner of the account.</span></div></li>
<li><div class="src-line"><a name="a182"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a183"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_account">get_account</a><span class="src-sym">(</span><span class="src-var">$account_id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a184"></a> </div></li>
<li><div class="src-line"><a name="a185"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a186"></a><span class="src-doc"> * Removes all accounts identified by the given ids. The</span></div></li>
<li><div class="src-line"><a name="a187"></a><span class="src-doc"> * corresponding transactions are automatically removed by triggers</span></div></li>
<li><div class="src-line"><a name="a188"></a><span class="src-doc"> * when the each account is destroyed.</span></div></li>
<li><div class="src-line"><a name="a189"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a190"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$account_ids </span><span class="src-doc">ids of the accounts to remove.</span></div></li>
<li><div class="src-line"><a name="a191"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a192"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a193"></a><span class="src-doc"> * owner of one account.</span></div></li>
<li><div class="src-line"><a name="a194"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a195"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodremove_all_accounts">remove_all_accounts</a><span class="src-sym">(</span><span class="src-var">$account_ids</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a196"></a> </div></li>
<li><div class="src-line"><a name="a197"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a198"></a><span class="src-doc"> * Gets the user's accounts.</span></div></li>
<li><div class="src-line"><a name="a199"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a200"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">list of IAccount owned by this user.</span></div></li>
<li><div class="src-line"><a name="a201"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException</span></div></li>
<li><div class="src-line"><a name="a202"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a203"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_accounts">get_accounts</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a204"></a> </div></li>
<li><div class="src-line"><a name="a205"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a206"></a><span class="src-doc"> * Gets the user's opened accounts.</span></div></li>
<li><div class="src-line"><a name="a207"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a208"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">list of opened IAccount owned by this user.</span></div></li>
<li><div class="src-line"><a name="a209"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException</span></div></li>
<li><div class="src-line"><a name="a210"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a211"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_opened_accounts">get_opened_accounts</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a212"></a> </div></li>
<li><div class="src-line"><a name="a213"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a214"></a><span class="src-doc"> * Returns the number of opened accounts owner by this user.</span></div></li>
<li><div class="src-line"><a name="a215"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a216"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span></div></li>
<li><div class="src-line"><a name="a217"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a218"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_number_of_opened_accounts">get_number_of_opened_accounts</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a219"></a> </div></li>
<li><div class="src-line"><a name="a220"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a221"></a><span class="src-doc"> * Returns the transaction identified by the given id.</span></div></li>
<li><div class="src-line"><a name="a222"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a223"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$transaction_id </span><span class="src-doc">the id of the transaction to retrieve.</span></div></li>
<li><div class="src-line"><a name="a224"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">Transaction </span></div></li>
<li><div class="src-line"><a name="a225"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a226"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a227"></a><span class="src-doc"> * owner of the transaction.</span></div></li>
<li><div class="src-line"><a name="a228"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a229"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_transaction">get_transaction</a><span class="src-sym">(</span><span class="src-var">$transaction_id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a230"></a> </div></li>
<li><div class="src-line"><a name="a231"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a232"></a><span class="src-doc"> * Removes all transactions identified by the given ids.</span></div></li>
<li><div class="src-line"><a name="a233"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a234"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$transaction_ids </span><span class="src-doc">transaction ids of the transactions</span></div></li>
<li><div class="src-line"><a name="a235"></a><span class="src-doc"> * to remove.</span></div></li>
<li><div class="src-line"><a name="a236"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a237"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a238"></a><span class="src-doc"> * owner of the account concerned by one transaction.</span></div></li>
<li><div class="src-line"><a name="a239"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a240"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodremove_all_transactions">remove_all_transactions</a><span class="src-sym">(</span><span class="src-var">$transaction_ids</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a241"></a> </div></li>
<li><div class="src-line"><a name="a242"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a243"></a><span class="src-doc"> * Validates all transactions identified by the given ids.</span></div></li>
<li><div class="src-line"><a name="a244"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a245"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$transaction_ids </span><span class="src-doc">transaction ids of the transactions</span></div></li>
<li><div class="src-line"><a name="a246"></a><span class="src-doc"> * to validate.</span></div></li>
<li><div class="src-line"><a name="a247"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a248"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a249"></a><span class="src-doc"> * owner of the account concerned by one transaction.</span></div></li>
<li><div class="src-line"><a name="a250"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a251"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodvalidate_all_transactions">validate_all_transactions</a><span class="src-sym">(</span><span class="src-var">$transaction_ids</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a252"></a> </div></li>
<li><div class="src-line"><a name="a253"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a254"></a><span class="src-doc"> * Gets the transaction template identified by the given id.</span></div></li>
<li><div class="src-line"><a name="a255"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a256"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$transaction_template_id </span><span class="src-doc">the id of the transaction</span></div></li>
<li><div class="src-line"><a name="a257"></a><span class="src-doc"> * template to retrieve.</span></div></li>
<li><div class="src-line"><a name="a258"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">TransactionTemplate </span></div></li>
<li><div class="src-line"><a name="a259"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException</span></div></li>
<li><div class="src-line"><a name="a260"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a261"></a><span class="src-doc"> * owner of the account concerned by the transaction template.</span></div></li>
<li><div class="src-line"><a name="a262"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a263"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_transaction_template">get_transaction_template</a><span class="src-sym">(</span><span class="src-var">$transaction_template_id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a264"></a> </div></li>
<li><div class="src-line"><a name="a265"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a266"></a><span class="src-doc"> * Gets all transaction templates defined by this user.</span></div></li>
<li><div class="src-line"><a name="a267"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a268"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">list of ITransaction.</span></div></li>
<li><div class="src-line"><a name="a269"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> UserException</span></div></li>
<li><div class="src-line"><a name="a270"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a271"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodget_transaction_templates">get_transaction_templates</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a272"></a> </div></li>
<li><div class="src-line"><a name="a273"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a274"></a><span class="src-doc"> * Removes all transactions identified by the given ids.</span></div></li>
<li><div class="src-line"><a name="a275"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a276"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$transaction_template_ids </span><span class="src-doc">ids of the transactions</span></div></li>
<li><div class="src-line"><a name="a277"></a><span class="src-doc"> * template to remove.</span></div></li>
<li><div class="src-line"><a name="a278"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a279"></a><span class="src-doc"> * owner of the account concerned by one transaction template.</span></div></li>
<li><div class="src-line"><a name="a280"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a281"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodremove_all_transaction_templates">remove_all_transaction_templates</a><span class="src-sym">(</span><span class="src-var">$transaction_template_ids</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a282"></a> </div></li>
<li><div class="src-line"><a name="a283"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a284"></a><span class="src-doc"> * Creates new transactions from the transaction templates</span></div></li>
<li><div class="src-line"><a name="a285"></a><span class="src-doc"> * identified by the given ids.</span></div></li>
<li><div class="src-line"><a name="a286"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a287"></a><span class="src-doc"> * (used to check that we don't apply transaction templates of</span></div></li>
<li><div class="src-line"><a name="a288"></a><span class="src-doc"> * another user).</span></div></li>
<li><div class="src-line"><a name="a289"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$transaction_template_ids </span><span class="src-doc">ids of the transactions</span></div></li>
<li><div class="src-line"><a name="a290"></a><span class="src-doc"> * template to apply.</span></div></li>
<li><div class="src-line"><a name="a291"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> IllegalArgumentException if one transaction cannot be</span></div></li>
<li><div class="src-line"><a name="a292"></a><span class="src-doc"> * created.</span></div></li>
<li><div class="src-line"><a name="a293"></a><span class="src-doc"> * </span><span class="src-doc-tag">@exception</span><span class="src-doc"> PermissionDeniedException if this user is not the</span></div></li>
<li><div class="src-line"><a name="a294"></a><span class="src-doc"> * owner of the account concerned by one transaction template.</span></div></li>
<li><div class="src-line"><a name="a295"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a296"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodapply_all_transaction_templates">apply_all_transaction_templates</a><span class="src-sym">(</span><span class="src-var">$transaction_template_ids</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a297"></a> </div></li>
<li><div class="src-line"><a name="a298"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a299"></a><span class="src-doc"> * Signs in into "My SWAM" space.</span></div></li>
<li><div class="src-line"><a name="a300"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a301"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodsign_in">sign_in</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a302"></a> </div></li>
<li><div class="src-line"><a name="a303"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a304"></a><span class="src-doc"> * Signs out from "My SWAM" space.</span></div></li>
<li><div class="src-line"><a name="a305"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a306"></a> <span class="src-key">function </span><a href="../swam/IUser.html#methodsign_out">sign_out</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a307"></a><span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a308"></a> </div></li>
<li><div class="src-line"><a name="a309"></a><span class="src-php">?></span></div></li>
</ol></div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 20 Aug 2009 01:04:17 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</body>
</html>