OSB_LIB::E164 Class Reference

Inheritance diagram for OSB_LIB::E164:

[legend]Collaboration diagram for OSB_LIB::E164:

[legend]List of all members.

---

Detailed Description

E.164 connections.

This class stores the details of a E.164 connection. The values in E.164 format is broken down into Country Code(CC), National Destination Code(NDC) and Subscriber Number(SN).

Definition at line 84 of file e164.h.

Database operations:

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

  Read a E164 from database.
  

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

  Insert a E164 into database.
  

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

  Remove a E164 from database.
  

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

  Update a E164 in the database.
  

Public Types

• typedef Id< E164 > Oid

  Type-safe, unique id of E.164 connections.
  

• typedef Id< ConnectionPt > CpId

  Type-safe, unique id of a connection point.
  

Public Member Functions

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

  Default constructor with optional object id.
  

Read access to data members

• const Oid & oid () const

  Get the unique E.164 id.
  

• const CpId & cpId () const

  Get the unique conection point.
  

• NwAddress::Ton ton () const

  Get type of number of E.164 connection.
  

• const std::string & value () const

  Get value of E.164 connection.
  

Modify data members:

• void setTon (NwAddress::Ton ton)

  Set type of number of E.164 connection.
  

• void setValue (const std::string &value)

  Set value of E.164 connection.
  

• void setCpId (const CpId &cpId)

  Set connection point id of E164 connection.
  

Static Public Attributes

• static const std::string catchall_

  Catch-all value of a E164: "*".
  

Private Member Functions

Status changes:

• bool freeze (const OSB_DB::Session &session, OsbErrors &errors)

  Set the status from editable to standby.
  

• bool release (const OSB_DB::Session &session, OsbErrors &errors)

  Set the status from standby to release.
  

• bool revoke (const OSB_DB::Session &session, OsbErrors &errors)

  Set the status from release to standby.
  

• bool unfreeze (const OSB_DB::Session &session, OsbErrors &errors)

  Set the status from standby to editable.
  

Private Attributes

• Oid oid_

  Unique id of E.164.
  

• NwAddress::Ton ton_

  Type of number of E.164.
  

• std::string value_

  Value of E.164.
  

• CpId cpId_

  Unique id of connection point.
  

Friends

• class OSB_DB::E164Gw

  Allow create function at the gateway to assign unique id to newly created E164 objects.
  

• class TariffCatalogue

  Tariff Catalogue is the only object that is allow to invoke the private functions of this class.
  

---

Member Typedef Documentation

typedef Id<ConnectionPt> OSB_LIB::E164::CpId

Type-safe, unique id of a connection point.

Definition at line 105 of file e164.h.

typedef Id<E164> OSB_LIB::E164::Oid

Type-safe, unique id of E.164 connections.

Definition at line 103 of file e164.h.

---

Constructor & Destructor Documentation

OSB_LIB::E164::E164

(

const Oid &

oid = Oid()

)

[explicit]

Default constructor with optional object id.

---

Member Function Documentation

const CpId& OSB_LIB::E164::cpId

(

)

const

Get the unique conection point.

bool OSB_LIB::E164::freeze	(	const OSB_DB::Session &	session,
		OsbErrors &	errors
	)			[private, virtual]

Set the status from editable to standby.

In order to set the status from editable to standby, the following criteria must be fulfilled:

• Object must be in status editable.
• Has a valid connection point configured.

Parameters:

	session	Database session to use.
	errors	Container for error messages if any.

Returns:

true if success else false.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::E164::insert

(

const OSB_DB::Session &

session

)

[private]

Insert a E164 into database.

A new object is inserted. All attributes of the object has been set except object id. The object id will only be set by the function if the insertion is successful.

Parameters:

session

Database session.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Name empty, too long or duplicate. Connection point not set.

const Oid& OSB_LIB::E164::oid

(

)

const

Get the unique E.164 id.

bool OSB_LIB::E164::read

(

const OSB_DB::Session &

session

)

Read a E164 from database.

The object id is used to gather other info from database and then populate all the object's data members.

Parameters:

session

Database session.

Returns:

true if success else false.

bool OSB_LIB::E164::release	(	const OSB_DB::Session &	session,
		OsbErrors &	errors
	)			[private, virtual]

Set the status from standby to release.

In order to set the status from standby to release, the following criteria must be fulfilled:

• Object must be in status standby.
• Start date is in the future.
• End date is either in the future or null (not set).
• End date (if set) is later than start date.

Parameters:

	session	Database session to use.
	errors	Container for error messages if any.

Returns:

true if success else false.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::E164::remove

(

const OSB_DB::Session &

session

)

[private]

Remove a E164 from database.

The function will ensure that the object is in status editable before proceeding. After the function call, oid of this object will be unset to indicate that there is no such entry anymore in the database.

Parameters:

session

Database session.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Object is not editable. Object not found. Object has been modified.

bool OSB_LIB::E164::revoke	(	const OSB_DB::Session &	session,
		OsbErrors &	errors
	)			[private, virtual]

Set the status from release to standby.

In order to set the status from release to standby, the following criteria must be fulfilled:

• Object must be in status released.
• Grace period has expired.

Parameters:

	session	Database session to use.
	errors	Container for error messages if any.

Returns:

true if success else false.

Implements OSB_LIB::ToCfgBase.

void OSB_LIB::E164::setCpId

(

const CpId &

cpId

)

Set connection point id of E164 connection.

Parameters:

cpId

Object id of the E164's connection point.

Exceptions:

OsbException

if: status is not editable cpId is not set.

void OSB_LIB::E164::setTon

(

NwAddress::Ton

ton

)

Set type of number of E.164 connection.

Parameters:

ton

Type of number for the E164.

Exceptions:

OsbException

if: status is not editable. ton is NwAddress::tonNotSet.

void OSB_LIB::E164::setValue

(

const std::string &

value

)

Set value of E.164 connection.

Parameters:

value

New value of E.164 connection.

Exceptions:

OsbException

if: status is not editable value is empty.

NwAddress::Ton OSB_LIB::E164::ton

(

)

const

Get type of number of E.164 connection.

bool OSB_LIB::E164::unfreeze	(	const OSB_DB::Session &	session,
		OsbErrors &	errors
	)			[private, virtual]

Set the status from standby to editable.

In order to set the status from standby to editable, the following criteria must be fulfilled:

• Object must be in status standby.

Parameters:

	session	Database session to use.
	errors	Container for error messages if any.

Returns:

true if success else false.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::E164::update

(

const OSB_DB::Session &

session

)

[private]

Update a E164 in the database.

Old entry in the database indentify by the object id will be replaced with the new data from the passed in, upated object.

Parameters:

session

Database session used.

Returns:

true if success else false.

Exceptions:

OsbException

for the following erros: Object not found. Object has been modified.

const std::string& OSB_LIB::E164::value

(

)

const

Get value of E.164 connection.

---

Friends And Related Function Documentation

friend class OSB_DB::E164Gw [friend]

Allow create function at the gateway to assign unique id to newly created E164 objects.

Definition at line 91 of file e164.h.

friend class TariffCatalogue [friend]

Tariff Catalogue is the only object that is allow to invoke the private functions of this class.

Definition at line 97 of file e164.h.

---

Member Data Documentation

const std::string OSB_LIB::E164::catchall_ [static]

Catch-all value of a E164: "*".

Definition at line 100 of file e164.h.

CpId OSB_LIB::E164::cpId_ [private]

Unique id of connection point.

Definition at line 295 of file e164.h.

Oid OSB_LIB::E164::oid_ [private]

Unique id of E.164.

Definition at line 289 of file e164.h.

NwAddress::Ton OSB_LIB::E164::ton_ [private]

Type of number of E.164.

Definition at line 291 of file e164.h.

std::string OSB_LIB::E164::value_ [private]

Value of E.164.

Definition at line 293 of file e164.h.

---

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

• e164.h

---