OSB_LIB::BackDatedObject Class Reference

Collaboration diagram for OSB_LIB::BackDatedObject:

[legend]List of all members.

---

Detailed Description

This class hold information on the type and versions of tariff object that have been back-dated.

Definition at line 63 of file backdatedobject.h.

Public Types

• typedef Id< BackDatedObject > Oid

  Type-safe definition of object id.
  

• typedef Id2< BackDatedObject > ToId

  Type-safe definition of back-dated tariff object.
  

• toTfVersion = 'f'

  Tariff version object.
  

• enum TariffObject { toTfVersion = 'f' }

  Type of tariff objects to be back-dated. More...
  

Public Member Functions

• BackDatedObject (const Oid &oid, const ToId &patched, const ToId &substitute, TariffObject tariffObject, const Date &releasedDate, bool resubmitted=false)

  Constructor with all data members.
  

• const Oid & oid () const

  Return unique object id.
  

• const ToId & patched () const

  Return type-safe id of tariff object that has been patched.
  

• const ToId & substitute () const

  Return id of tariff object that replaces the patched version.
  

• const Date & patchReleasedDate () const

  Return released date of substitute tariff object.
  

• TariffObject tariffObject () const

  Return type of tariff object.
  

• bool resubmitted () const

  Indicate if tariff object has been resubmitted for re-rating.
  

• bool insert (const OSB_DB::Session &session)

  Tariff object insert itself into the datbase.
  

Static Public Member Functions

• static char toChar (TariffObject to)

  Convert TariffObject to one character database code.
  

• static TariffObject toTariffObject (char to)

  Convert character database code to TariffObject.
  

Private Attributes

• Oid oid_

  Unique id of BackDatedObject.
  

• ToId patched_

  Object id of replaced object.
  

• ToId substitute_

  Object id of substitute object.
  

• TariffObject tariffObject_

  Type of tariff object.
  

• Date patchReleasedDate_

  Released date of substitute object.
  

• bool resubmitted_

  Indicate if object has been re-submitted for re-rating.
  

---

Member Typedef Documentation

typedef Id<BackDatedObject> OSB_LIB::BackDatedObject::Oid

Type-safe definition of object id.

Definition at line 66 of file backdatedobject.h.

typedef Id2<BackDatedObject> OSB_LIB::BackDatedObject::ToId

Type-safe definition of back-dated tariff object.

Definition at line 69 of file backdatedobject.h.

---

Member Enumeration Documentation

enum OSB_LIB::BackDatedObject::TariffObject

Type of tariff objects to be back-dated.

Enumerator:

toTfVersion

Tariff version object.

Definition at line 75 of file backdatedobject.h.

---

Constructor & Destructor Documentation

OSB_LIB::BackDatedObject::BackDatedObject	(	const Oid &	oid,
		const ToId &	patched,
		const ToId &	substitute,
		TariffObject	tariffObject,
		const Date &	releasedDate,
		bool	resubmitted = false
	)

Constructor with all data members.

---

Member Function Documentation

bool OSB_LIB::BackDatedObject::insert

(

const OSB_DB::Session &

session

)

Tariff object insert itself into the datbase.

const Oid& OSB_LIB::BackDatedObject::oid

(

)

const [inline]

Return unique object id.

Definition at line 111 of file backdatedobject.h.

References oid_.

const ToId& OSB_LIB::BackDatedObject::patched

(

)

const [inline]

Return type-safe id of tariff object that has been patched.

Definition at line 114 of file backdatedobject.h.

References patched_.

const Date& OSB_LIB::BackDatedObject::patchReleasedDate

(

)

const [inline]

Return released date of substitute tariff object.

Definition at line 120 of file backdatedobject.h.

References patchReleasedDate_.

bool OSB_LIB::BackDatedObject::resubmitted

(

)

const [inline]

Indicate if tariff object has been resubmitted for re-rating.

Definition at line 129 of file backdatedobject.h.

References resubmitted_.

const ToId& OSB_LIB::BackDatedObject::substitute

(

)

const [inline]

Return id of tariff object that replaces the patched version.

Definition at line 117 of file backdatedobject.h.

References substitute_.

TariffObject OSB_LIB::BackDatedObject::tariffObject

(

)

const [inline]

Return type of tariff object.

Definition at line 126 of file backdatedobject.h.

References tariffObject_.

static char OSB_LIB::BackDatedObject::toChar

(

TariffObject

to

)

[static]

Convert TariffObject to one character database code.

Parameters:

to

TariffObject value.

Exceptions:

OsbException

if to is not defined.

Returns:

One character database code.

static TariffObject OSB_LIB::BackDatedObject::toTariffObject

(

char

to

)

[static]

Convert character database code to TariffObject.

Parameters:

to

One char database code.

Exceptions:

OsbException

if to is not defined.

Returns:

TariffObject enum value.

---

Member Data Documentation

Oid OSB_LIB::BackDatedObject::oid_ [private]

Unique id of BackDatedObject.

Definition at line 136 of file backdatedobject.h.

Referenced by oid().

ToId OSB_LIB::BackDatedObject::patched_ [private]

Object id of replaced object.

Definition at line 138 of file backdatedobject.h.

Referenced by patched().

Date OSB_LIB::BackDatedObject::patchReleasedDate_ [private]

Released date of substitute object.

Definition at line 144 of file backdatedobject.h.

Referenced by patchReleasedDate().

bool OSB_LIB::BackDatedObject::resubmitted_ [private]

Indicate if object has been re-submitted for re-rating.

Definition at line 147 of file backdatedobject.h.

Referenced by resubmitted().

ToId OSB_LIB::BackDatedObject::substitute_ [private]

Object id of substitute object.

Definition at line 140 of file backdatedobject.h.

Referenced by substitute().

TariffObject OSB_LIB::BackDatedObject::tariffObject_ [private]

Type of tariff object.

Definition at line 142 of file backdatedobject.h.

Referenced by tariffObject().

---

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

• backdatedobject.h

---