Collapse all Symbian^3 Product Developer Library

CPsClientData Class Reference

class CPsClientData : public CBase

This is a client side class to hold the results of search

PsServerClientAPI.lib

Since: S60 v3.2

Inherits from

CPsClientData
- CBase

Public Member Functions
	~CPsClientData()
IMPORT_C CPsClientData *	CloneL()
IMPORT_C HBufC *	Data(TInt)
IMPORT_C TInt	DataElementCount()
IMPORT_C TAny *	DataExtension()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TUint8	FieldMatch()
IMPORT_C TInt	Id()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	IsMarked()
IMPORT_C CPsClientData *	NewL()
IMPORT_C void	SetDataExtensionL(TAny *)
IMPORT_C void	SetDataL(const TInt, const TDesC &)
IMPORT_C void	SetFieldMatch(TUint8)
IMPORT_C void	SetId(const TInt)
IMPORT_C void	SetMark()
IMPORT_C void	SetUriL(const TDesC &)
IMPORT_C HBufC *	Uri()

Private Member Functions
	CPsClientData()
void	ConstructL()
void	ConstructL(const CPsClientData &)

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

Private Attributes
RPointerArray< HBufC > *	iData
TAny *	iDataExtension
TUint8	iFiledMatches
TInt	iId
TBool	iMarked
HBufC *	iUri

Constructor & Destructor Documentation

CPsClientData()

CPsClientData

(

)

[private]

Default Constructor

~CPsClientData()

IMPORT_C

~CPsClientData

(

)

Destructor

Member Functions Documentation

CloneL()

IMPORT_C CPsClientData *

CloneL

(

)

const

Makes a clone of the current object

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor

ConstructL(const CPsClientData &)

void

ConstructL

(

const CPsClientData &

aRhs

)

[private]

Second phase constructor

Parameters

const CPsClientData & aRhs

Data(TInt)

IMPORT_C HBufC *

Data

(

TInt

aIndex

)

const

Pointer to the data element at the specified location

Parameters

TInt aIndex

Index of data element

DataElementCount()

IMPORT_C TInt

DataElementCount

(

)

const

Returns the number of data elements

DataExtension()

IMPORT_C TAny *

DataExtension

(

)

const

Returns the data extension

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Writes 'this' to the stream

Parameters

RWriteStream & aStream

WriteStream with externalized contents

FieldMatch()

IMPORT_C TUint8

FieldMatch

(

)

const

Returns the Field match attribute

Id()

IMPORT_C TInt

(

)

const

Provides the unique identifier of this object

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Initializes 'this' from stream

Parameters

RReadStream & aStream

ReadStream with data contents to be internalized

IsMarked()

IMPORT_C TBool

IsMarked

(

)

const

Returns ETrue if the contact is bookmarked, else EFalse

NewL()

IMPORT_C CPsClientData *

NewL

(

)

[static]

Two phase construction

SetDataExtensionL(TAny *)

IMPORT_C void

SetDataExtensionL

(

TAny *

aDataExt

)

Set the data extension

Parameters

TAny * aDataExt

Data Extension for this object

SetDataL(const TInt, const TDesC &)

IMPORT_C void	SetDataL	(	const TInt	aIndex,
			const TDesC &	aData
		)

Sets the data at the specified location

Parameters

const TInt aIndex	Index of data element
const TDesC & aData	Data descriptor to be searched

SetFieldMatch(TUint8)

IMPORT_C void

SetFieldMatch

(

TUint8

aFieldMatch

)

Sets FieldMatch attribute

Parameters

TUint8 aFieldMatch

SetId(const TInt)

IMPORT_C void

SetId

(

const TInt

aId

)

Sets the unique identifier of this object

Parameters

const TInt aId

The unique identifier

SetMark()

IMPORT_C void

SetMark

(

)

Sets the contact as bookmarked

SetUriL(const TDesC &)

IMPORT_C void

SetUriL

(

const TDesC &

aUri

)

Sets the unique URI of this object

Parameters

const TDesC & aUri

The unique URI

Uri()

IMPORT_C HBufC *

Uri

(

)

const

Provides the URI of this object

Member Data Documentation

RPointerArray< HBufC > * iData

RPointerArray< HBufC > *

iData

[private]

Data fields

TAny * iDataExtension

TAny *

iDataExtension

[private]

Extended Data field

TUint8 iFiledMatches

TUint8

iFiledMatches

[private]

Indicates in bit positions, what data fields are matched for predictive search

TInt iId

TInt

iId

[private]

Unique id

TBool iMarked

TBool

iMarked

[private]

Field to indicate if a contact is bookmarked or not

HBufC * iUri

HBufC *

iUri

[private]

URI. Indicates the data source.