OSB_LIB::FilterCond Class Reference

Inheritance diagram for OSB_LIB::FilterCond:

[legend]Collaboration diagram for OSB_LIB::FilterCond:

Detailed Description

Conditions for the filter.

This is the leaf element of the filter expression. This is the base class which contains the object id to identify the filter condition and the filter type (e.g. ftServiceClass,ftTariffClass). It contains the function eval to evaluate the filter condition. This will apply the operator on the target id and the element in the usedservice and return the result.

(e.g. usedservice.serviceClass == targetId)

Definition at line 326 of file filter.h.

Database operations:

bool read (const OSB_DB::Session &session)
Read the filter condition from the database.
bool insert (const OSB_DB::Session &session)
Insert the filter condition into the database.
bool update (const OSB_DB::Session &session)
Update the filter condition in the database.
bool remove (const OSB_DB::Session &session)
Remove the filter condition from the database.

Public Types

typedef Id< FilterCond > Oid
Unique object id for the filter condition.
typedef std::auto_ptr< FilterCond > AutoPtr
Auto pointer to filter condition.

Public Member Functions

FilterCond (const Oid &oid=Oid())
Constructor with oid.
FilterCond (const Oid &oid, const FilterType ft)
Constructor with full info.
virtual ~FilterCond ()
Empty virtual destructor.
AutoPtr clone () const
"Virtual" copy constructor.
virtual bool eval (const Cdr &cdr, const UsedService &us)=0
Evaluate the Cdr, UsedService.
bool isReleased (const OSB_DB::Session &session)
Checks the configured objects are released.
virtual void print ()=0
This is for debugging purpose.

Read access to data members.

const FilterCond::Oid & oid () const
Return the unique id of the filter condition.
long objVs () const
Return the object version.
FilterType fType () const
Return the type of filter.
CfgStatus status () const
Return the status of the object.
const Date & releaseDate () const
Return the release date of the object.

Modify access to data members.

bool setReleaseDate (const Date &date)
Set the release date.

Private Member Functions

virtual FilterCond * clone_ () const =0
Abstract virtual constructor.

Specific database operations for derived class.

The following functions are used to perform derived class specific database operations. For those derived classses that do not have any specific database operation will implement the function to return true.

virtual bool readSpecific (const OSB_DB::Session &session)=0
Read derived class specific data members from database.
virtual bool insSpecific (const OSB_DB::Session &session)=0
Insert derived class specific data members into database.
virtual bool updSpecific (const OSB_DB::Session &session)=0
Update derived class specific data members in the database.
virtual bool removeSpecific (const OSB_DB::Session &session)=0
Remove derived class specific data members from the database.

Status changes.

bool freeze (const OSB_DB::Session &session, std::vector< OsbError > &errors)
Set the status from editable to standby.
bool release (const OSB_DB::Session &session, std::vector< OsbError > &errors)
Set the status from standby to release.
bool revoke (const OSB_DB::Session &session, std::vector< OsbError > &errors)
Set the status from release to standby.
bool unfreeze (const OSB_DB::Session &session, std::vector< OsbError > &errors)
Set the status from standby to editable.

Specific checking before status changes.

These are pure virtual functions which is implemented in the derived class to check the requirement before changing the status. If the derived class doesn't have any checking then it should return true.

virtual bool freezeSpecific (const OSB_DB::Session &session, std::vector< OsbError > &errors)=0
Criteria checking before setting the status from editable to standby.
virtual bool releaseSpecific (const OSB_DB::Session &session, std::vector< OsbError > &errors)=0
Criteria checking before setting the status from standby to release.
virtual bool revokeSpecific (const OSB_DB::Session &session, std::vector< OsbError > &errors)=0
Criteria checking before setting the status from release to standby.
virtual bool unfreezeSpecific (const OSB_DB::Session &session, std::vector< OsbError > &errors)=0
Criteria checking before setting the status from standby to editable.

Private Attributes

Oid oid_
Unique object identifier for filter condition.
FilterType ft_
Type of Filter (e.g. ftServiceClass, ftTariffClass etc).
long objVs_
CfgStatus status_
Status of the object.
Date releaseDate_
Release date of this filter version object.

Friends

struct OSB_DB::FilterCondGw
class FilterManager

Member Typedef Documentation

typedef std::auto_ptr<FilterCond> OSB_LIB::FilterCond::AutoPtr

Auto pointer to filter condition.

Reimplemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

Definition at line 344 of file filter.h.

typedef Id<FilterCond> OSB_LIB::FilterCond::Oid

Unique object id for the filter condition.

Definition at line 341 of file filter.h.

Constructor & Destructor Documentation

OSB_LIB::FilterCond::FilterCond ( const Oid & oid = Oid() )

Constructor with oid.

Parameters:

oid

Unique id of the filter condition object.

OSB_LIB::FilterCond::FilterCond	(	const Oid &	oid,
		const FilterType	ft
	)

Constructor with full info.

Parameters:

	oid	Unique id of the filter condition object.
	ft	Type of Filter.

virtual OSB_LIB::FilterCond::~FilterCond ( ) [virtual]

Empty virtual destructor.

Member Function Documentation

AutoPtr OSB_LIB::FilterCond::clone ( ) const

"Virtual" copy constructor.

Create a newly allocated copy of the filter condition by calling the protected/private member function clone_():

          FilterCond::AutoPtr FilterCond::clone() const
          {
              return AutoPtr(clone_());
          }

Attention:: Classes derived from FilterCond that overwrite clone() MUST implement the function as shown above: The behaviour of the function must not change if called through a reference/pointer of the base or derived class!

All derived classes should overwrite this function returning an auto_ptr of their own type. This pattern allows clients to copy-create a TCS version and prevent memory leaks:

          class Derived : public Base {
          public:
              type std::auto_ptr<Derived> AutoPtr;
              AutoPtr clone() const;
          };

          void b(const Base& b)
          {
              Base::AutoPtr ab = b.clone();
              // Do on ab whatever operations are defined by Base.
          }

          void d(const Derived& d)
          {
              Derived::AutoPtr ad = d.clone();
              // Do on ad whatever is defined for Derived.
          }

Returns:: An auto_ptr to the filter condition.

Reimplemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

virtual FilterCond* OSB_LIB::FilterCond::clone_ ( ) const [private, pure virtual]

Abstract virtual constructor.

Create a copy of the filter condition: Allocate memory and initialize it with the current object. Clients of the class use the public member clone(), that returns an auto_ptr of the appropriate filter condition.

Classes that directly or indirectly inherit from FilterCond should redeclare or define this member function:

The return type is a pointer to their own class.
Concrete leaf classes should declare this member function private.

Returns:: A pointer to the new allocated copy of the filter condition.

Remarks:: The return type for derived classes should be <Derived>*

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

virtual bool OSB_LIB::FilterCond::eval	(	const Cdr &	cdr,
		const UsedService &	us
	)			`[pure virtual]`

Evaluate the Cdr, UsedService.

This will evaluate the usedservice using operator and the target value. If it matches the function will return true else false. (e.g. filter condition is serviceclass == 8. operator is otEqualTo, filter type service class, target id is 8. If the usedservice contains the serviceclass id as 8 then this function will return true for this example).

Parameters:

	cdr	Cdr object to use.
	us	UsedService in the cdr object for evaluation.

Returns:: True if the given used service matches with the target value else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::freeze	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private]`

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.

Parameters:

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

Exceptions:

OsbException

for any database errors.

Returns:: True if status changed to standby else false.

virtual bool OSB_LIB::FilterCond::freezeSpecific	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private, pure virtual]`

Criteria checking before setting the status from editable to standby.

Parameters:

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

Returns:: True if all criteria satisfied else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

FilterType OSB_LIB::FilterCond::fType ( ) const

Return the type of filter.

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

Insert the filter condition into the database.

This will insert the new filter condition object into the database using filter condition gateway.

Parameters:

session

Database session to use.

Exceptions:

Exception

on database errors.

Returns:: True if filter condition object inserted successfully else false.

virtual bool OSB_LIB::FilterCond::insSpecific ( const OSB_DB::Session & session ) [private, pure virtual]

Insert derived class specific data members into database.

Parameters:

session

Database session to use.

Exceptions:

Exception

on database errors.

Returns:: True if the data members inserted successfully else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::isReleased ( const OSB_DB::Session & session )

Checks the configured objects are released.

This will check the local objects, filter condition, left and right hand side filter expressions are released then it will return true else false.

Returns:: True if the objects are released else false.

long OSB_LIB::FilterCond::objVs ( ) const

Return the object version.

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

Return the unique id of the filter condition.

virtual void OSB_LIB::FilterCond::print ( ) [pure virtual]

This is for debugging purpose.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

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

Read the filter condition from the database.

This will read the filter condition from the database using filter condition gateway. Before calling this function the object id should be set because the object id is the primary key to get the filter condition object.

Parameters:

session

Database session to use.

Exceptions:

Exception

for the following:

Object not found

Returns:: True if the filter condition object read successfully else false.

virtual bool OSB_LIB::FilterCond::readSpecific ( const OSB_DB::Session & session ) [private, pure virtual]

Read derived class specific data members from database.

Parameters:

session

Database session to use.

Exceptions:

Exception

if object not found.

Returns:: True if read the data members successfully else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::release	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private]`

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 the status standby.
Release date of this filter condition must be in future.

Parameters:

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

Exceptions:

OsbException

for any database errors.

Returns:: True if status changed to release else false.

const Date& OSB_LIB::FilterCond::releaseDate ( ) const

Return the release date of the object.

virtual bool OSB_LIB::FilterCond::releaseSpecific	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private, pure virtual]`

Criteria checking before setting the status from standby to release.

Parameters:

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

Returns:: True if all criteria satisfied else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::remove ( const OSB_DB::Session & session ) [private]

Remove the filter condition from the database.

This will remove the filter condition object from the datebase using filter condition gateway. The filter condition object is identified using filter condition id.

Parameters:

session

Database session to use.

Exceptions:

Exception

for the following errors:

Object not found.
Foreign key violation.

Returns:: True if filter condition object removed successfully else false.

virtual bool OSB_LIB::FilterCond::removeSpecific ( const OSB_DB::Session & session ) [private, pure virtual]

Remove derived class specific data members from the database.

Parameters:

session

Database session to use.

Exceptions:

Exception

if object not found.

Returns:: true if success else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::revoke	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private]`

Set the status from release to standby.

In order to get the status from release to standby, the following criteria must be fulfilled: Object must be in status released

Parameters:

	session	Database session to use.
	errors	Container of error messages is any.

Exceptions:

OsbException

for any database errors.

Returns:: True if status changed to standby else false.

virtual bool OSB_LIB::FilterCond::revokeSpecific	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private, pure virtual]`

Criteria checking before setting the status from release to standby.

Parameters:

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

Returns:: True if all criteria satisfied else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::setReleaseDate ( const Date & date )

Set the release date.

CfgStatus OSB_LIB::FilterCond::status ( ) const

Return the status of the object.

bool OSB_LIB::FilterCond::unfreeze	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private]`

Set the status from standby to editable.

In order to get 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 of error messages is any.

Exceptions:

OsbException

for any database errors.

Returns:: True if status changed to editable else false.

virtual bool OSB_LIB::FilterCond::unfreezeSpecific	(	const OSB_DB::Session &	session,
		std::vector< OsbError > &	errors
	)			`[private, pure virtual]`

Criteria checking before setting the status from standby to editable.

Parameters:

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

Returns:: True if all criteria satisfied else false.

Implemented in OSB_LIB::ScFilter, and OSB_LIB::TcFilter.

bool OSB_LIB::FilterCond::update ( const OSB_DB::Session & session ) [private]

Update the filter condition in the database.

This will update the filter condition object with the current values using filter condition gateway. The filter condition object is identified using filter condition id.

Parameters:

session

Database session to use.

Exceptions:

Exception

if object not found.