OSB_DB::ScsVersionGw Struct Reference

List of all members.

---

Detailed Description

Database interface ScsVersion.

Definition at line 308 of file serviceclass-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::ScsVersion &scsVs)

  Populate a service class system version object with data.
  

• bool fetch (const Session &session, OSB_LIB::ScsVersions &dest)

  Retrieve all service class system version from database.
  

Private Member Functions

• bool insScsVersion (const Session &session, OSB_LIB::ScsVersion &scsVs)

  Add a new service class system version.
  

• bool delScsVersion (const Session &session, OSB_LIB::ScsVersion &scsVs)

  Delete a service class system version.
  

• bool updScsVersion (const Session &session, OSB_LIB::ScsVersion &scsVs)

  Update a service class system version.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::ScsVersion &scsVs)

  Check the current object version.
  

• bool allRsFreezed (const Session &session, const OSB_LIB::ScsVersion::Oid &oid, OSB_LIB::OsbErrors &errors)

  Check that all rated services are freezed.
  

• bool serviceTuplesUnique (const Session &session, const OSB_LIB::ScsVersion::Oid &oid, OSB_LIB::OsbErrors &errors)

  Check the uniqueness of service tuples.
  

• bool isReleasedInFuture (const Session &session, const OSB_LIB::ScsVersion::Oid &oid)

  Check whether the release date is in the future.
  

• bool uniqueReleaseTs (const Session &session, const OSB_LIB::ScSystem::Oid &oid, const OSB_LIB::DateTime &ts) const

  Check whether the release date is unique.
  

• bool allRsReleased (const Session &session, const OSB_LIB::ScsVersion::Oid &oid, OSB_LIB::OsbErrors &errors)

  Check that all rated services are released.
  

• bool isScSystemUsedByReleasedTsVersion (const Session &session, const OSB_LIB::ScSystem::Oid &oid)

  Check whether service class system version is in used.
  

• bool isScSystemUsedByFreezedTsVersion (const Session &session, const OSB_LIB::ScSystem::Oid &oid)

  Check whether service class system version is in used.
  

• OSB_LIB::DateTime nextReleasedVersion (const Session &session, const OSB_LIB::ScsVersion::Oid &oid)

  Find the replacement for a released service class system version.
  

• bool hasOtherReleasedScsVersion (const Session &session, const OSB_LIB::ScsVersion::Oid &oid)

  Check is there any other released service class system version exists.
  

• bool findReplacementFreezedScsVersion (const Session &session, const OSB_LIB::ScsVersion::Oid &oid)

  Find the replacement for a freezed service class system version.
  

• void updStatus (const Session &session, OSB_LIB::ScsVersion &scsVs)

  Change the status of service class system version.
  

• bool identicalServiceClasses (const Session &session, const OSB_LIB::ScsVersion::Oid &oid)

  Ensure all versions of service class system support the same set of service classes.
  

Friends

• class OSB_LIB::ScsVersion

---

Member Function Documentation

bool OSB_DB::ScsVersionGw::allRsFreezed	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid,
		OSB_LIB::OsbErrors &	errors
	)			[private]

Check that all rated services are freezed.

This function verifies that no rated service of a SCS version is editable.

Parameters:

	session	Database session to use.
	oid	Object id of the SCS version to check.
	errors	Container for detected errors.

Returns:

true if all rated services of the SCS version are freezed, else false.

bool OSB_DB::ScsVersionGw::allRsReleased	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid,
		OSB_LIB::OsbErrors &	errors
	)			[private]

Check that all rated services are released.

This function verifies that all rated services of a SCS version are released.

Parameters:

	session	Database session to use.
	oid	Object id of the SCS version to check.
	errors	Container for detected errors.

Returns:

true if all rated services of the SCS version are released, else false.

OSB_LIB::ObjectStatus OSB_DB::ScsVersionGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::ScsVersion &	scsVs
	)			[private]

Check the current object version.

Parameters:

	session	Database session to use.
	scsVs	SCS version for which to check the object version.

Returns:

Result of the object version verification. Possible values are:

• objUnchanged
• objModified
• objDeleted

bool OSB_DB::ScsVersionGw::delScsVersion	(	const Session &	session,
		OSB_LIB::ScsVersion &	scsVs
	)			[private]

Delete a service class system version.

The service class system version to be deleted must already exist in the database table and in status editable. The object is not deleted automaticaly. Application will have to delete the object itself. After the function call, the object's id will be unset.

Parameters:

	session	Database session to use.
	scsVs	Service class system version to delete.

Returns:

true if deletion is successful else false.

Exceptions:

OsbException

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

bool OSB_DB::ScsVersionGw::fetch	(	const Session &	session,
		OSB_LIB::ScsVersions &	dest
	)

Retrieve all service class system version from database.

Parameters:

	session	Database session to use.
	dest	STL container to store to SCS versions.

Returns:

true if success else false.

bool OSB_DB::ScsVersionGw::fetch	(	const Session &	session,
		OSB_LIB::ScsVersion &	scsVs
	)

Populate a service class system version object with data.

This function accept an empty service class system version with only its oid set. It will populate all other attribute of the object.

Parameters:

	session	Database session to use.
	scsVs	SCS version to populate.

Returns:

true if the object is found, else false.

bool OSB_DB::ScsVersionGw::findReplacementFreezedScsVersion	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid
	)			[private]

Find the replacement for a freezed service class system version.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system version to be replaced.

Returns:

true if replacement found else false.

bool OSB_DB::ScsVersionGw::hasOtherReleasedScsVersion	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid
	)			[private]

Check is there any other released service class system version exists.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system version to check.

Returns:

true if other released version found, else false.

bool OSB_DB::ScsVersionGw::identicalServiceClasses	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid
	)			[private]

Ensure all versions of service class system support the same set of service classes.

This function will refer to the previous released versions of service class system to do the comparison. This function always return true if the object to be checked is the first version to be released.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system version to be checked.

Returns:

true if identical else false.

bool OSB_DB::ScsVersionGw::insScsVersion	(	const Session &	session,
		OSB_LIB::ScsVersion &	scsVs
	)			[private]

Add a new service class system version.

Before the function call, the object must have all its member attributes assigned (except oid). After the function call, the object will get its oid_. In case of an error, exception is thrown.

Parameters:

	session	Database session to use.
	scsVs	New service class system version to add.

Returns:

true if creation is successful else false.

Exceptions:

OsbException

for the following errors: Duplicate name.

bool OSB_DB::ScsVersionGw::isReleasedInFuture	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid
	)			[private]

Check whether the release date is in the future.

This function checks whether the release date of the service class system version with the given object id is in the future.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system version to check.

Returns:

true if release date is in the future, else false.

bool OSB_DB::ScsVersionGw::isScSystemUsedByFreezedTsVersion	(	const Session &	session,
		const OSB_LIB::ScSystem::Oid &	oid
	)			[private]

Check whether service class system version is in used.

This function checks whether any freezed tariff system version is using the service class system version with the object id given.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system to check.

Returns:

true if in used by released tariff system version else false.

bool OSB_DB::ScsVersionGw::isScSystemUsedByReleasedTsVersion	(	const Session &	session,
		const OSB_LIB::ScSystem::Oid &	oid
	)			[private]

Check whether service class system version is in used.

This function checks whether any released tariff system version is using the service class system version with the object id given.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system to check.

Returns:

true if in used by released tariff system version else false.

OSB_LIB::DateTime OSB_DB::ScsVersionGw::nextReleasedVersion	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid
	)			[private]

Find the replacement for a released service class system version.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system version to be replaced.

Returns:

Expired date of the service class system version to be replaced.
It is not set if no replacement is found.

bool OSB_DB::ScsVersionGw::serviceTuplesUnique	(	const Session &	session,
		const OSB_LIB::ScsVersion::Oid &	oid,
		OSB_LIB::OsbErrors &	errors
	)			[private]

Check the uniqueness of service tuples.

Parameters:

	session	Database session to use.
	oid	Object id of the SCS version to check.
	errors	Gets error messages for duplicate service tuples.

Returns:

true if each service tuple that is part of the SCS version is unique, else false.

This function checks that no duplicate service tuples are assigned to a service class system version.

bool OSB_DB::ScsVersionGw::uniqueReleaseTs	(	const Session &	session,
		const OSB_LIB::ScSystem::Oid &	oid,
		const OSB_LIB::DateTime &	ts
	)			const [private]

Check whether the release date is unique.

This function will check whether the release date is unique among the different versions of the same service class system.

Parameters:

	session	Database session to use.
	oid	Object id of the service class system.
	ts	Release time stamp to check.

Returns:

true if unique else false.

bool OSB_DB::ScsVersionGw::updScsVersion	(	const Session &	session,
		OSB_LIB::ScsVersion &	scsVs
	)			[private]

Update a service class system version.

The function will modify the data of an object in the database with the data contained within the input object.

Parameters:

	session	Database session to use.
	scsVs	Service class system version to update.

Returns:

true if updated successfully else false.

Exceptions:

OsbException

for the following errors: Object not found. Object has been modified. Duplicate name.

void OSB_DB::ScsVersionGw::updStatus	(	const Session &	session,
		OSB_LIB::ScsVersion &	scsVs
	)			[private]

Change the status of service class system version.

This function will change the status of service class system version with the given object id based on the input status.

Parameters:

	session	Database session to use.
	scsVs	SCS version to update, its new status must be set.

---

Friends And Related Function Documentation

friend class OSB_LIB::ScsVersion [friend]

Service class system version needs to call the private member functions.

Definition at line 313 of file serviceclass-gw.h.

---

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

• serviceclass-gw.h

---