objectclasses::DBInfo Class Reference

Inheritance diagram for objectclasses::DBInfo:

cdbVisCore::dbUpdate objectclasses::Device objectclasses::DeviceType objectclasses::Link objectclasses::LinkType objectclasses::Port objectclasses::Spare_Device objectclasses::Spare_Port objectclasses::SpareHWType objectclasses::SubSystem

List of all members.


Detailed Description

Abstract class with common varibles and functions for all db objects. All db objects inherit from this class. This is actually what you in Java would call an interface. All classes that implement (inherit) this class MUST have all variables and functions this class has.

Definition at line 85 of file objectclasses.py.


Public Member Functions

def __init__
def SetErrorMessage
def GetErrorMessage
def Create
def Modify
def Delete
def Update
def GetObjectInfo
def Save

Private Attributes

 __errormessage

Member Function Documentation

def objectclasses::DBInfo::__init__ (   self  ) 

Reimplemented from cdbVisCore::dbUpdate.

Definition at line 87 of file objectclasses.py.

def objectclasses::DBInfo::SetErrorMessage (   self,
  msg 
)

Set the error message so that it can be looked up. - the message string

Reimplemented from cdbVisCore::dbUpdate.

Reimplemented in objectclasses::SubSystem, objectclasses::DeviceType, objectclasses::Device, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Device, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 94 of file objectclasses.py.

def objectclasses::DBInfo::GetErrorMessage (   self  ) 

Get the error message that was set most recently.

!return - the error message string

Reimplemented from cdbVisCore::dbUpdate.

Reimplemented in objectclasses::SubSystem, objectclasses::DeviceType, objectclasses::Device, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Device, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 103 of file objectclasses.py.

def objectclasses::DBInfo::Create (   self  ) 

Create a new instance of the object in the database. This actually only sets the save status of the object to CREATE, and adds the object to the dirty objects list so that it can be stored in ConfDB later on.

Reimplemented in objectclasses::SubSystem, objectclasses::DeviceType, objectclasses::Device, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Device, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 111 of file objectclasses.py.

def objectclasses::DBInfo::Modify (   self  ) 

Modify a data object; sets actually the save status of the object to MODIFY; and adds an instance of it to the dirty objects list so that it can be stored in ConfDB later.

Reimplemented in objectclasses::SubSystem, objectclasses::DeviceType, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 118 of file objectclasses.py.

def objectclasses::DBInfo::Delete (   self  ) 

Delete a data object; sets actually the save status of the object to DELETE; and adds an instance of it to the dirty objects list so that it can be stored in ConfDB later.

Reimplemented in objectclasses::DeviceType, objectclasses::Device, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Device, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 125 of file objectclasses.py.

def objectclasses::DBInfo::Update (   self  ) 

This function is to update the object with the most recent information that the user has set to it. It may be stored in ConfDB or retrieved from an object in the dirty objects list.

Definition at line 132 of file objectclasses.py.

def objectclasses::DBInfo::GetObjectInfo (   self  ) 

This function retrieves information/properties from the object as it is stored in the ConfDB or in the dirty objects list, and sends a dictionary with all this information back to the caller. This function is almost equal to Update(...), but this function may contain the most recent information about the object itself, and hence not look in the dirty objects list or ConfDB for the most recent information.

Reimplemented in objectclasses::SubSystem.

Definition at line 141 of file objectclasses.py.

def objectclasses::DBInfo::Save (   self  ) 

A call to this information actually tries to store changes in the ConfDB, what it does depends on the save and modify status set for this object. The change are not necessarily commited immediately.

Definition at line 148 of file objectclasses.py.


Member Data Documentation

objectclasses::DBInfo::__errormessage [private]

Reimplemented from cdbVisCore::dbUpdate.

Reimplemented in objectclasses::SubSystem, objectclasses::DeviceType, objectclasses::Device, objectclasses::Link, objectclasses::LinkType, objectclasses::Port, objectclasses::Spare_Device, objectclasses::Spare_Port, and objectclasses::SpareHWType.

Definition at line 88 of file objectclasses.py.


The documentation for this class was generated from the following file:
Generated on Fri Aug 31 11:11:19 2007 for CDBVis by  doxygen 1.5.3