MyMoneyInstitution Class Reference

#include <mymoneyinstitution.h>

Inheritance diagram for MyMoneyInstitution:

MyMoneyObject MyMoneyKeyValueContainer
Collaboration diagram for MyMoneyInstitution:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 MyMoneyInstitution ()
 MyMoneyInstitution (const QString &name, const QString &city, const QString &street, const QString &postcode, const QString &telephone, const QString &manager, const QString &sortCode)
 ~MyMoneyInstitution ()
 MyMoneyInstitution (const QString &id, const MyMoneyInstitution &right)
 MyMoneyInstitution (const QDomElement &el)
const QString & manager (void) const
const QString & name (void) const
const QString & postcode (void) const
const QString & street (void) const
const QString & telephone (void) const
const QString & town (void) const
const QString & city (void) const
const QString & sortcode (void) const
void setManager (QString manager)
void setName (QString name)
void setPostcode (QString code)
void setStreet (QString street)
void setTelephone (QString tel)
void setTown (QString town)
void setCity (QString town)
void setSortcode (QString code)
void addAccountId (const QString &account)
QString removeAccountId (const QString &account)
const QStringList & accountList (void) const
unsigned int accountCount (void) const
bool operator== (const MyMoneyInstitution &) const
bool operator< (const MyMoneyInstitution &right) const
void writeXML (QDomDocument &document, QDomElement &parent) const
virtual bool hasReferenceTo (const QString &id) const
QPixmap pixmap () const

Private Attributes

QString m_name
QString m_town
QString m_street
QString m_postcode
QString m_telephone
QString m_manager
QString m_sortcode
QStringList m_accountList


Detailed Description

This class represents a Bank contained within a MyMoneyFile object

Author:
Thomas Baumgart

Constructor & Destructor Documentation

MyMoneyInstitution::MyMoneyInstitution (  ) 

This is the constructor for a new empty institution description

MyMoneyInstitution::MyMoneyInstitution ( const QString &  name,
const QString &  city,
const QString &  street,
const QString &  postcode,
const QString &  telephone,
const QString &  manager,
const QString &  sortCode 
)

This is the constructor used by an application to fill the values required for a new institution. This object should then be passed to

See also:
MyMoneyFile::addInstitution

MyMoneyInstitution::~MyMoneyInstitution (  ) 

This is the destructor for any MyMoneyInstitution object

MyMoneyInstitution::MyMoneyInstitution ( const QString &  id,
const MyMoneyInstitution right 
)

This is the constructor for a new institution known to the current file

Parameters:
id id assigned to the new institution object
right institution definition

MyMoneyInstitution::MyMoneyInstitution ( const QDomElement &  el  ) 

This is the constructor for an institution that is described by a QDomElement (e.g. from a file).

Parameters:
el const reference to the QDomElement from which to create the object


Member Function Documentation

const QString& MyMoneyInstitution::manager ( void   )  const [inline]

const QString& MyMoneyInstitution::name ( void   )  const [inline]

const QString& MyMoneyInstitution::postcode ( void   )  const [inline]

const QString& MyMoneyInstitution::street ( void   )  const [inline]

const QString& MyMoneyInstitution::telephone ( void   )  const [inline]

const QString& MyMoneyInstitution::town ( void   )  const [inline]

const QString& MyMoneyInstitution::city ( void   )  const [inline]

const QString& MyMoneyInstitution::sortcode ( void   )  const [inline]

void MyMoneyInstitution::setManager ( QString  manager  )  [inline]

void MyMoneyInstitution::setName ( QString  name  )  [inline]

void MyMoneyInstitution::setPostcode ( QString  code  )  [inline]

void MyMoneyInstitution::setStreet ( QString  street  )  [inline]

void MyMoneyInstitution::setTelephone ( QString  tel  )  [inline]

void MyMoneyInstitution::setTown ( QString  town  )  [inline]

void MyMoneyInstitution::setCity ( QString  town  )  [inline]

void MyMoneyInstitution::setSortcode ( QString  code  )  [inline]

void MyMoneyInstitution::addAccountId ( const QString &  account  ) 

This method adds the id of an account to the account list of this institution It is verified, that the account is only mentioned once.

Parameters:
account id of the account to be added

QString MyMoneyInstitution::removeAccountId ( const QString &  account  ) 

This method deletes the id of an account from the account list of this institution

Parameters:
account id of the account to be deleted
Returns:
id of account deleted, otherwise empty string

const QStringList& MyMoneyInstitution::accountList ( void   )  const [inline]

This method is used to return the set of accounts known to this institution return QStringList of account ids

unsigned int MyMoneyInstitution::accountCount ( void   )  const [inline]

This method returns the number of accounts known to this institution

Returns:
number of accounts

bool MyMoneyInstitution::operator== ( const MyMoneyInstitution  )  const

bool MyMoneyInstitution::operator< ( const MyMoneyInstitution right  )  const

void MyMoneyInstitution::writeXML ( QDomDocument &  document,
QDomElement &  parent 
) const

This method creates a QDomElement for the document under the parent node parent.

Parameters:
document reference to QDomDocument
parent reference to QDomElement parent node

Reimplemented from MyMoneyKeyValueContainer.

virtual bool MyMoneyInstitution::hasReferenceTo ( const QString &  id  )  const [virtual]

This method checks if a reference to the given object exists. It returns, a true if the object is referencing the one requested by the parameter id. If it does not, this method returns false.

Parameters:
id id of the object to be checked for references
Return values:
true This object references object with id id.
false This object does not reference the object with id id.

Implements MyMoneyObject.

QPixmap MyMoneyInstitution::pixmap (  )  const


Member Data Documentation

QString MyMoneyInstitution::m_name [private]

This member variable keeps the name of the institution

QString MyMoneyInstitution::m_town [private]

This member variable keeps the city of the institution

QString MyMoneyInstitution::m_street [private]

This member variable keeps the street of the institution

QString MyMoneyInstitution::m_postcode [private]

This member variable keeps the zip-code of the institution

This member variable keeps the telephone number of the institution

QString MyMoneyInstitution::m_manager [private]

This member variable keeps the name of the representative of the institution

QString MyMoneyInstitution::m_sortcode [private]

This member variable keeps the sort code of the institution. FIXME: I have no idea what it is good for. I keep it because it was in the old engine.

QStringList MyMoneyInstitution::m_accountList [private]

This member variable keeps the sorted list of the account ids available at this institution


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

Generated on Wed Jan 26 13:09:16 2011 for KMyMoney by  doxygen 1.5.6