OSB_LIB::StatusChange Class Reference

Collaboration diagram for OSB_LIB::StatusChange:

[legend]List of all members.

---

Detailed Description

Effective activation status.

The class describes one applied status change for an entity of the contract related classes.

Definition at line 71 of file statuschange.h.

Public Types

• typedef Id< StatusChange > Oid

  Typesave unique identifier, link to database table.
  

Public Member Functions

• StatusChange (const Oid &oid=Oid())

  Constructor with optional object id.
  

• const Oid oid () const

  Get the status change id.
  

• void adjustNewStatus (const Status &prefStatus)

  Adjust the new status to the preferred status.
  

• GeValidFrom geValidFrom () const

  Get predicate for greater-equal comparision of validFrom().
  

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

  Read data for a status change.
  

• std::ostream & write (std::ostream &os) const

  Print to an output stream.
  

Public Attributes

• Id< StatusRequest > requestId_

  The request that triggered the status change.
  

• StatusValue oldStatus_

  Previous, old status of entity.
  

• StatusValue newStatus_

  New status of entity.
  

• StatusReason::Oid reasonId_

  Reason for the status change.
  

• DateTime validFrom_

  Date when the status change was applied, i.e. became effective.
  

Private Attributes

• Oid oid_

  Unique identification: database link.
  

Friends

• class OSB_DB::StatusChangeGw

  Allow to set the object id.
  

Classes

• class GeValidFrom

  Predicate: compare status requests by >= validFrom(). More...
  

---

Member Typedef Documentation

typedef Id<StatusChange> OSB_LIB::StatusChange::Oid

Typesave unique identifier, link to database table.

Definition at line 77 of file statuschange.h.

---

Constructor & Destructor Documentation

OSB_LIB::StatusChange::StatusChange

(

const Oid &

oid = Oid()

)

[inline, explicit]

Constructor with optional object id.

Parameters:

oid

Database id of the status change.

oldStatus_ and newStatus_ are set to svNone.

Definition at line 305 of file statuschange.h.

---

Member Function Documentation

void OSB_LIB::StatusChange::adjustNewStatus

(

const Status &

prefStatus

)

[inline]

Adjust the new status to the preferred status.

Parameters:

prefStatus

Preferred status to use.

Definition at line 317 of file statuschange.h.

References OSB_LIB::mkChildStatus(), newStatus_, and OSB_LIB::Status::status().

GeValidFrom OSB_LIB::StatusChange::geValidFrom

(

)

const

Get predicate for greater-equal comparision of validFrom().

const StatusChange::Oid OSB_LIB::StatusChange::oid

(

)

const [inline]

Get the status change id.

Definition at line 312 of file statuschange.h.

References oid_.

Referenced by OSB_LIB::StatusChanges::Cmp::operator()().

bool OSB_LIB::StatusChange::read

(

const OSB_DB::Session &

session

)

Read data for a status change.

This function can read a status change based on the given object id and populate to the object.

Parameters:

session

Database session to use.

Returns:

True if read succeed.

Exceptions:

OsbException

as specified by the gateway class (see there).

std::ostream& OSB_LIB::StatusChange::write

(

std::ostream &

os

)

const

Print to an output stream.

Parameters:

os

Output stream to write to.

Returns:

Reference to argument ostream.

---

Friends And Related Function Documentation

friend class OSB_DB::StatusChangeGw [friend]

Allow to set the object id.

Definition at line 73 of file statuschange.h.

---

Member Data Documentation

StatusValue OSB_LIB::StatusChange::newStatus_

New status of entity.

Definition at line 142 of file statuschange.h.

Referenced by adjustNewStatus().

Oid OSB_LIB::StatusChange::oid_ [private]

Unique identification: database link.

Definition at line 135 of file statuschange.h.

Referenced by oid().

StatusValue OSB_LIB::StatusChange::oldStatus_

Previous, old status of entity.

Definition at line 140 of file statuschange.h.

StatusReason::Oid OSB_LIB::StatusChange::reasonId_

Reason for the status change.

Definition at line 144 of file statuschange.h.

Id<StatusRequest> OSB_LIB::StatusChange::requestId_

The request that triggered the status change.

Definition at line 138 of file statuschange.h.

DateTime OSB_LIB::StatusChange::validFrom_

Date when the status change was applied, i.e. became effective.

Definition at line 149 of file statuschange.h.

Referenced by OSB_LIB::StatusChanges::Cmp::operator()(), and OSB_LIB::StatusChange::GeValidFrom::operator()().

---

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

• statuschange.h

---