OSB_DB::FilterGw Struct Reference

List of all members.

---

Detailed Description

This will perform all the database operations for filter.

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

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::Filter &filt)

  This will read the filter object from the table filter.
  

• long fetch (const Session &session, OSB_LIB::Filters &filts)

  Get the list of all available filters.
  

Private Member Functions

• bool insFc (const Session &session, OSB_LIB::Filter &filt)

  Insert the filter into database.
  

• bool updFc (const Session &session, OSB_LIB::Filter &filt)

  Update the filter in database.
  

• bool removeFc (const Session &session, OSB_LIB::Filter &filt)

  Remove the filter from database.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::Filter &filt)

  Check the current object version.
  

Friends

• class OSB_LIB::Filter

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::FilterGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::Filter &	filt
	)			[private]

Check the current object version.

Parameters:

	session	Database session.
	filt	FilterVersion to be checked.

Returns:

Result of the object version verification.

Exceptions:

Exception

if object not found.

long OSB_DB::FilterGw::fetch	(	const Session &	session,
		OSB_LIB::Filters &	filts
	)

Get the list of all available filters.

This function retrieves all the filters from the table filter.

Parameters:

	session	Database session to use.
	filts	Container to populate all the filter Objects.

Returns:

Number of filter classes retrieved.

bool OSB_DB::FilterGw::fetch	(	const Session &	session,
		OSB_LIB::Filter &	filt
	)

This will read the filter object from the table filter.

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

Parameters:

	session	Database session to use.
	filt	Filter object to be populated.

Exceptions:

Exception

for the following errors: Object not found

Returns:

True if the filter object read successfully else false.

bool OSB_DB::FilterGw::insFc	(	const Session &	session,
		OSB_LIB::Filter &	filt
	)			[private]

Insert the filter into database.

This will insert the new filter into the table filter. The object should contain the name and the description before insertion. The unique object id and the object version will be assigned to this object after insertion.

Parameters:

	session	Database session to use.
	filt	Filter object to use.

Exceptions:

Exception

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

Returns:

True if the filter inserted successfully else false.

bool OSB_DB::FilterGw::removeFc	(	const Session &	session,
		OSB_LIB::Filter &	filt
	)			[private]

Remove the filter from database.

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

Parameters:

	session	Database session to use.
	filt	Filter object to remove.

Exceptions:

For

the following errors: Object not found, Foreign key constraint

Returns:

True if the filter removed successfully else false.

bool OSB_DB::FilterGw::updFc	(	const Session &	session,
		OSB_LIB::Filter &	filt
	)			[private]

Update the filter in database.

This will update the filter with the available values in the filter table. The object id and object version are used to identify the filter object for updation.

Parameters:

	session	Database session to use.
	filt	Filter object to use.

Exceptions:

Exception

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

Returns:

True if the filter updated successfully else false.

---

Friends And Related Function Documentation

friend class OSB_LIB::Filter [friend]

For all database operations filter will call this private functions.

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

---

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

• filter-gw.h

---