OSB_DB::FilterExprGw Struct Reference

List of all members.

---

Detailed Description

This will perform all the database operation for filter expression.

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

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::FilterExpr &fe)

  This will read the filter expr object from the table FILTER_EXPR.
  

• long fetch (const Session &session, OSB_LIB::FilterExprs &fes)

  Get the list of all available filter expressions.
  

Private Member Functions

• bool insFe (const Session &session, OSB_LIB::FilterExpr &fe)

  Insert the filter expression object into database.
  

• bool updFe (const Session &session, OSB_LIB::FilterExpr &fe)

  Update the filter expression in the database.
  

• bool removeFe (const Session &session, OSB_LIB::FilterExpr &fe)

  Remove the filter expression object from database.
  

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

  Check the current object version.
  

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

  Get the status of filter expression in database.
  

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

  Change the status of filter expression.
  

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

  Ensure the release date is in future.
  

Friends

• class OSB_LIB::FilterExpr

---

Member Function Documentation

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

Check the current object version.

Parameters:

	session	Database session.
	fv	Filter expression to be checked.

Returns:

Result of the object version verification.

Exceptions:

Exception

if object not found.

long OSB_DB::FilterExprGw::fetch	(	const Session &	session,
		OSB_LIB::FilterExprs &	fes
	)

Get the list of all available filter expressions.

This function retrieves all the FilterExpr from the database.

Parameters:

	session	Database session to use.
	fes	Cointainer to populate the filter expression objects.

Returns:

Number of filter expressions retrieved.

bool OSB_DB::FilterExprGw::fetch	(	const Session &	session,
		OSB_LIB::FilterExpr &	fe
	)

This will read the filter expr object from the table FILTER_EXPR.

This function accept an empty filter expression object with only its Oid.It will populate all other attributes from the filter expression table.

Parameters:

	session	Database session to use.
	fe	Filter expression object to be populated.

Exceptions:

Exception

if object not found.

Returns:

True if the filter expression object read successfully else false.

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

Get the status of filter expression in database.

Parameters:

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

Exceptions:

Exception

if object not found.

Returns:

status of the filter version found.

bool OSB_DB::FilterExprGw::insFe	(	const Session &	session,
		OSB_LIB::FilterExpr &	fe
	)			[private]

Insert the filter expression object into database.

This will insert the new filter expression object into the table FILTER_EXPR. The unique object id will be assigned to this object after insertion.

Parameters:

	session	Database session to use.
	fe	Filter expression to use.

Exceptions:

Exception

for the folloing errors: Primary key violation,

Returns:

True if the filter inserted successfully else false.

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

Ensure the release date is in future.

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

Parameters:

	session	Database Session to use.
	oid	Unique id of the filter expression.

Exceptions:

Exception

if object not found.

Returns:

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

bool OSB_DB::FilterExprGw::removeFe	(	const Session &	session,
		OSB_LIB::FilterExpr &	fe
	)			[private]

Remove the filter expression object from database.

This will remove the filter expression object from the FILTER_EXPR table. The object id is used to identify the filter expression object to remove from the database.

Parameters:

	session	Database session to use.
	fe	Filter expression object to remove.

Exceptions:

For

the following errors: Object not found, Foreign key constraint

Returns:

True if the filter expression removed successfully else false.

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

Change the status of filter expression.

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

Parameters:

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

Exceptions:

Exception

if object not found.

bool OSB_DB::FilterExprGw::updFe	(	const Session &	session,
		OSB_LIB::FilterExpr &	fe
	)			[private]

Update the filter expression in the database.

This will update the filter expression object with the available values in the FILTER_EXPR table. The object id is used to identify the filter expression object for updation.

Parameters:

	session	Database session to use.
	fe	Filter expression to use.

Exceptions:

Exception

if object not found.

Returns:

True if the filter expression object updated successfully else false.

---

Friends And Related Function Documentation

friend class OSB_LIB::FilterExpr [friend]

This class is using this gateway to achieve all the database operations. To call all the private members it is made as friend

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

---

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

• filter-gw.h

---