CCommDbOverrideSettings Class Reference

class CCommDbOverrideSettings : public CBase

Repository of override settings for columns in tables. Overrides are deprecated from v9.1

Holds all information about CommDb overrides. Allows the client to store, retrieve and test the existence of overrides.

Inherits from

  • CCommDbOverrideSettings
Public Member Functions
~CCommDbOverrideSettings()
IMPORT_C TBoolCompare(CCommDbOverrideSettings *)
IMPORT_C TIntGetBoolOverride(const TDesC &, const TDesC &, TBool &)
IMPORT_C TIntGetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)
IMPORT_C TIntGetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)
IMPORT_C TIntGetDesOverride(const TDesC &, const TDesC &, TDes8 &)
IMPORT_C TIntGetDesOverride(const TDesC &, const TDesC &, TDes16 &)
IMPORT_C TIntGetIntOverride(const TDesC &, const TDesC &, TUint32 &)
IMPORT_C TIntGetLongDesOverride(const TDesC &, const TDesC &, TDes &)
IMPORT_C TIntGetLongDesOverrideLength(const TDesC &, const TDesC &, TInt &)
IMPORT_C TBoolIsOverridden(const TDesC &, const TDesC &, TValueType)
IMPORT_C CCommDbOverrideSettings *NewL(TParamList)
IMPORT_C CCommDbOverrideSettings *NewL(TParamList, TCommDbDatabaseType)
TParamList PartialFull()
IMPORT_C TIntSetBoolOverride(const TDesC &, const TDesC &, TBool)
IMPORT_C TIntSetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)
IMPORT_C TIntSetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)
IMPORT_C TIntSetDesOverride(const TDesC &, const TDesC &, const TDesC8 &)
IMPORT_C TIntSetDesOverride(const TDesC &, const TDesC &, const TDesC16 &)
IMPORT_C TIntSetIntOverride(const TDesC &, const TDesC &, TUint32)
IMPORT_C TIntSetLongDesOverride(const TDesC &, const TDesC &, const TDesC &)
Protected Member Functions
CCommDbOverrideSettings(TParamList)
voidCheckL(const TDesC &, const TDesC &, TValueType)
voidConstructL()
TInt FindOverride(const TDesC &, const TDesC &, TValueType)
TBool IllegalOverride(const TDesC &, const TDesC &)
TBool MatchIapOverride(const TCommDbIapConnectionPrefOverride &, const TCommDbIapConnectionPrefOverride &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enumTParamList { EParamListPartial, EParamListFull }
enumTValueType {
EIntValue, EBoolValue, EDes8Value, EDes16Value, ELongDesValue, EUnknownType
}
Protected Attributes
CCommsDatabase *iDb
RArray< TCommDbIapConnectionPrefOverride >iIapOverrides
RPointerArray< CCommDbOverride >iOverrides
TParamList iPartialFull

Constructor & Destructor Documentation

CCommDbOverrideSettings(TParamList)

CCommDbOverrideSettings(TParamListaParamList)[protected]

Parameters

TParamList aParamList

~CCommDbOverrideSettings()

IMPORT_C~CCommDbOverrideSettings()[virtual]

Member Functions Documentation

CheckL(const TDesC &, const TDesC &, TValueType)

voidCheckL(const TDesC &aTableName,
const TDesC &aColumnName,
TValueTypeaType
)const [protected]

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TValueType aType

Compare(CCommDbOverrideSettings *)

IMPORT_C TBoolCompare(CCommDbOverrideSettings *aOverrides)const

Parameters

CCommDbOverrideSettings * aOverrides

ConstructL()

voidConstructL()[protected, virtual]

FindOverride(const TDesC &, const TDesC &, TValueType)

TInt FindOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TValueTypeaType
)const [protected]

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TValueType aType

GetBoolOverride(const TDesC &, const TDesC &, TBool &)

IMPORT_C TIntGetBoolOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TBool &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TBool & aValue

GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)

IMPORT_C TIntGetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &aPref)

GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)

IMPORT_C TIntGetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &aPref)

GetDesOverride(const TDesC &, const TDesC &, TDes8 &)

IMPORT_C TIntGetDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TDes8 &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TDes8 & aValue

GetDesOverride(const TDesC &, const TDesC &, TDes16 &)

IMPORT_C TIntGetDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TDes16 &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TDes16 & aValue

GetIntOverride(const TDesC &, const TDesC &, TUint32 &)

IMPORT_C TIntGetIntOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TUint32 &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TUint32 & aValue

GetLongDesOverride(const TDesC &, const TDesC &, TDes &)

IMPORT_C TIntGetLongDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TDes &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TDes & aValue

GetLongDesOverrideLength(const TDesC &, const TDesC &, TInt &)

IMPORT_C TIntGetLongDesOverrideLength(const TDesC &aTableName,
const TDesC &aColumnName,
TInt &aLength
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TInt & aLength

IllegalOverride(const TDesC &, const TDesC &)

TBool IllegalOverride(const TDesC &aTableName,
const TDesC &aColumnName
)const [protected]

Parameters

const TDesC & aTableName
const TDesC & aColumnName

IsOverridden(const TDesC &, const TDesC &, TValueType)

IMPORT_C TBoolIsOverridden(const TDesC &aTableName,
const TDesC &aColumnName,
TValueTypeaType
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TValueType aType

MatchIapOverride(const TCommDbIapConnectionPrefOverride &, const TCommDbIapConnectionPrefOverride &)

TBool MatchIapOverride(const TCommDbIapConnectionPrefOverride &aFirst,
const TCommDbIapConnectionPrefOverride &aSecond
)[protected, static]

Parameters

const TCommDbIapConnectionPrefOverride & aFirst
const TCommDbIapConnectionPrefOverride & aSecond

NewL(TParamList)

IMPORT_C CCommDbOverrideSettings *NewL(TParamListaParamList)[static]

Parameters

TParamList aParamList

NewL(TParamList, TCommDbDatabaseType)

IMPORT_C CCommDbOverrideSettings *NewL(TParamListaParamList,
TCommDbDatabaseTypeaDbType
)[static]

Parameters

TParamList aParamList
TCommDbDatabaseType aDbType

PartialFull()

TParamList PartialFull()const [inline]

Returns the value set in the constructor.

An enumeration which determines whether this set of override values is full or partial.

SetBoolOverride(const TDesC &, const TDesC &, TBool)

IMPORT_C TIntSetBoolOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TBoolaValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TBool aValue

SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &)

IMPORT_C TIntSetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref &aPref)

SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &)

IMPORT_C TIntSetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref &aPref)

SetDesOverride(const TDesC &, const TDesC &, const TDesC8 &)

IMPORT_C TIntSetDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
const TDesC8 &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
const TDesC8 & aValue

SetDesOverride(const TDesC &, const TDesC &, const TDesC16 &)

IMPORT_C TIntSetDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
const TDesC16 &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
const TDesC16 & aValue

SetIntOverride(const TDesC &, const TDesC &, TUint32)

IMPORT_C TIntSetIntOverride(const TDesC &aTableName,
const TDesC &aColumnName,
TUint32aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
TUint32 aValue

SetLongDesOverride(const TDesC &, const TDesC &, const TDesC &)

IMPORT_C TIntSetLongDesOverride(const TDesC &aTableName,
const TDesC &aColumnName,
const TDesC &aValue
)

Parameters

const TDesC & aTableName
const TDesC & aColumnName
const TDesC & aValue

Member Enumerations Documentation

Enum TParamList

v7.0

Override setting flags returned by PartialFull(). The only use of TParamList is during the comparison of two override sets.

Enumerators

EParamListPartial

The override settings are partial; the CCommDbOverrideSettings object maintains override values for only some of the columns.

EParamListFull

The override settings are full; the CCommDbOverrideSettings object maintains override values for all columns

Enum TValueType

The value types that may be stored in as overrides Overrides are deprecated from v9.1 "Could just use TDbColType"

Enumerators

EIntValue

a TUint32.

EBoolValue

a TBool.

EDes8Value

a TDes8.

EDes16Value

a TDes16.

ELongDesValue

a TDes.

EUnknownType

Unkown type.

Member Data Documentation

CCommsDatabase * iDb

CCommsDatabase *iDb[protected]

RArray< TCommDbIapConnectionPrefOverride > iIapOverrides

RArray< TCommDbIapConnectionPrefOverride >iIapOverrides[protected]

RPointerArray< CCommDbOverride > iOverrides

RPointerArray< CCommDbOverride >iOverrides[protected]

TParamList iPartialFull

TParamList iPartialFull[protected]