OSB_DB::RatedServiceGw Struct Reference

List of all members.

---

Detailed Description

Database interface RatedService.

Definition at line 66 of file ratedservice-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::RatedService *service)

  Read a rated service from database.
  

• long fetch (const Session &session, OSB_LIB::RatedServices &services)

  Get all rated services from database.
  

• bool insert (const Session &session, OSB_LIB::RatedService *service)

  Create new rated service in database.
  

• bool remove (const Session &session, OSB_LIB::RatedService *service)

  Delete a rated service from the database.
  

• bool updAttr (const Session &session, const OSB_LIB::RatedService &service)

  Update attributes of a rated service in the database.
  

• void updCfg (const Session &session, const OSB_LIB::RatedService &service)

  Update the configuration of a rated service in the database.
  

• bool updStatus (const Session &session, const OSB_LIB::RatedService &service)

  Change the status of rated service.
  

• void lock (const Session &session, OSB_LIB::RatedService *service)

  Lock a rated service in the database.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::RatedService &service, bool doThrow)

  Check the current object version.
  

• bool noScCfgReleased (const Session &session, const OSB_LIB::RatedService::Oid &rsId, OSB_LIB::OsbErrors &msgs)

  Check status consistency of rated service during revoke.
  

• bool allScCfgEditable (const Session &session, const OSB_LIB::RatedService::Oid &rsId, OSB_LIB::OsbErrors &msgs)

  Check status consistency of rated service during unfreeze.
  

---

Member Function Documentation

bool OSB_DB::RatedServiceGw::allScCfgEditable	(	const Session &	session,
		const OSB_LIB::RatedService::Oid &	rsId,
		OSB_LIB::OsbErrors &	msgs
	)

Check status consistency of rated service during unfreeze.

The function verifies that a rated service status change from standby to editable does not create a conflict with any service class configuration using the rated service.

Parameters:

	session	Database session to use.
	rsId	Object id of rated service to verify.
	msgs	Container for detected conflicts.

Returns:

true if no service class configuration is freezed, else false.

OSB_LIB::ObjectStatus OSB_DB::RatedServiceGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::RatedService &	service,
		bool	doThrow
	)

Check the current object version.

Parameters:

	session	Database session to use.
	service	Service to verify.
	doThrow	Flag to throw the appropriate exception if service is not up-to-date.

Returns:

The object status of the rating function.

Exceptions:

OsbException

if doThrow is true and the object version of service does not match the database.

long OSB_DB::RatedServiceGw::fetch	(	const Session &	session,
		OSB_LIB::RatedServices &	services
	)

Get all rated services from database.

Parameters:

	session	Database session to use.
	services	STL-container to populate.

Returns:

Number of services read.

bool OSB_DB::RatedServiceGw::fetch	(	const Session &	session,
		OSB_LIB::RatedService *	service
	)

Read a rated service from database.

Parameters:

	session	Database session to use.
	service	Rated to service to read, its object id is used selection criteria.

Returns:

true if the object is found, else false.

bool OSB_DB::RatedServiceGw::insert	(	const Session &	session,
		OSB_LIB::RatedService *	service
	)

Create new rated service in database.

Parameters:

	session	Database session to use.
	service	Service to insert. If the function returns successful, its object id is set.

Returns:

true if creation is successful else false.

void OSB_DB::RatedServiceGw::lock	(	const Session &	session,
		OSB_LIB::RatedService *	service
	)

Lock a rated service in the database.

Parameters:

	session	Database session to use.
	service	Rated service to lock, its object version is increased by 1 if the function does not throw.

Exceptions:

OsbException

if the rated service can not be locked, i.e., inconsistent object version.

bool OSB_DB::RatedServiceGw::noScCfgReleased	(	const Session &	session,
		const OSB_LIB::RatedService::Oid &	rsId,
		OSB_LIB::OsbErrors &	msgs
	)

Check status consistency of rated service during revoke.

The function verifies that a rated service status change from released to standby does not create a conflict with any service class configuration using the rated service.

Parameters:

	session	Database session to use.
	rsId	Object id of rated service to verify.
	msgs	Container for detected conflicts.

Returns:

true if no service class configuration is released, else false.

bool OSB_DB::RatedServiceGw::remove	(	const Session &	session,
		OSB_LIB::RatedService *	service
	)

Delete a rated service from the database.

Parameters:

	session	Database session to use.
	service	Service to delete. If the function returns successful, its object id is cleared.

Returns:

true if deletion is successful else false.

bool OSB_DB::RatedServiceGw::updAttr	(	const Session &	session,
		const OSB_LIB::RatedService &	service
	)

Update attributes of a rated service in the database.

Parameters:

	session	Database session to use.
	service	Service to update, its object version is increased if the function return successful.

Returns:

true if updated successfully else false.

void OSB_DB::RatedServiceGw::updCfg	(	const Session &	session,
		const OSB_LIB::RatedService &	service
	)

Update the configuration of a rated service in the database.

Parameters:

	session	Database session to use.
	service	Service to update, its object version is increased if the function return successful.

Returns:

true if updated successfully else false.

bool OSB_DB::RatedServiceGw::updStatus	(	const Session &	session,
		const OSB_LIB::RatedService &	service
	)

Change the status of rated service.

Parameters:

	session	Database session.
	service	Rated service to update, its new status must be set.

Returns:

true in case of success, else false.

---

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

• ratedservice-gw.h

---