OSB_DB::FilterCondGw Struct Reference

List of all members.

Detailed Description

This will perform all the database operation for filter condition.

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

Public Member Functions

Private Member Functions

Friends


Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::FilterCondGw::checkObjVs ( const Session session,
const OSB_LIB::FilterCond fv 
) [private]

Check the current object version.

Parameters:
session Database session.
fv Filter condition to be checked.
Returns:
Result of the object version verification.
Exceptions:
Exception if object not found.

long OSB_DB::FilterCondGw::fetch ( const Session session,
OSB_LIB::FilterConds fcs 
)

Get the list of all available filter conditions.

This function retrieves all the FilterCond from the database.

Parameters:
session Database session to use.
fcs Cointainer to populate the filter condition objects.
Returns:
Number of filter conditions retrieved.

bool OSB_DB::FilterCondGw::fetch ( const Session session,
OSB_LIB::FilterCond fc 
)

This will read the filter condition object from the table FILTER_COND.

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

Parameters:
session Database session to use.
fc Filter condition object to be populated.
Exceptions:
Exception if object not found.
Returns:
True if the filter condition object read successfully else false.

OSB_LIB::CfgStatus OSB_DB::FilterCondGw::getStatus ( const Session session,
const OSB_LIB::FilterCond::Oid oid 
) [private]

Get the status of filter condition in database.

Parameters:
session Database session.
oid Id of the filter condition to be checked.
Exceptions:
Exception if object not found.
Returns:
status of the filter condition found.

bool OSB_DB::FilterCondGw::insFc ( const Session session,
OSB_LIB::FilterCond fc 
) [private]

Insert the filter condition object into database.

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

Parameters:
session Database session to use.
fc Filter condition object to use.
Exceptions:
Exception for the folloing errors:
  • Primary key violation,
Returns:
True if the filter condition object inserted successfully else false.

bool OSB_DB::FilterCondGw::isReleasedInFuture ( const Session session,
const OSB_LIB::FilterCond::Oid oid 
) [private]

Ensure the release date is in future.

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

Parameters:
session Database Session to use.
oid Unique id of the filter condition.
Exceptions:
Exception if object not found.
Returns:
True if the release date is in the future else false.

bool OSB_DB::FilterCondGw::removeFc ( const Session session,
OSB_LIB::FilterCond fc 
) [private]

Remove the filter condition object from database.

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

Parameters:
session Database session to use.
fc Filter condition object to remove.
Exceptions:
For the following errors:
  • Object not found,
  • Foreign key constraint
Returns:
True if the filter condition object removed successfully else false.

void OSB_DB::FilterCondGw::setStatus ( const Session session,
const OSB_LIB::FilterCond::Oid oid,
const OSB_LIB::CfgStatus status 
) [private]

Change the status of filter condition.

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

Parameters:
session Database session.
oid Object identifier for the filter condition.
status Status to be changed.
Exceptions:
Exception if object not found.

bool OSB_DB::FilterCondGw::updFc ( const Session session,
OSB_LIB::FilterCond fc 
) [private]

Update the filter condition object in the database.

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

Parameters:
session Database session to use.
fc Filter condition object to use.
Exceptions:
Exception if object not found.
Returns:
True if the filter condition object updated successfully else false.


Friends And Related Function Documentation

friend class OSB_LIB::FilterCond [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 504 of file filter-gw.h.


The documentation for this struct was generated from the following file:
Generated on Sat Sep 2 14:09:02 2006 for OSB Library by  doxygen 1.4.7