OSB_LIB::RatedPartyEval Class Reference

Inheritance diagram for OSB_LIB::RatedPartyEval:

[legend]Collaboration diagram for OSB_LIB::RatedPartyEval:

Detailed Description

Determine a rated party for network usage.

A rated party evaluator determines if its supported party should be rated for the network usage. See getParty() for details.

Intentionally it is not task of of RatedPartyEval class to check the usage type of the CDR, therefore there's no corresponding data member.

See also:: RpEvalUsgMap which holds the list of evaluators for each usage type.
RpEvalType which defines symbolic constants for all supported types.

Definition at line 78 of file rpeval.h.

Public Types

typedef Id< RatedPartyEval > Oid
Type-safe object identifier.
typedef TypeId< RatedPartyEval > Type
The type of the evaluator.
typedef TypeId< RatedParty > RpType
Short-hand for type of the generated rated party.
noCdr = 1
No CDR should be generated for the evaluated party.
evalError
useRatedParty
Use the rated party as set by the evaluator.
useCache
enum Result { noCdr = 1, evalError, useRatedParty, useCache }
Possible result for getParty(). More...

Public Member Functions

RatedPartyEval (const Oid &oid, const RpType &rpType)
Constructor with object id and supported rated party type.
virtual ~RatedPartyEval ()
Empty virtual destructor.
const Oid & oid () const
Object id.
RpType rpType () const
The type of the rated party generated by the evaluator.
Result evalParty (const Cdr &cdr, RatedParty *rp, OsbError *error) const
Determine the rated party (if applicable).
virtual Type type () const =0
The type the rated party evaluator.
virtual bool requiresCache () const =0
Resource cache needed for the evaluator?
virtual int numParam () const =0
Configuration of evaluator possible?
virtual std::string getParam (int index) const =0
Get a configuration parameter of the evaluator.

Protected Member Functions

RatedPartyEval (const RatedPartyEval &rhs)
Copying for derived classes only.
RatedPartyEval & operator= (const RatedPartyEval &rhs)
Assignment for derived classes only.

Private Member Functions

virtual Result getParty (const Cdr &cdr, RatedParty *rp, OsbError *error) const =0
Determine the rated party (if applicable).
virtual bool setParam (int index, const std::string &param)=0
Set a parameter for the evaluator.

Private Attributes

Oid oid_
Object identifier.
RpType rpType_
The rated party type generated by the evaluator.

Friends

class OSB_DB::RpEvalGw
Allow the gateway to call setParam().

Member Typedef Documentation

typedef Id<RatedPartyEval> OSB_LIB::RatedPartyEval::Oid

Type-safe object identifier.

Definition at line 83 of file rpeval.h.

typedef TypeId<RatedParty> OSB_LIB::RatedPartyEval::RpType

Short-hand for type of the generated rated party.

Definition at line 87 of file rpeval.h.

typedef TypeId<RatedPartyEval> OSB_LIB::RatedPartyEval::Type

The type of the evaluator.

Definition at line 85 of file rpeval.h.

Member Enumeration Documentation

enum OSB_LIB::RatedPartyEval::Result

Possible result for getParty().

Enumerator:

noCdr	No CDR should be generated for the evaluated party.
evalError	An error has occurred during the evaluation of the rated party.
useRatedParty	Use the rated party as set by the evaluator.
useCache	Use the resource cache to determine the tariff system based on RatedParty::resourceKey_.

Definition at line 90 of file rpeval.h.

Constructor & Destructor Documentation

OSB_LIB::RatedPartyEval::RatedPartyEval	(	const Oid &	oid,
		const RpType &	rpType
	)

Constructor with object id and supported rated party type.

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

Empty virtual destructor.

OSB_LIB::RatedPartyEval::RatedPartyEval ( const RatedPartyEval & rhs ) [protected]

Copying for derived classes only.

Member Function Documentation

Result OSB_LIB::RatedPartyEval::evalParty	(	const Cdr &	cdr,
		RatedParty *	rp,
		OsbError *	error
	)			const

Determine the rated party (if applicable).

Parameters:

	cdr	CDR for which to determine the rated party.
	rp	Rated party to populate.
	error	Gets the error detected during the determination of the rated party.

Returns:: The result of the evaluation, see below.

Verifies and sets the rated party type and then calls getParty().

If the function returns useRatedParty:

It must set the rated party type.
It must set the tariff system in RatedParty::tsVersion_.
Optionally sets the id of the contract, the subscribed product and the resource key that was used to identify these two ids.

If the function returns useCache:

It must set the rated party type.
It must set the resource data in RatedParty::resourceKey.

virtual std::string OSB_LIB::RatedPartyEval::getParam ( int index ) const [pure virtual]

Get a configuration parameter of the evaluator.

Parameters:

index

Index of the parameter to retrieve,
the index of the 1st parameter is 0.

Returns:: The value of the parameter as in the database.
It is empty if the concrete evaluator class does not support (need) the parameter.

Note:: This function should not be called when dealing with a concrete rated party evaluator: they should provide functions to

Implemented in OSB_LIB::RpeServedNwAddr, OSB_LIB::RpeServedImsi, OSB_LIB::RpEvalTrunk, and OSB_LIB::RpEvalFixedTs.

virtual Result OSB_LIB::RatedPartyEval::getParty	(	const Cdr &	cdr,
		RatedParty *	rp,
		OsbError *	error
	)			const `[private, pure virtual]`

Determine the rated party (if applicable).

Parameters:

	cdr	CDR for which to determine the rated party.
	rp	Rated party to populate (see below).
	error	Gets the error detected during the determination of the rated party.

Returns:: The result of the evaluation, see below.

The function is called from evalParty() which clears rp and sets its type.

If the function returns useRatedParty:

It must set the tariff system in RatedParty::tsVersion_.
Optionally sets the id of the contract, the subscribed product and the resource key that was used to identify these two ids.

If the function returns useCache: