OSB_LIB::ApplicableTaxes Class Reference

Collaboration diagram for OSB_LIB::ApplicableTaxes:

[legend]List of all members.

---

Detailed Description

Manage tax reference data.

Provides a list of applicable taxes per taxkey-triplett and the tax version matching a tax id and reference date.

Definition at line 120 of file appltaxes.h.

Public Member Functions

• ApplicableTaxes ()

  Empty default constructor.
  

• const TaxIdList * findTaxIdList (const TaxkeyTriplet &tkt) const

  Get the taxes for a taxkey triplet.
  

• const TaxIdList & getTaxIdList (const TaxkeyTriplet &tkt) const

  Get the taxes for a taxkey triplet.
  

• const Tax * findTax (const TaxIdVs &vsId) const

  Find a tax.
  

• const Tax & getTax (const TaxIdVs &vsId) const

  Get a tax.
  

• const Tax * findTax (TaxId id, const Date &dt) const

  Find a tax version valid at a specific date.
  

• const Tax & getTax (TaxId id, const Date &dt) const

  Get a tax version valid at a specific date.
  

• void initialise (const OSB_DB::Session &session)

  Load all tax data and build internal lists.
  

• void taxableAmount (MoneyList &, const BaseAmount &, const TaxIdList &) const

  Returns the net amount to be taxed by currency.
  

Statistics:

• long taxIdListsSize ()
• long taxkeyTripletsSize ()
• long taxListSize ()

Debug: print the list of exploded taxkey-triplets.

• void writeTaxIdLists (std::ostream &) const
• void writeTaxkeyTriplets (std::ostream &) const
• void writeTaxList (std::ostream &) const

Private Member Functions

• ApplicableTaxes (const ApplicableTaxes &)

  Prevent copying: not implemented.
  

• ApplicableTaxes & operator= (const ApplicableTaxes &)

  Prevent assignment: not implemented.
  

Private Attributes

• TaxIdLists taxIdLists_

  TaxIdLists is a list of TaxId lists.
  

• TaxkeyTriplets taxkeyTriplets_

  The "exploded" taxkey-triplets list. Each triplet points to a tax-id-list.
  

• TaxList taxList_

  All tax versions.
  

---

Constructor & Destructor Documentation

OSB_LIB::ApplicableTaxes::ApplicableTaxes

(

const ApplicableTaxes &

)

[private]

Prevent copying: not implemented.

OSB_LIB::ApplicableTaxes::ApplicableTaxes

(

)

[inline]

Empty default constructor.

Definition at line 127 of file appltaxes.h.

---

Member Function Documentation

const Tax* OSB_LIB::ApplicableTaxes::findTax	(	TaxId	id,
		const Date &	dt
	)			const [inline]

Find a tax version valid at a specific date.

Parameters:

	id	Id of the tax to find.
	dt	Date to search for.

Returns:

Pointer to the tax version that is valid at dt, 0 if there is no valid version for that date.

Definition at line 173 of file appltaxes.h.

References findTax().

const Tax* OSB_LIB::ApplicableTaxes::findTax

(

const TaxIdVs &

vsId

)

const

Find a tax.

Parameters:

vsId

Id of the tax version to find.

Returns:

Pointer to the tax version for vsId, 0 if not found.

Referenced by findTax().

const TaxIdList* OSB_LIB::ApplicableTaxes::findTaxIdList

(

const TaxkeyTriplet &

tkt

)

const

Get the taxes for a taxkey triplet.

Parameters:

tkt

Taxkey triplet to search.

Returns:

Pointer to the list with the ids of the taxes,
0 if none is configured.

const Tax& OSB_LIB::ApplicableTaxes::getTax	(	TaxId	id,
		const Date &	dt
	)			const [inline]

Get a tax version valid at a specific date.

Parameters:

	id	Id of the tax to find.
	dt	Date to search for.

Exceptions:

OsbException

if there is no valid version for dt.

Returns:

Reference to the tax version that is valid at dt,

Definition at line 184 of file appltaxes.h.

References getTax().

const Tax& OSB_LIB::ApplicableTaxes::getTax

(

const TaxIdVs &

vsId

)

const

Get a tax.

Parameters:

vsId

Id of the tax version to find.

Exceptions:

OsbException

if the tax for vsId is not found.

Returns:

The tax version for vsId.

Referenced by getTax().

const TaxIdList& OSB_LIB::ApplicableTaxes::getTaxIdList

(

const TaxkeyTriplet &

tkt

)

const

Get the taxes for a taxkey triplet.

Parameters:

tkt

Taxkey triplet to search.

Exceptions:

OsbException

if no matching list is found.

Returns:

The list with the ids of the taxes.

void OSB_LIB::ApplicableTaxes::initialise

(

const OSB_DB::Session &

session

)

Load all tax data and build internal lists.

ApplicableTaxes& OSB_LIB::ApplicableTaxes::operator=

(

const ApplicableTaxes &

)

[private]

Prevent assignment: not implemented.

void OSB_LIB::ApplicableTaxes::taxableAmount	(	MoneyList &	,
		const BaseAmount &	,
		const TaxIdList &
	)			const

Returns the net amount to be taxed by currency.

long OSB_LIB::ApplicableTaxes::taxIdListsSize

(

)

[inline]

Definition at line 199 of file appltaxes.h.

References taxIdLists_.

long OSB_LIB::ApplicableTaxes::taxkeyTripletsSize

(

)

[inline]

Definition at line 200 of file appltaxes.h.

References taxkeyTriplets_.

long OSB_LIB::ApplicableTaxes::taxListSize

(

)

[inline]

Definition at line 201 of file appltaxes.h.

References taxList_.

void OSB_LIB::ApplicableTaxes::writeTaxIdLists

(

std::ostream &

)

const

void OSB_LIB::ApplicableTaxes::writeTaxkeyTriplets

(

std::ostream &

)

const

void OSB_LIB::ApplicableTaxes::writeTaxList

(

std::ostream &

)

const

---

Member Data Documentation

TaxIdLists OSB_LIB::ApplicableTaxes::taxIdLists_ [private]

TaxIdLists is a list of TaxId lists.

Definition at line 213 of file appltaxes.h.

Referenced by taxIdListsSize().

TaxkeyTriplets OSB_LIB::ApplicableTaxes::taxkeyTriplets_ [private]

The "exploded" taxkey-triplets list. Each triplet points to a tax-id-list.

Definition at line 219 of file appltaxes.h.

Referenced by taxkeyTripletsSize().

TaxList OSB_LIB::ApplicableTaxes::taxList_ [private]

All tax versions.

Definition at line 222 of file appltaxes.h.

Referenced by taxListSize().

---

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

• appltaxes.h

---