OSB_DB::FilterVersionGw Struct Reference

List of all members.

---

Detailed Description

This will perform all database operations for filter version.

Definition at line 170 of file filter-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::FilterVersion &fv)

  Read the filter version object from database.
  

• long fetch (const Session &session, OSB_LIB::FilterVersions &fvs)

  Get the list of all available filter versions.
  

Private Member Functions

• bool insFv (const Session &session, OSB_LIB::FilterVersion &fv)

  Insert the filter version object into the database.
  

• bool updFv (const Session &session, OSB_LIB::FilterVersion &fv)

  Update the filter version object in database.
  

• bool removeFv (const Session &session, OSB_LIB::FilterVersion &fv)

  Remove the filter version object from database.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::FilterVersion &fv)

  Check the current object version.
  

• OSB_LIB::CfgStatus getStatus (const Session &session, const OSB_LIB::FilterVersion::Oid &oid)

  Get the status of filter version in database.
  

• void setStatus (const Session &session, const OSB_LIB::FilterVersion::Oid &oid, const OSB_LIB::CfgStatus &status)

  Change the status of filter version.
  

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

  Ensure the release date is in future.
  

Friends

• class OSB_LIB::FilterVersion

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::FilterVersionGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::FilterVersion &	fv
	)			[private]

Check the current object version.

Parameters:

	session	Database session.
	fv	FilterVersion to be checked.

Returns:

Result of the object version verification.

Exceptions:

Exception

if object not found.

long OSB_DB::FilterVersionGw::fetch	(	const Session &	session,
		OSB_LIB::FilterVersions &	fvs
	)

Get the list of all available filter versions.

This function retrieves all the filter version objects from the database.

Parameters:

	session	Database session to use.
	fvs	Container to populate all the filter version objects.

Returns:

Number of filter version objects retrieved.

bool OSB_DB::FilterVersionGw::fetch	(	const Session &	session,
		OSB_LIB::FilterVersion &	fv
	)

Read the filter version object from database.

This will read the filter version object from the filter version table. The filter id is used to identify the object in the database. Before reading the filter version object the object id should be set.

Parameters:

	session	Database session to use.
	fv	Filter version object to use.

Exceptions:

Exception

if object not found.

Returns:

True if filter version object read successfully else false.

OSB_LIB::CfgStatus OSB_DB::FilterVersionGw::getStatus	(	const Session &	session,
		const OSB_LIB::FilterVersion::Oid &	oid
	)			[private]

Get the status of filter version in database.

Parameters:

	session	Database session.
	oid	Id of the filter version to be checked.

Exceptions:

Exception

if object not found.

Returns:

Status of the filter version found.

bool OSB_DB::FilterVersionGw::insFv	(	const Session &	session,
		OSB_LIB::FilterVersion &	fv
	)			[private]

Insert the filter version object into the database.

This will insert the filter version object into the filter version table.

Parameters:

	session	Database session to use.
	fv	Filter version object to be inserted.

Exceptions:

Exception

for the following errors: Primary key violation, Name field is empty, Name field exceeds maximum size

Returns:

True if the filter version object inserted successfully else false.

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

Ensure the release date is in future.

This function checks whether the filter version has its release date in the future.

Parameters:

	session	Database Session to use.
	oid	Unique id of the filter version to be checked.

Exceptions:

Exception

if object not found.

Returns:

True if the release date is in the future else false.

bool OSB_DB::FilterVersionGw::removeFv	(	const Session &	session,
		OSB_LIB::FilterVersion &	fv
	)			[private]

Remove the filter version object from database.

This will remove the filter version object from the filter version table. Object id and object version are used to identify the filter version object for deletion.

Parameters:

	session	Database session to use.
	fv	Filter version object to be deleted.

Exceptions:

Exception

for the following error: Object not found, Foreign key constraint

Returns:

True if the filter version object deleted successfully else false.

void OSB_DB::FilterVersionGw::setStatus	(	const Session &	session,
		const OSB_LIB::FilterVersion::Oid &	oid,
		const OSB_LIB::CfgStatus &	status
	)			[private]

Change the status of filter version.

This function will change the status for the given filter version with the given status.

Parameters:

	session	Database session.
	oid	Object identifier for the filter version.
	status	Status to be changed.

Exceptions:

Exception

if object not found.

bool OSB_DB::FilterVersionGw::updFv	(	const Session &	session,
		OSB_LIB::FilterVersion &	fv
	)			[private]

Update the filter version object in database.

This will update the filter version object into the filter version table with the current values. Object id and object version are used to identify the filter version object for updation.

Parameters:

	session	Database session to use.
	fv	Filter version object to be updated.

Exceptions:

Exception

for the following error: Object not found, Name field is empty, Name field exceeds maximum size

Returns:

True if the filter version object updated successfully else false.

---

Friends And Related Function Documentation

friend class OSB_LIB::FilterVersion [friend]

Definition at line 172 of file filter-gw.h.

---

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

• filter-gw.h

---