OSB_LIB::StatusReason Class Reference

Collaboration diagram for OSB_LIB::StatusReason:

[legend]List of all members.

---

Detailed Description

Reason for a status change.

StatusReason describes the possible reasons for a status change of an Associate, Contract, PersProduct or PersProductNode.

Definition at line 211 of file status.h.

Public Types

• typedef Id< StatusReason > Oid

  Unique typesafe object identification.
  

• notDefined = -1

  Undefined.
  

• associate = 1

  Associate.
  

• contract = 2

  Contract.
  

• persProduct = 4

  PersProduct.
  

• persProductNode = 8

  PersProductNode.
  

• all = 15

  All entities.
  

• enum Applicable {
    notDefined = -1, associate = 1, contract = 2, persProduct = 4,
    persProductNode = 8, all = 15
  }

  Entity for which a status reason may apply. More...
  

Public Member Functions

• StatusReason (const Oid &oid)

  Constructor with object identifier.
  

• const Oid & oid () const

  Read access to object id.
  

• const std::string & name () const

  Read access to name.
  

• const std::string & des () const

  Read access to description.
  

• StatusValue oldStatus () const

  Old status.
  

• StatusValue newStatus () const

  New status.
  

• bool operator== (const StatusReason &rhs)

  Compare by object id.
  

Static Public Member Functions

• static Oid creation ()

  The status reason for newly created entities.
  

Private Attributes

• Oid oid_

  Unique id: database link.
  

• std::string name_

  Name of reason.
  

• std::string des_

  Description of reason.
  

• Applicable applies_

  Bitmask of entities where the reason can be applied.
  

• StatusValue oldStatus_

  Old (current) status.
  

• StatusValue newStatus_

  New status (after change).
  

Static Private Attributes

• static const long creationId_ = 1

  The reason id used for newly created entities.
  

Friends

• class OSB_DB::StatusReasonGw

  Construct an object from database.
  

---

Member Typedef Documentation

typedef Id<StatusReason> OSB_LIB::StatusReason::Oid

Unique typesafe object identification.

Definition at line 220 of file status.h.

---

Member Enumeration Documentation

enum OSB_LIB::StatusReason::Applicable

Entity for which a status reason may apply.

Applicable defines for whom a status reason is applicable. The values can be combined to a bitmask as needed.

Enumerator:

notDefined	Undefined.
associate	Associate.
contract	Contract.
persProduct	PersProduct.
persProductNode	PersProductNode.
all	All entities.

Definition at line 228 of file status.h.

---

Constructor & Destructor Documentation

OSB_LIB::StatusReason::StatusReason

(

const Oid &

oid

)

[inline]

Constructor with object identifier.

Parameters:

oid

Identifier of the status reason.

The following data members are set:

• applies_: notDefined
• oldStatus_: svNone
• newStatus_: svNone

Remarks:

Copy, destructor and assignment by compiler.

Definition at line 250 of file status.h.

---

Member Function Documentation

static Oid OSB_LIB::StatusReason::creation

(

)

[inline, static]

The status reason for newly created entities.

Returns:

StatusReason::Oid(creationId_).

Definition at line 259 of file status.h.

References creationId_.

const std::string& OSB_LIB::StatusReason::des

(

)

const [inline]

Read access to description.

Definition at line 276 of file status.h.

References des_.

const std::string& OSB_LIB::StatusReason::name

(

)

const [inline]

Read access to name.

Definition at line 271 of file status.h.

References name_.

StatusValue OSB_LIB::StatusReason::newStatus

(

)

const [inline]

New status.

Definition at line 286 of file status.h.

References newStatus_.

const Oid& OSB_LIB::StatusReason::oid

(

)

const [inline]

Read access to object id.

Definition at line 266 of file status.h.

References oid_.

StatusValue OSB_LIB::StatusReason::oldStatus

(

)

const [inline]

Old status.

Definition at line 281 of file status.h.

References oldStatus_.

bool OSB_LIB::StatusReason::operator==

(

const StatusReason &

rhs

)

[inline]

Compare by object id.

Definition at line 292 of file status.h.

References oid_.

---

Friends And Related Function Documentation

friend class OSB_DB::StatusReasonGw [friend]

Construct an object from database.

Definition at line 213 of file status.h.

---

Member Data Documentation

Applicable OSB_LIB::StatusReason::applies_ [private]

Bitmask of entities where the reason can be applied.

Definition at line 302 of file status.h.

const long OSB_LIB::StatusReason::creationId_ = 1 [static, private]

The reason id used for newly created entities.

Definition at line 216 of file status.h.

Referenced by creation().

std::string OSB_LIB::StatusReason::des_ [private]

Description of reason.

Definition at line 300 of file status.h.

Referenced by des().

std::string OSB_LIB::StatusReason::name_ [private]

Name of reason.

Definition at line 299 of file status.h.

Referenced by name().

StatusValue OSB_LIB::StatusReason::newStatus_ [private]

New status (after change).

Definition at line 304 of file status.h.

Referenced by newStatus().

Oid OSB_LIB::StatusReason::oid_ [private]

Unique id: database link.

Definition at line 298 of file status.h.

Referenced by oid(), and operator==().

StatusValue OSB_LIB::StatusReason::oldStatus_ [private]

Old (current) status.

Definition at line 303 of file status.h.

Referenced by oldStatus().

---

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

• status.h

---