CCommsDbConnectionPrefTableView Class Reference

#include <cdbpreftable.h>

Link against: commdb.lib

class CCommsDbConnectionPrefTableView : public CBase

Inherits from

CCommsDbConnectionPrefTableView
- CBase

Nested Classes and Structures

Protected Attributes
CCommsDatabase &	iDb
CCommDbTableExtension *	iTableExt
RDbView	iTableView

Public Member Functions
virtual	~CCommsDbConnectionPrefTableView()
IMPORT_C void	ChangeConnectionPreferenceRankL(TUint32)
IMPORT_C void	DeleteConnectionPreferenceL()
IMPORT_C TInt	GotoFirstRecord()
IMPORT_C TInt	GotoNextRecord()
IMPORT_C TInt	GotoPreviousRecord()
IMPORT_C void	InsertConnectionPreferenceL(const TCommDbIapConnectionPref &, TBool)
IMPORT_C void	InsertConnectionPreferenceL(const TCommDbIspConnectionPref &, TBool)
CCommsDbConnectionPrefTableView *	NewL(CCommsDatabase &, TCommDbConnectionDirection, TUint32)
CCommsDbConnectionPrefTableView *	NewLC(CCommsDatabase &, const TDbQuery &)
CCommsDbConnectionPrefTableView *	NewLC(CCommsDatabase &, TCommDbConnectionDirection, TBool)
IMPORT_C void	ReadConnectionPreferenceL(TCommDbIapConnectionPref &)
IMPORT_C void	ReadConnectionPreferenceL(TCommDbIspConnectionPref &)
IMPORT_C void	SwapConnectionPreferencesL(TCommDbConnectionDirection, TUint32, TUint32)
IMPORT_C void	UpdateBearerL(const TCommDbIapBearer &, TBool)
IMPORT_C void	UpdateBearerL(const TCommDbIspBearer &, TBool)
IMPORT_C void	UpdateDialogPrefL(const TCommDbDialogPref &)

Protected Member Functions
	CCommsDbConnectionPrefTableView(CCommsDatabase &)
void	Close()
TDbColNo	ColNum(const TDesC &)
void	ConstructL(const TDbQuery &)
void	ConstructL(TCommDbConnectionDirection, TBool)
void	ConstructL(TCommDbConnectionDirection, TUint32)
RDbRowSet::TAccess	GetL()
void	GetUint32L(const TDesC &, TUint32 &)
void	OpenL(const TDbQuery &)

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()

Detailed Description

Implements actions on records of the Connection Preferences table, to allow clients to set the preferred order in which connections are attempted.

The class is similiar to CCommsDbTableView, but only allows access to connection preferences as a set and not to individual fields in the table. This prevents inappropriate updates of the records. Like CCommsDbTableView, the class has a group of functions for navigating through the records in the view, and another group for setting fields in the current record.

Clients do not create this type of object, but get an instance through CCommsDatabase::OpenConnectionPrefTableLC(), CCommsDatabase::OpenConnectionPrefTableInRankOrderLC(), or CCommsDatabase::OpenConnectionPrefTableViewOnRankLC().

In addition to the leave codes documented, all leaving functions can leave with any error returned by DBMS during database manipulation.

See also: CCommDbOverrideSettings::GetConnectionPreferenceOverride() CCommDbOverrideSettings::SetConnectionPreferenceOverride()

Member Attribute Documentation

iDb

CCommsDatabase &

iDb

[protected]

Comms data base that is being viewed.

iTableExt

CCommDbTableExtension *

iTableExt

[protected]

iTableView

RDbView

iTableView

[protected]

DBMS view. Variable not used in shim. Not removed because of BC break

Constructor & Destructor Documentation

CCommsDbConnectionPrefTableView ( CCommsDatabase & )

CCommsDbConnectionPrefTableView

(

CCommsDatabase &

aDb

)

[protected]

Constructor

Parameters
aDb	reference to the database to use.

~CCommsDbConnectionPrefTableView ( )

IMPORT_C

~CCommsDbConnectionPrefTableView

(

)

[virtual]

Destructor.

Member Function Documentation

ChangeConnectionPreferenceRankL ( TUint32 )

IMPORT_C void

ChangeConnectionPreferenceRankL

(

TUint32

aNewRank

)

Sets the rank field (CONNECT_PREF_RANKING) in the currently selected connection preference record in the view.

Note that if the new rank is not zero, and there is already a record with this rank and the same direction, then the existing record's rank is set to zero. This means that record is not used when the system finds the preferred connections.

Parameters
aNewRank	The new rank for the record.

Leave Codes
KErrAccessDenied	The record cannot be updated as it is read-only
KErrNotFound	There is no current record in the view
KErrOverflow	aNewRank is greater than the maximum allowed

Capability
Dependent	on table, see the guide page referenced below.

Close ( )

void

(

)

[protected]

Closes the rowset and releases any owned resources.

ColNum ( const TDesC & )

TDbColNo

ColNum

(

const TDesC &

aColumn

)

const [protected, inline]

Returns the column number of the Column aColumn in the table

Coloumn concept doesn't exist in CommsDat depNot supported from v9.1

Parameters
aColumn	A reference to a descriptor containing the name of a column in the current record.

Return Value: The ordinal number of the column else KDbNullColNo if no such column exists.

ConstructL ( const TDbQuery & )

void

ConstructL

(

const TDbQuery &

aQuery

)

[protected]

Prepares and evaluates the table view using the SQL query aQuery

DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.

Parameters
aQuery	Query to perform

ConstructL ( TCommDbConnectionDirection, TBool )

void	ConstructL	(	TCommDbConnectionDirection	aDirection,
			TBool	aSortRanking
		)	[protected]

Creates RecordSet Container and loads date to it.

ConstructL ( TCommDbConnectionDirection, TUint32 )

void	ConstructL	(	TCommDbConnectionDirection	aDirection,
			TUint32	aRank
		)	[protected]

Prepares and evaluates the table view using params

DeleteConnectionPreferenceL ( )

IMPORT_C void

DeleteConnectionPreferenceL

(

)

Deletes the currently selected connection preference record in the view.

Capability
Dependent	on table, see the guide page referenced below.

GetL ( )

RDbRowSet::TAccess

GetL

(

)

[protected]

Gets the operations that can be performed on the current connection preference record If there isn't an access table at all, then treat the table as updatable.

Return Value: EUpdatable, if All operations can be performed on the rowset. EReadOnly, Row navigation and reading are permitted. EInsertOnly, Inserting new rows is the only valid operation on the rowset.

GetUint32L ( const TDesC &, TUint32 & )

void	GetUint32L	(	const TDesC &	aColumnName,
			TUint32 &	aValue
		)	[protected]

GotoFirstRecord ( )

IMPORT_C TInt

GotoFirstRecord

(

)

Sets the first connection preference record in this view as the current record.

Return Value: KErrNotFound if the view has no records. Error codes from DBMS can also be returned.

Capability
Dependent	on table, see the guide page referenced below.

GotoNextRecord ( )

IMPORT_C TInt

GotoNextRecord

(

)

Sets the next connection preference record in the view as the current record.

Return Value: KErrNotFound if the current record is the last in the view. Error codes from DBMS can also be returned.

Capability
Dependent	on table, see the guide page referenced below.

GotoPreviousRecord ( )

IMPORT_C TInt

GotoPreviousRecord

(

)

Sets the previous connection preference record in the view as the current record.

Return Value: KErrNotFound if the current record is the first in the view. Error codes from DBMS can also be returned.

Capability
Dependent	on table, see the guide page referenced below.

InsertConnectionPreferenceL ( const TCommDbIapConnectionPref &, TBool )

IMPORT_C void	InsertConnectionPreferenceL	(	const TCommDbIapConnectionPref &	aPref,
			TBool	aReadOnly = EFalse
		)

Inserts a new IAP connection preference into the connetion preference table. The supplied `aPref` is checked to ensure that the rank and direction do not conflict with existing records. The dialog option, bearer set and IAP are checked for consistancy. Deprecated in 7.0 but re-instated to accommodate 6.1 BC

Parameters
aPref	Settings for the new connection preference.
aReadOnly	If ETrue the record is set to be read-only. If left unspecified the default is EFalse.

Capability
Dependent	on table, see the guide page referenced below.

InsertConnectionPreferenceL ( const TCommDbIspConnectionPref &, TBool )

IMPORT_C void	InsertConnectionPreferenceL	(	const TCommDbIspConnectionPref &	aPref,
			TBool	aReadOnly = EFalse
		)

Override version of InsertConnectionPreferenceL for BC purposes. DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.

Parameters
aPref	Preferences.
aReadOnly	Read only?

NewL ( CCommsDatabase &, TCommDbConnectionDirection, TUint32 )

CCommsDbConnectionPrefTableView *	NewL	(	CCommsDatabase &	aDb,
			TCommDbConnectionDirection	aDirection,
			TUint32	aRank
		)	[static]

Create a view. Usually, however, views are created by calling one of the CCommsDatabase::OpenConnectionPrefTable*LC() functions.

Parameters
aDb	reference to the database to use.

Return Value: Reference to the new CCommsDbConnectionPrefTableView.

NewLC ( CCommsDatabase &, const TDbQuery & )

CCommsDbConnectionPrefTableView *	NewLC	(	CCommsDatabase &	aDb,
			const TDbQuery &	aQuery
		)	[static]

CCommsDbConnectionPrefTableView definitions Create a view. Usually, however, views are created by calling one of the CCommsDatabase::OpenConnectionPrefTable*LC() functions.

DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.

Parameters
aDb	reference to the database to use.
aQuery	Query to preform

Return Value: Reference to the new CCommsDbConnectionPrefTableView.

NewLC ( CCommsDatabase &, TCommDbConnectionDirection, TBool )

CCommsDbConnectionPrefTableView *	NewLC	(	CCommsDatabase &	aDb,
			TCommDbConnectionDirection	aDirection,
			TBool	aSortRanking = EFalse
		)	[static]

Create a view. Usually, however, views are created by calling one of the CCommsDatabase::OpenConnectionPrefTable*LC() functions.

Parameters
aDb	reference to the database to use.
aSortRanking	-> ETrue Sort by ranking, EFalse not sorted

Return Value: Reference to the new CCommsDbConnectionPrefTableView.

OpenL ( const TDbQuery & )

void

OpenL

(

const TDbQuery &

aQuery

)

[protected]

ReadConnectionPreferenceL ( TCommDbIapConnectionPref & )

IMPORT_C void

ReadConnectionPreferenceL

(

TCommDbIapConnectionPref &

aPref

)

Gets the IAP connection preferences record currently selected in the view.

Parameters
aPref	On return, the connection preferences

Leave Codes
KErrNotFound	There is no current record in the view
KErrUnknown	A field in the connection preference record is null

Capability
Dependent	on table, see the guide page referenced below.

ReadConnectionPreferenceL ( TCommDbIspConnectionPref & )

IMPORT_C void

ReadConnectionPreferenceL

(

TCommDbIspConnectionPref &

aPref

)

Deprecatedin v7.0

Framework left to support BC with v6.1

Leave Codes
KErrNotSupported

SwapConnectionPreferencesL ( TCommDbConnectionDirection, TUint32, TUint32 )

IMPORT_C void	SwapConnectionPreferencesL	(	TCommDbConnectionDirection	aDirection,
			TUint32	aFirstRank,
			TUint32	aSecondRank
		)

Swaps the bearer (CONNECT_PREF_BEARER_SET) and the IAP (CONNECT_PREF_IAP) fields between two connection preferences records.

The records to use are specified by their rank (CONNECT_PREF_RANKING) and direction (CONNECTION_PREF_DIRECTION).

Note that the dialogue option is not altered.

Parameters
aDirection	Direction of the connection preferences records
aFirstRank	Rank of the first record to swap
aSecondRank	Rank of the second record to swap

Leave Codes
KErrAccessDenied	The record cannot be updated as it is read-only
KErrArgument	There is more than one record with the same ranking as one of the rankings
KErrNotFound	A record with one of the rankings does not exist
KErrOverflow	One of the rankings is greater than the maximum allowed

Capability
Dependent	on table, see the guide page referenced below.

UpdateBearerL ( const TCommDbIapBearer &, TBool )

IMPORT_C void	UpdateBearerL	(	const TCommDbIapBearer &	aUpdate,
			TBool	aReadOnly = EFalse
		)

Update the bearer set and IAP for the currently selected IAP connection preference record. The dialog option, bearer set and IAP are checked for consistancy. Deprecated in 7.0 but re-instated to accomodate 6.1 BC. Update the bearer set and iap for the currently selected connection preference. The dialog option, bearer set and IAP are checked for consistancy. The function sets the bearer set (CONNECT_PREF_BEARER_SET) and IAP (CONNECT_PREF_IAP) fields. The direction field (CONNECTION_PREF_DIRECTION) cannot be altered after it has been written to the record.

Parameters
aUpdate	Updated settings for the connection preference. Note that all fields need to be set, including any unchanged fields.
aReadOnly	If true, the record is set to be read-only. If unspecified, EFalse by default.

Leave Codes
KErrAccessDenied	The record cannot be updated as it is read-only; KErrArgument The specified IAP (aPref.iBearer.iIapId) cannot be used, as it does not fall in the bearer set defined by aPref.iBearer.iBearerSet and have the same direction as aPref.iDirection; KErrNotFound There is no current record in the view.

Capability
Dependent	on table, see the guide page referenced below.

UpdateBearerL ( const TCommDbIspBearer &, TBool )

IMPORT_C void	UpdateBearerL	(	const TCommDbIspBearer &	aUpdate,
			TBool	aReadOnly = EFalse
		)

Override version of UpdateBearerL for BC purposes. DeprecatedThis method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.

Parameters
aUpdate	Update.
aReadOnly	Read only?

Return Value: KErrNotSupported.

UpdateDialogPrefL ( const TCommDbDialogPref & )

IMPORT_C void

UpdateDialogPrefL

(

const TCommDbDialogPref &

aUpdate

)

Updates the dialog preference field (CONNECT_PREF_DIALOG_PREF) in the currently selected connection preferences IAP record in the view.

Parameters
aUpdate	New value for the dialog preference field

Leave Codes
KErrAccessDenied	The record cannot be updated as it is read-only
KErrNotFound	There is no current record in the view

Capability
Dependent	on table, see the guide page referenced below.