Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

HBCI::Customer Class Reference

Represents the Customer of a Bank in HBCI (which is a specific role of a User). More...

#include <customer.h>

List of all members.

Public Methods

 Customer (Pointer< User > u, const string &id, const string &custName="")
 Customer (const Customer &cu)
 ~Customer ()
Pointer< Useruser () const
const string & custId () const
const string & custName () const
void setCustName (const string &n)


Detailed Description

Represents the Customer of a Bank in HBCI (which is a specific role of a User).

HBCI knows two kinds of id:

The User is the owner of the security medium, wheras the Customer defines the role the user wants to play. Your bank may decide to assign multiple customer ids to one user id.

Example: You are running a business and want to manage your accounts by means of HBCI. You have one business account and one private account. In this case your bank may present you this situation:

However, in most cases (private home banking) you will only have one user id and one customer id, and the two may or may not be equal. Nevertheless HBCI allows more complex situations.

Author:
Martin Preuss <openhbci@aquamaniac.de>


Constructor & Destructor Documentation

HBCI::Customer::Customer Pointer< User   u,
const string &    id,
const string &    custName = ""
 

Creates a new customer.

Author:
Martin Preuss<openhbci@aquamaniac.de>
Parameters:
u  The user this customer (role) belongs to
id  The customer ID that the bank assigned to this customer.
custName  The name of this customer. You can choose this name as you like, e.g. "business", "private" or whatever you prefer, and you can set this to any arbitrary string you consider helpful.

HBCI::Customer::Customer const Customer &    cu
 

Copy constructor.

HBCI::Customer::~Customer  
 

Default destructor.


Member Function Documentation

const string& HBCI::Customer::custId   const [inline]
 

Returns the customer id assigned to this Customer by the Bank.

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

const string& HBCI::Customer::custName   const [inline]
 

Returns the name of this customer.

Returns the name of the customer, i.e. the role this customer plays. You can choose this name as you like, e.g. "secretary", "private" or whatever you prefer. This member makes it easier for you to distinguish this customers from others, since the raw customer id is quite cryptic in most cases.

void HBCI::Customer::setCustName const string &    n [inline]
 

Sets the name of this customer.

Sets the name of this customer, i.e. the role this customer plays. You can set this to any arbitrary string you consider helpful.

Parameters:
n  Sets this to the new name of the customer.

Pointer<User> HBCI::Customer::user   const [inline]
 

Returns a pointer to the User this customer belongs to.

Author:
Martin Preuss<openhbci@aquamaniac.de>


The documentation for this class was generated from the following file:
Generated on Mon Jun 23 13:41:09 2003 for openhbci by doxygen1.2.17