---

HBCI::User Class Reference

Represents a user of a bank in HBCI. More...

#include <user.h>

List of all members.

Public Methods
	User (Pointer< Bank > b, Pointer< Medium > m, const string &uid, int version, const string &userName, bool knowsSupportedUPDJobs)
	User (const User &cu)
	~User ()
Relation to other objects
Pointer< Bank >	bank () const
Pointer< Medium >	medium () const
const list< Pointer< Customer > > &	customers () const
Pointer< Customer >	findCustomer (const string &i) const
void	addCustomer (Pointer< Customer > cust)
User identification
const string &	userId () const
User information
int	version () const
void	setVersion (int v)
const string &	userName () const
void	setUserName (const string &n)
bool	knowsSupportedJobs ()
	Tells you if you can rely on the result of OutboxJobXXX::isSupported().
void	setKnowsSupportedJobs (bool knowsIt)

---

Detailed Description

Represents a user of a bank in HBCI.

This class represents a user of HBCI at a bank.

A user is the owner of exactly one security medium. A user is identified by its userId.

But to access a HBCI account, a user takes on a given role which is represented by Customer (see there).

Author:

Martin Preuss<openhbci@aquamaniac.de>

---

Constructor & Destructor Documentation

HBCI::User::User (  Pointer< Bank >    b, Pointer< Medium >    m, const string &    uid, int    version, const string &    userName, bool    knowsSupportedUPDJobs )

Constructor. Creates a new user. Do not use this from an application directly; instead, use HBCIAPI::userFactory. Parameters: b  The bank that this user belongs to. m  The medium that this user uses to authenticate himself. uid  The user ID that the bank assigned to this user. version  The UPD version. userName  The clear-text name of this user; this not given by the bank but can be arbitrarily chosen. knowsSupportedUPDJobs  True if the UPD contain all supported jobs

HBCI::User::User (  const User &    cu )

Copy Constructor. Parameters: cu  User that is copied.

HBCI::User::~User (    )

Default Destructor.

---

Member Function Documentation

void HBCI::User::addCustomer (  Pointer< Customer >    cust )

Adds a customer to the list of customers that belong to this * user. Throws an error if this customer already exists. Parameters: cust  The customer to add.

Pointer<Bank> HBCI::User::bank (    )  const [inline]

Returns a pointer to the bank that this user belongs to.

const list<Pointer<Customer> >& HBCI::User::customers (    )  const

Returns a reference to the list of customers. Each customer is a "role" that this user may take during talking to his bank.

Pointer<Customer> HBCI::User::findCustomer (  const string &    i )  const

Searches for the given customer. No wildcards or joker allowed. Author: Martin Preuss<openhbci@aquamaniac.de> Parameters: i  customer id to look for

bool HBCI::User::knowsSupportedJobs (    )  [inline]

Tells you if you can rely on the result of OutboxJobXXX::isSupported(). If this method returns false then we don't have any information if jobs like OutboxJobNewStandingOrder, OutboxJobTransfer ... are supported for the specified Account. If true is returned, you can be sure that the results of OutboxJobTransfer::isSupported() ... are valid.

Pointer<Medium> HBCI::User::medium (    )  const [inline]

Medium that this user owns. Returns a pointer to the secure medium that this user uses to authenticate him/herself.

void HBCI::User::setKnowsSupportedJobs (  bool    knowsIt )  [inline]

See also: knowsSupportedJobs()

void HBCI::User::setUserName (  const string &    n )  [inline]

Set the clear-text name of this user. This is not set by the bank; instead, this can be set by the application to any arbitrary string that is considered to be helpful in identifiying this user. Parameters: n  The user name.

void HBCI::User::setVersion (  int    v )  [inline]

Set the UPD version (User Parameter Data). This value should only be set through the related HBCI::Job. Parameters: v  The version number.

const string& HBCI::User::userId (    )  const [inline]

The user ID that identifies this user to his bank. Usually this string is assigned to the user by the bank.

const string& HBCI::User::userName (    )  const [inline]

Returns the clear-text name of this user. This is not set by the bank; instead, this can be set by the application to any arbitrary string that is considered to be helpful in identifiying this user.

int HBCI::User::version (    )  const [inline]

Returns the UPD version. The UPD (User Parameter Data, "UserParameterDaten") version number is incremented by the bank each time it sends an updated version of the UPD.

---

The documentation for this class was generated from the following file:

• user.h

---