OSB_LIB::RatedService Class Reference

Inheritance diagram for OSB_LIB::RatedService:

Inheritance graph
[legend]
Collaboration diagram for OSB_LIB::RatedService:

Collaboration graph
[legend]
List of all members.

Detailed Description

Rateable network service.

This class is a thin wrapper providing a name for a ServiceTuple.

Definition at line 65 of file ratedservice.h.

Public Types

Public Member Functions

Configuration status changes:
Database operations:

Private Attributes

Friends


Member Typedef Documentation

typedef Id<RatedService> OSB_LIB::RatedService::Oid

The object id.

Note that this assumes that there won't be 2 network services for the same service tuple.

Definition at line 75 of file ratedservice.h.


Constructor & Destructor Documentation

OSB_LIB::RatedService::RatedService ( const Oid oid = Oid()  )  [explicit]

Default constructor with optional object id.

OSB_LIB::RatedService::RatedService ( const ServiceTuple st  )  [explicit]

Constructor with service tuple.


Member Function Documentation

bool OSB_LIB::RatedService::freeze ( const OSB_DB::Session session,
OsbErrors msgs 
) [virtual]

Change status from cfgEditable to cfgStandby.

Parameters:
session Database session to use.
msgs Container for warnings and errors.
Returns:
true in case of success, else false.
The rated service can be freezed if the service tuple contains at least one element.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::RatedService::insert ( const OSB_DB::Session session  ) 

Insert the network service into the database.

Parameters:
session Database session to use.
Returns:
true in case of success, else false.

const Oid& OSB_LIB::RatedService::oid (  )  const

Get object id.

bool OSB_LIB::RatedService::read ( const OSB_DB::Session session  ) 

Read the network service from the database.

Parameters:
session Database session to use.
Returns:
true in case of success, else false.

bool OSB_LIB::RatedService::release ( const OSB_DB::Session session,
OsbErrors msgs 
) [virtual]

Change status from cfgStandby to cfgReleased.

Parameters:
session Database session to use.
msgs Container for warnings and errors.
Returns:
Always true, provided that the current status is cfgStandby.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::RatedService::remove ( const OSB_DB::Session session  ) 

Delete the network service from the database.

Parameters:
session Database session to use.
Returns:
true in case of success, else false.

bool OSB_LIB::RatedService::revoke ( const OSB_DB::Session session,
OsbErrors msgs 
) [virtual]

Change status from cfgReleased to cfgStandby.

Parameters:
session Database session to use.
msgs Container for warnings and errors.
Returns:
true in case of success, else false.
The function fails if one of the service class configurations using this serivce is in released status.

Implements OSB_LIB::ToCfgBase.

const ServiceTuple& OSB_LIB::RatedService::serviceTuple (  )  const

Get service tuple.

void OSB_LIB::RatedService::setServiceTuple ( const ServiceTuple st  ) 

Modify the service tuple.

Parameters:
st New service tuple of the service.
Exceptions:
OsbException if the status is not editable.

bool OSB_LIB::RatedService::unfreeze ( const OSB_DB::Session session,
OsbErrors errors 
) [virtual]

Change status from cfgStandby to cfgEditable.

Parameters:
session Database session to use.
errors Gets the list of encountered errors.
Returns:
true in case of success, else false.
The function fails if one of the service class configurations using this serivce is not in editable status.

Implements OSB_LIB::ToCfgBase.

bool OSB_LIB::RatedService::update ( const OSB_DB::Session session  ) 

Update the network service in the database.

Parameters:
session Database session to use.
Returns:
true in case of success, else false.


Friends And Related Function Documentation

friend class OSB_DB::RatedServiceGw [friend]

Allow the gateway to set the data members.

Definition at line 67 of file ratedservice.h.


Member Data Documentation

Oid OSB_LIB::RatedService::oid_ [private]

Object id.

Definition at line 187 of file ratedservice.h.

ServiceTuple OSB_LIB::RatedService::st_ [private]

The service tuple of the service.

Definition at line 189 of file ratedservice.h.


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:15:56 2006 for OSB Library by  doxygen 1.4.7