OSB_LIB::TaxKeyList Class Reference

Collaboration diagram for OSB_LIB::TaxKeyList:

[legend]List of all members.

---

Detailed Description

Manager of TaxKeys.

Within TaxKeyList, all tax keys are classified into three vectors of tax keys based on their tax key types.

Remarks:

Default and copy constructor, assignment and destructor by compiler.

Definition at line 177 of file taxkey.h.

Public Types

STL container type definitions

• typedef std::vector< TaxKey > List

  STL container type used to store the tax keys.
  

• typedef List AssociateList

  STL container type used to store the associate tax keys.
  

• typedef List ContractList

  STL container type used to store the contract tax keys.
  

• typedef List ProductList

  STL container type used to store the product tax keys.
  

Public Member Functions

• long read (const OSB_DB::Session &session)

  Read all tax keys from the database.
  

• const List & get (const TaxKeyType tkt) const

  Get the list of tax keys for specific type.
  

• TaxKey::Oid getTaxKeyByName (const std::string &name) const

  Find the tax key based on its name.
  

• const TaxKey & getTaxKey (const TaxKey::Oid &oid) const

  Find the tax key based on the given oid.
  

• const TaxKey * findTaxKey (const TaxKey::Oid &oid) const

  Find the tax key based on the given oid.
  

• void add (const TaxKey &tk)

  Add a tax key into the relative vector of tax keys.
  

• long size () const

  Retrieve size of all tax keys.
  

Private Attributes

• AssociateList aList_

  The vector of associate tax keys.
  

• ContractList cList_

  The vector of contract tax keys.
  

• ProductList pList_

  The vector of product tax keys.
  

---

Member Typedef Documentation

typedef List OSB_LIB::TaxKeyList::AssociateList

STL container type used to store the associate tax keys.

Definition at line 184 of file taxkey.h.

typedef List OSB_LIB::TaxKeyList::ContractList

STL container type used to store the contract tax keys.

Definition at line 186 of file taxkey.h.

typedef std::vector<TaxKey> OSB_LIB::TaxKeyList::List

STL container type used to store the tax keys.

Definition at line 182 of file taxkey.h.

typedef List OSB_LIB::TaxKeyList::ProductList

STL container type used to store the product tax keys.

Definition at line 188 of file taxkey.h.

---

Member Function Documentation

void OSB_LIB::TaxKeyList::add

(

const TaxKey &

tk

)

Add a tax key into the relative vector of tax keys.

Parameters:

tk

Ref of tax key.

const TaxKey* OSB_LIB::TaxKeyList::findTaxKey

(

const TaxKey::Oid &

oid

)

const

Find the tax key based on the given oid.

Parameters:

oid

Oid of the tax key.

Returns:

Pointer to the tax key,
NULL pointer if tax key can not be found.

const List& OSB_LIB::TaxKeyList::get

(

const TaxKeyType

tkt

)

const

Get the list of tax keys for specific type.

Parameters:

tkt

Type of the TaxKey.

Exceptions:

OsbException

if tkt is not valid.

Returns:

Reference to a vector of the type.

const TaxKey& OSB_LIB::TaxKeyList::getTaxKey

(

const TaxKey::Oid &

oid

)

const

Find the tax key based on the given oid.

Parameters:

oid

Oid of the tax key.

Exceptions:

OsbException

if tax key is not found.

Returns:

Reference to the tax key.

TaxKey::Oid OSB_LIB::TaxKeyList::getTaxKeyByName

(

const std::string &

name

)

const

Find the tax key based on its name.

Parameters:

name

Unique name of the tax key.

Returns:

Unique id of tax key if found, else return ID_NOT_SET.

long OSB_LIB::TaxKeyList::read

(

const OSB_DB::Session &

session

)

Read all tax keys from the database.

Read all tax keys and store them into the relative vector.

Parameters:

session

Database session to use, transactions are not commited.

Returns:

Number of tax keys read.

long OSB_LIB::TaxKeyList::size

(

)

const

Retrieve size of all tax keys.

---

Member Data Documentation

AssociateList OSB_LIB::TaxKeyList::aList_ [private]

The vector of associate tax keys.

Definition at line 248 of file taxkey.h.

ContractList OSB_LIB::TaxKeyList::cList_ [private]

The vector of contract tax keys.

Definition at line 249 of file taxkey.h.

ProductList OSB_LIB::TaxKeyList::pList_ [private]

The vector of product tax keys.

Definition at line 250 of file taxkey.h.

---

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

• taxkey.h

---