OSB_LIB::ScsVersion Class Reference

Inheritance diagram for OSB_LIB::ScsVersion:

[legend]Collaboration diagram for OSB_LIB::ScsVersion:

Detailed Description

Service class system version is used to group service classes.

This object will keep a list of service class versions that go under this service class system version. Whenever a used service comes into rating, the service class versions under this object will be used to perform the match process.

Definition at line 393 of file serviceclass.h.

Public Types

typedef Id2< ScsVersion > Oid
typedef std::set< ServiceClass::Oid > ScOids
List of used service classes.
typedef std::map< Id< RatedService >,
ServiceClass::Oid > RsScMap
Configuration: map rated service to service class.

Public Member Functions

ScsVersion (const Oid &oid=Oid())
Default constructor with optional object id.
ScsVersion (const ScSystem::Oid &scsId)
Constructor for a new SCS version.
void supportedSc (ScOids &scOids) const
ServiceClass::Oid getSc (Cdr &cdr, UsedService &us) const
Determine the service class of a used service.
bool read (const OSB_DB::Session &session)
Read a service class system version from database.

Read access to data member:

const Oid & oid () const
Return the object id of this object.
ScSystem::Oid scsId () const
Return the service class system id.
const RsScMap & config () const
Get configuration.

Configuration:

void addService (const RatedService::Oid &rsId, const ServiceClass::Oid &scId)
Add a service to configuration.
void delService (const Id< RatedService > &service)
Remove a service from configuration.

Private Member Functions

void refreshMatchingTree ()
Refresh or reconstruct the matching tree.

Modifying Database operations:

bool insert (const OSB_DB::Session &session)
Insert a service class system version into database.
bool remove (const OSB_DB::Session &session)
Remove a service class system version from database.
bool update (const OSB_DB::Session &session)
Update a service class system version in the database.

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_
Database id of this object.
RsScMap config_
List of service class version belong to this object.
MatchingTree mTree_
Matching tree used to determine the rated service.

Friends

struct OSB_DB::ScsVersionGw
The database gateway needs to populate data members after construction.
class TariffCatalogue
Tariff Catalogue is the only object that is allow to invoke the private functions of this class.

Member Typedef Documentation

typedef Id2<ScsVersion> OSB_LIB::ScsVersion::Oid

Unique id of service class system and version number of service class system configuration are kept in template Id2.

Definition at line 409 of file serviceclass.h.

typedef std::map<Id<RatedService>, ServiceClass::Oid> OSB_LIB::ScsVersion::RsScMap

Configuration: map rated service to service class.

Definition at line 413 of file serviceclass.h.

typedef std::set<ServiceClass::Oid> OSB_LIB::ScsVersion::ScOids

List of used service classes.

Definition at line 411 of file serviceclass.h.

Constructor & Destructor Documentation

OSB_LIB::ScsVersion::ScsVersion ( const Oid & oid = Oid() ) [explicit]

Default constructor with optional object id.

OSB_LIB::ScsVersion::ScsVersion ( const ScSystem::Oid & scsId ) [explicit]

Constructor for a new SCS version.

Member Function Documentation

void OSB_LIB::ScsVersion::addService	(	const RatedService::Oid &	rsId,
		const ServiceClass::Oid &	scId
	)

Add a service to configuration.

Parameters:

	rsId	Rated service to add.
	scId	Service class of rsId.

Exceptions:

OsbException

for the following errors:

Object is not editable.
Rated service already configured.

const RsScMap& OSB_LIB::ScsVersion::config ( ) const

Get configuration.

void OSB_LIB::ScsVersion::delService ( const Id< RatedService > & service )

Remove a service from configuration.

Parameters:

service

Rated service to remove.

Exceptions:

OsbException

for the following errors:

Object is not editable.
Rated service to remove not found in configuration.

bool OSB_LIB::ScsVersion::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
Must contain at least one rated service.
The set of service classes must match other released versions of the same SC system.
All rated services must be freezed.
Each service tuples must be unique
(2 rated service may have the same service tuple).

Parameters:

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

Returns:: true if success else false.

Implements OSB_LIB::ToCfgBase.

ServiceClass::Oid OSB_LIB::ScsVersion::getSc	(	Cdr &	cdr,
		UsedService &	us
	)			const

Determine the service class of a used service.

This function determines the applicable service class with the help of a matching tree. This function may seems constant, but it will repopulate the matching tree if needed. This function is not thread safe either.

Parameters:

	cdr	CDR of us.
	us	Used service to evaluate, the function sets its rated service.

Returns:: The service class valid for us.
It is not set if the service class can not be determined.

bool OSB_LIB::ScsVersion::insert ( const OSB_DB::Session & session ) [private]

Insert a service class system version into database.

A new object is inserted. All attribute 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:

Duplicate name.

const Oid& OSB_LIB::ScsVersion::oid ( ) const

Return the object id of this object.

bool OSB_LIB::ScsVersion::read ( const OSB_DB::Session & session )

Read a service class system version from database.

The object id is used to gather other info from database and then populate the object's service tuple list.

Parameters:

session

Database session.

Returns:: true if success else false.

void OSB_LIB::ScsVersion::refreshMatchingTree ( ) [private]

Refresh or reconstruct the matching tree.

bool OSB_LIB::ScsVersion::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.
Release date must be in the future.
No duplicate release date among different versions of the same service class system.
All rated services must be released.

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::ScsVersion::remove ( const OSB_DB::Session & session ) [private]

Remove a service class system version 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 to be removed not found.

bool OSB_LIB::ScsVersion::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.
If refer by a released tariff system version, must have a replacement and the 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.

ScSystem::Oid OSB_LIB::ScsVersion::scsId ( ) const

Return the service class system id.

void OSB_LIB::ScsVersion::supportedSc ( ScOids & scOids ) const

Retrieve all service classes supported.

Parameters:

scOids

Container for the object id of the service classes supported.

bool OSB_LIB::ScsVersion::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.
If refer by a freezed tariff system version, must have a replacement.

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::ScsVersion::update ( const OSB_DB::Session & session ) [private]

Update a service class system version in the database.

Old entry in the database identify by the object id will be replaced with the new data from this object. This function is used internally by other member functions.

Parameters:

session

Database session.