OSB_LIB::DateBillcycle Class Reference

Inheritance diagram for OSB_LIB::DateBillcycle:

[legend]Collaboration diagram for OSB_LIB::DateBillcycle:

[legend]List of all members.

---

Detailed Description

A simple billcycle implementation.

DateBillcycle is a dummy billcycle which does not define the end of the billing period. Applications can set the end date as they like. This billcycle is typically used to bill all unbilled days up to the current date or a specified billing date.

Definition at line 198 of file billcycle.h.

Public Types

• typedef std::auto_ptr< DateBillcycle > AutoPtr

  Short-cut for an auto pointer.
  

Public Member Functions

• Date addBillingPeriod (const Date &from) const

  Add a billing period to the given start date.
  

• int readSpecific (const OSB_DB::Session &session)

  Read billcycle specific parameters from the database.
  

• AutoPtr clone () const

  Virtual copy construction.
  

Private Member Functions

• virtual Billcycle * clone_ () const

  Internal virtual copy constructor.
  

---

Member Typedef Documentation

typedef std::auto_ptr<DateBillcycle> OSB_LIB::DateBillcycle::AutoPtr

Short-cut for an auto pointer.

For details see quality manual, implementation patterns: Virtual copy construction.

Reimplemented from OSB_LIB::Billcycle.

Definition at line 201 of file billcycle.h.

---

Member Function Documentation

Date OSB_LIB::DateBillcycle::addBillingPeriod

(

const Date &

from

)

const [virtual]

Add a billing period to the given start date.

Date billcycle has no clear idea of what a billing period is. Any date greater than the last billing date can be used as the next billing date. Since we don't know what the billing date is, this function returns Date::notSet().

Parameters:

from

Start date of the billing period.

Returns:

Date::notSet().

Implements OSB_LIB::Billcycle.

AutoPtr OSB_LIB::DateBillcycle::clone

(

)

const

Virtual copy construction.

For details see quality manual, implementation patterns.

Reimplemented from OSB_LIB::Billcycle.

virtual Billcycle* OSB_LIB::DateBillcycle::clone_

(

)

const [private, virtual]

Internal virtual copy constructor.

For details see quality manual, implementation patterns.

Implements OSB_LIB::Billcycle.

int OSB_LIB::DateBillcycle::readSpecific

(

const OSB_DB::Session &

session

)

[virtual]

Read billcycle specific parameters from the database.

Reads the billcycle specific parameters for a concrete billcycle, if any.

Parameters:

session

Database session to use.

Returns:

0 in case of success, 1 if specific data not found, >1 for class specific errors.

Implements OSB_LIB::Billcycle.

---

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

• billcycle.h

---