OSB_LIB::MidMonthBillcycle Class Reference

Inheritance diagram for OSB_LIB::MidMonthBillcycle:

[legend]Collaboration diagram for OSB_LIB::MidMonthBillcycle:

Detailed Description

This billcycle implementation splits each month into two intervals.

This billcycle is specialized to allow `half-monthly billing'. It generates two billing periods per month. One from the end date of the last billing period (normally this means from the first day of the month) up to but excluding the day configured as `mid-month' (1-31). The second billing period is from `mid-month' up to and including the last day of the month.

Definition at line 330 of file billcycle.h.

Public Types

typedef std::auto_ptr< MidMonthBillcycle > AutoPtr
Short-cut for an auto pointer.

Public Member Functions

MidMonthBillcycle ()
Default constructor.
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.

Read access to data members

int midMonth () const
int minPeriod () const

Private Member Functions

virtual Billcycle * clone_ () const
Internal virtual copy constructor.

Private Attributes

int midMonth_
Day of month used to split it.
int minPeriod_
Minimum length of a billing period.

Friends

class OSB_DB::BillcycleGw

Member Typedef Documentation

typedef std::auto_ptr<MidMonthBillcycle> OSB_LIB::MidMonthBillcycle::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 334 of file billcycle.h.

Constructor & Destructor Documentation

OSB_LIB::MidMonthBillcycle::MidMonthBillcycle ( ) [inline]

Default constructor.

Definition at line 337 of file billcycle.h.

Member Function Documentation

Date OSB_LIB::MidMonthBillcycle::addBillingPeriod ( const Date & from ) const [virtual]

Add a billing period to the given start date.

The billing periods of mid-month billcycle are from the 1st of a month to the day of the month (exclusive) configured in the mid-month parameter and from this day to the last day of the month.

Parameters:

from

Start date of the billing period.