OSB_LIB::Device Class Reference

Inheritance diagram for OSB_LIB::Device:

[legend]Collaboration diagram for OSB_LIB::Device:

[legend]List of all members.

Detailed Description

Devices: equipment and articles with a serial number.

Definition at line 69 of file device.h.

Public Types

typedef TypeId< Device > Type
The device type.
typedef Id< Device > Oid
Type-safe object identification.
typedef Id< InventoryPool > PoolId
Short-hand for an inventory pool.
dvcUnknown = '\0'
Unknown device status.
dvcCreated = 'c'
Device is created and reserved,
this is the default status.
dvcAvailable = 'v'
Device is available.
dvcAssigned = 'a'
Device is assigned.
dvcDeactivated = 'd'
Device is deactivated and can not be used again.
enum Status {
dvcUnknown = '\0', dvcCreated = 'c', dvcAvailable = 'v', dvcAssigned = 'a',
dvcDeactivated = 'd'
}
The status of device. More...

Public Member Functions

Device (const Oid &oid=Oid())
Constructor with optional object id.
virtual ~Device ()
Empty virtual destructor.
Oid oid () const
Get the object id.
virtual Type type () const =0
Get the device type.
Status status () const
Get the device status.
PoolId poolId () const
Get the inventory pool id of the device.
void setPool (const PoolId poolId)
Set the inventory pool.
virtual void setStatus (const Status newStatus)
Set the device status.
void lock (const OSB_DB::Session &session, bool noWait) const
Lock a device in the database.

virtual void read (const OSB_DB::Session &session)=0
@ name Database operations: Read the device from the database.
virtual void saveData (const OSB_DB::Session &session, bool noWait)=0
Save the device data to the database.
virtual void updStatus (const OSB_DB::Session &session, bool noWait)
Update the status of the device in the database.
virtual void remove (const OSB_DB::Session &session, bool noWait)=0
Delete the device from the database.

Static Public Member Functions

static void lock (const OSB_DB::Session &session, const Oid &id, bool noWait)
Lock a device in the database.

Protected Member Functions

Device (const Device &rhs)
Copying for derived classes only.
Device & operator= (const Device &rhs)
Assignment for derived classes only.

void readBase (const OSB_DB::Session &session)
@ name Database operations, support for derived classes. Read device data from the database.
void insertBase (const OSB_DB::Session &session)
Save device data to the database.
void updDataBase (const OSB_DB::Session &session, bool noWait)
Save device data to the database.
void removeBase (const OSB_DB::Session &session)
Delete the device from the database.
void incObjVs (const OSB_DB::Session &session)
Increment the object version by 1.

Static Protected Member Functions

static void handleObjectStatus (ObjectStatus os, const Oid &id)
Evalute the object status of a device.

Private Member Functions

void setAssigned (const OSB_DB::Session &session)
Set the status to assigned.
void setUnAssigned (const OSB_DB::Session &session)
Undo an assignment of the device.
void setDeassigned (const OSB_DB::Session &session)
Deassign the device.
void updStatusNoLock (const OSB_DB::Session &session)
Update the device status without locking.

Private Attributes

Oid oid_
The object id.
long objVs_
The object version.
Status status_
The device status.
PoolId poolId_
Inventory pool.

Friends

class OSB_DB::DeviceGw
Allow to set the data members.
class PersDevice
Allow to call the assign/deassign functions.

Member Typedef Documentation

typedef Id<Device> OSB_LIB::Device::Oid

Type-safe object identification.

Definition at line 78 of file device.h.

typedef Id<InventoryPool> OSB_LIB::Device::PoolId

Short-hand for an inventory pool.

Definition at line 80 of file device.h.

typedef TypeId<Device> OSB_LIB::Device::Type

The device type.

Definition at line 76 of file device.h.

Member Enumeration Documentation

enum OSB_LIB::Device::Status

The status of device.

Customer care and other on-line application need to assign a device to a pers. product if it contains a DeviceItem.
A device is available if its device status is dvcAvailable.

Remarks:: Additional device status may be added in future to support the purchase order process of devices.

Enumerator:

dvcUnknown	Unknown device status.
dvcCreated	Device is created and reserved, this is the default status.
dvcAvailable	Device is available.
dvcAssigned	Device is assigned.
dvcDeactivated	Device is deactivated and can not be used again.

Definition at line 93 of file device.h.

Constructor & Destructor Documentation

OSB_LIB::Device::Device ( const Oid & oid = Oid() ) [explicit]

Constructor with optional object id.

virtual OSB_LIB::Device::~Device ( ) [virtual]

Empty virtual destructor.

OSB_LIB::Device::Device ( const Device & rhs ) [protected]

Copying for derived classes only.

Member Function Documentation

static void OSB_LIB::Device::handleObjectStatus	(	ObjectStatus	os,
		const Oid &	id
	)			`[static, protected]`

Evalute the object status of a device.

Parameters:

	os	Object status to evaluate.
	id	The id of the device for which os is valid.

Exceptions:

	ObjectDeleted
	ObjectModified
	ObjectBusy	if noWait is true and the device is locked by another database session.

void OSB_LIB::Device::incObjVs ( const OSB_DB::Session & session ) [protected]

Increment the object version by 1.

Parameters:

session

Database session to use.

Exceptions:

OsbException

(internal error) if the update of the object version in the database fails.

The function should be used only after a successful call of a lock() function.

void OSB_LIB::Device::insertBase ( const OSB_DB::Session & session ) [protected]

Save device data to the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if the insert fails.

void OSB_LIB::Device::lock	(	const OSB_DB::Session &	session,
		bool	noWait
	)			const

Lock a device in the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

OsbException

from handleObjectStatus().

static void OSB_LIB::Device::lock	(	const OSB_DB::Session &	session,
		const Oid &	id,
		bool	noWait
	)			`[static]`

Lock a device in the database.

Parameters:

	session	Database session to use.
	id	The object id of the device to lock.
	noWait	Don't wait for database locks?

Exceptions:

OsbException

from handleObjectStatus(), (ObjectModified is not applicable).

Oid OSB_LIB::Device::oid ( ) const

Get the object id.

Device& OSB_LIB::Device::operator= ( const Device & rhs ) [protected]

Assignment for derived classes only.

PoolId OSB_LIB::Device::poolId ( ) const

Get the inventory pool id of the device.

It may not be set.

virtual void OSB_LIB::Device::read ( const OSB_DB::Session & session ) [pure virtual]

@ name Database operations: Read the device from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if the device as identified by oid() and type() does not exist in the database.

Implemented in OSB_LIB::UimCard.

void OSB_LIB::Device::readBase ( const OSB_DB::Session & session ) [protected]

@ name Database operations, support for derived classes. Read device data from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if the device as identified by oid() does not exist in the database.

virtual void OSB_LIB::Device::remove	(	const OSB_DB::Session &	session,
		bool	noWait
	)			`[pure virtual]`

Delete the device from the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from lock().
	OsbException	if deletion of the device is not allowed.

Todo:: Be more precise about the 2nd throw condition.

Implemented in OSB_LIB::UimCard.

void OSB_LIB::Device::removeBase ( const OSB_DB::Session & session ) [protected]

Delete the device from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if deletion of the device is not allowed.

Derived class must call lock() before deleting their own data and then calling this function.

virtual void OSB_LIB::Device::saveData	(	const OSB_DB::Session &	session,
		bool	noWait
	)			`[pure virtual]`

Save the device data to the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from lock().
	OsbException	if the insert or update fails for other reasons.

Note:: Derived classes may maintain a flag if their data was modified and only call their own update function if needed.
They must however always call updDataBase().

Implemented in OSB_LIB::UimCard.

void OSB_LIB::Device::setAssigned ( const OSB_DB::Session & session ) [private]

Set the status to assigned.

Parameters:

session

Database session to use.

Exceptions:

	OsbException	from lock().
	OsbException	if the device is not available.

void OSB_LIB::Device::setDeassigned ( const OSB_DB::Session & session ) [private]

Deassign the device.

Set the device status to deactivated.

Parameters:

session

Database session to use.

Exceptions:

OsbException

from lock().

void OSB_LIB::Device::setPool ( const PoolId poolId )

Set the inventory pool.

Parameters:

poolId

The new inventory pool of the device.

Exceptions:

OsbException

if changing to pool is not allowed:
currently none.

virtual void OSB_LIB::Device::setStatus ( const Status newStatus ) [virtual]

Set the device status.

Parameters:

newStatus

New status of the device.

Exceptions:

	OsbException	if the current status is assigned.
	OsbException	if newStatus is assigned or quarantine.

Note:: The function is virtual, derived classes can override this default implementation.

void OSB_LIB::Device::setUnAssigned ( const OSB_DB::Session & session ) [private]

Undo an assignment of the device.

Resets the device status to available.

Parameters:

session

Database session to use.

Exceptions:

OsbException

from lock().

Status OSB_LIB::Device::status ( ) const

Get the device status.

virtual Type OSB_LIB::Device::type ( ) const [pure virtual]

Get the device type.

Implemented in OSB_LIB::UimCard.

void OSB_LIB::Device::updDataBase	(	const OSB_DB::Session &	session,
		bool	noWait
	)			`[protected]`

Save device data to the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from lock().
	OsbException	if the update fails for other reasons.

virtual void OSB_LIB::Device::updStatus	(	const OSB_DB::Session &	session,
		bool	noWait
	)			`[virtual]`

Update the status of the device in the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

	OsbException	from lock().
	OsbException	from incObjVs().

Note:: The default implementation just updates the status in the table DEVICE.
Derived classes can override this behaviour if needed, they should however always call this function first.

void OSB_LIB::Device::updStatusNoLock ( const OSB_DB::Session & session ) [private]

Update the device status without locking.

Parameters:

session

Database session to use.

Exceptions:

OsbException

from incObjVs().

The device must be locked in the database before calling this function!