OSB_DB::TaxKeyGw Class Reference

List of all members.

---

Detailed Description

Database-gateway class for TaxKey and TaxKeyList.

Definition at line 59 of file taxkey-gw.h.

Public Member Functions

• TaxKeyGw ()

  Constructor.
  

• bool fetch (const Session &session, OSB_LIB::TaxKey &tk)

  Load a tax key.
  

• long fetchList (const Session &session, OSB_LIB::TaxKeyList::List &tkList, OSB_LIB::TaxKeyType tkType)

  Load a list of tax keys.
  

• bool insert (const Session &session, OSB_LIB::TaxKey &tk)

  Insert a tax key.
  

• bool remove (const Session &session, const OSB_LIB::TaxKey::Oid &oid)

  Remove a tax key.
  

Private Member Functions

• TaxKeyGw (const TaxKeyGw &rhs)

  Prevent copying: Copy constructor not implemented.
  

• TaxKeyGw & operator= (const TaxKeyGw &rhs)

  Prevent assignment: Assignment not implemented.
  

---

Constructor & Destructor Documentation

OSB_DB::TaxKeyGw::TaxKeyGw

(

const TaxKeyGw &

rhs

)

[private]

Prevent copying: Copy constructor not implemented.

OSB_DB::TaxKeyGw::TaxKeyGw

(

)

[inline]

Constructor.

Definition at line 67 of file taxkey-gw.h.

---

Member Function Documentation

bool OSB_DB::TaxKeyGw::fetch	(	const Session &	session,
		OSB_LIB::TaxKey &	tk
	)

Load a tax key.

This function will load the tax key based on a specific id.

Parameters:

	session	Database session to use.
	tk	Ref of TaxKey which will be fetched.

Returns:

True if populated.

long OSB_DB::TaxKeyGw::fetchList	(	const Session &	session,
		OSB_LIB::TaxKeyList::List &	tkList,
		OSB_LIB::TaxKeyType	tkType
	)

Load a list of tax keys.

This function will load all tax keys of a given type.

Parameters:

	session	Database session to use.
	tkList	Ref of TaxKey which will be fetched.
	tkType	Type of TaxKey.

Returns:

Number of objects populated.

bool OSB_DB::TaxKeyGw::insert	(	const Session &	session,
		OSB_LIB::TaxKey &	tk
	)

Insert a tax key.

Insert a tax key. Set generated oid to tk if success.

Parameters:

	session	Database session to use.
	tk	Reference of tax key to be inserted.

Returns:

True if success.

TaxKeyGw& OSB_DB::TaxKeyGw::operator=

(

const TaxKeyGw &

rhs

)

[private]

Prevent assignment: Assignment not implemented.

bool OSB_DB::TaxKeyGw::remove	(	const Session &	session,
		const OSB_LIB::TaxKey::Oid &	oid
	)

Remove a tax key.

Parameters:

	session	Database session to use.
	oid	Unique id of tax key.

Returns:

True if success.

---

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

• taxkey-gw.h

---