OSB_LIB::TaxKey Class Reference

Collaboration diagram for OSB_LIB::TaxKey:

Collaboration graph
[legend]
List of all members.

Detailed Description

TaxKey models bookkeeping tax keys.

Definition at line 101 of file taxkey.h.

Public Types

Public Member Functions

Read access to data members

Private Attributes

Friends


Member Typedef Documentation

typedef Id<TaxKey> OSB_LIB::TaxKey::Oid

Object id of TaxKey.

Definition at line 105 of file taxkey.h.


Constructor & Destructor Documentation

OSB_LIB::TaxKey::TaxKey ( Oid  oid = Oid(ID_NOT_SET)  )  [inline]

Constructor with object id.

Definition at line 108 of file taxkey.h.

OSB_LIB::TaxKey::TaxKey ( const Oid oid,
const std::string &  name,
const TaxKeyType  tkt,
bool  wildCard = false 
) [inline]

Constructor with object id, name, type and wildCard.

Definition at line 111 of file taxkey.h.


Member Function Documentation

bool OSB_LIB::TaxKey::insert ( const OSB_DB::Session session  ) 

Insert a tax key to the database.

Set the generated oid if success.

Parameters:
session Database session to use, transactions are not commited.
Returns:
True if the object was inserted into the database.

const std::string& OSB_LIB::TaxKey::name (  )  const [inline]

Definition at line 121 of file taxkey.h.

References name_.

const Oid& OSB_LIB::TaxKey::oid (  )  const [inline]

Definition at line 120 of file taxkey.h.

References oid_.

bool OSB_LIB::TaxKey::read ( const OSB_DB::Session session  ) 

Read a tax key from the database.

Parameters:
session Database session to use, transactions are not commited.
Returns:
True if the object was found and read from the database, else false.

bool OSB_LIB::TaxKey::remove ( const OSB_DB::Session session  ) 

Remove a tax key from the database.

Parameters:
session Database session to use, transactions are not commited.
Returns:
True if the item was found and deleted from the database, else false.

const TaxKeyType& OSB_LIB::TaxKey::type (  )  const [inline]

Definition at line 122 of file taxkey.h.

References type_.

bool OSB_LIB::TaxKey::wildCard (  )  const [inline]

Definition at line 123 of file taxkey.h.

References wildCard_.


Friends And Related Function Documentation

friend class OSB_DB::TaxKeyGw [friend]

Definition at line 102 of file taxkey.h.


Member Data Documentation

std::string OSB_LIB::TaxKey::name_ [private]

Name of TaxKey.

Definition at line 158 of file taxkey.h.

Referenced by name().

Oid OSB_LIB::TaxKey::oid_ [private]

Oid of TaxKey.

Definition at line 157 of file taxkey.h.

Referenced by oid().

TaxKeyType OSB_LIB::TaxKey::type_ [private]

Type of TaxKey.

Definition at line 159 of file taxkey.h.

Referenced by type().

bool OSB_LIB::TaxKey::wildCard_ [private]

Flag if this tax key is catch-all, which matches any value evaluated.

Definition at line 164 of file taxkey.h.

Referenced by wildCard().


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:13:22 2006 for OSB Library by  doxygen 1.4.7