Collapse all Symbian^3 Product Developer Library

CMdEObjectCondition Class Reference

class CMdEObjectCondition

Query condition for objects.

Public Member Functions
	~CMdEObjectCondition()
IMPORT_C TObjectConditionCompareMethod	CompareMethod()
IMPORT_C TObjectConditionConfidentialityLevel	ConfidentialityLevel()
TUint32	InternalQueryOptimizationFlags(TUint32 &)
CMdEObjectCondition *	NewL(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)
CMdEObjectCondition *	NewL(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)
CMdEObjectCondition *	NewLC(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)
CMdEObjectCondition *	NewLC(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)
IMPORT_C TBool	NotPlaceholder()
IMPORT_C TBool	NotPresent()
IMPORT_C const CMdEObjectDef *	ObjectDef()
IMPORT_C TItemId	ObjectId()
IMPORT_C const RArray< TItemId > *	ObjectIds()
IMPORT_C TBool	PlaceholderOnly()
TUint32	RequiredBufferSize()
void	SerializeL(CMdCSerializationBuffer &, TMdCOffset &)
IMPORT_C void	SetConfidentialityLevel(TObjectConditionConfidentialityLevel)
IMPORT_C void	SetNotPlaceholder(TBool)
IMPORT_C void	SetNotPresent(TBool)
IMPORT_C void	SetPlaceholderOnly(TBool)
IMPORT_C const TDesC *	String()

Private Member Functions
	CMdEObjectCondition(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)
	CMdEObjectCondition(TObjectConditionCompareMethod)
void	ConstructL()
void	ConstructL(const RArray< TItemId > , const TDesC , const TMdEUintRange *)

Private Attributes
TObjectConditionCompareMethod	iCompareMethod
TObjectConditionConfidentialityLevel	iConfidentialityLevel
TUint32	iFlags
TInt64	iGuidHigh
TInt64	iGuidLow
const CMdEObjectDef *	iObjectDef
TItemId	iObjectId
RArray< TItemId > *	iObjectIds
TBool	iPlaceholdersOnly
TMdEUintRange *	iRange
HBufC *	iString

Constructor & Destructor Documentation

CMdEObjectCondition(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

CMdEObjectCondition	(	TObjectConditionCompareMethod	aCompareMethod,
		TItemId	aObjectId,
		const CMdEObjectDef *	aObjectDef,
		TInt64	aObjectGuidHigh,
		TInt64	aObjectGuidLow
	)	[private]

Constructor.

Parameters

TObjectConditionCompareMethod aCompareMethod	Comparison method.
TItemId aObjectId	ID number of an object.
const CMdEObjectDef * aObjectDef	Object definition.
TInt64 aObjectGuidHigh	object's GUID high part.
TInt64 aObjectGuidLow	object's GUID low part.

CMdEObjectCondition(TObjectConditionCompareMethod)

CMdEObjectCondition

(

TObjectConditionCompareMethod

aCompareMethod

)

[private]

Constructor.

Parameters

TObjectConditionCompareMethod aCompareMethod

Comparison method.

~CMdEObjectCondition()

~CMdEObjectCondition

(

)

[virtual]

Destructor.

Member Functions Documentation

CompareMethod()

IMPORT_C TObjectConditionCompareMethod

CompareMethod

(

)

const

Returns the comparison method of the condition.

ConfidentialityLevel()

IMPORT_C TObjectConditionConfidentialityLevel

ConfidentialityLevel

(

)

const

Returns the level of confidentiality of the condition.

ConstructL()

void

ConstructL

(

)

[private]

Second-phase constructor.

ConstructL(const RArray< TItemId > , const TDesC , const TMdEUintRange *)

void	ConstructL	(	const RArray< TItemId > *	aObjectIds,
			const TDesC *	aString,
			const TMdEUintRange *	aRange
		)	[private]

Second-phase constructor.

Parameters

const RArray< TItemId > * aObjectIds	object IDs to look for.
const TDesC * aString	Text string to look for.
const TMdEUintRange * aRange

InternalQueryOptimizationFlags(TUint32 &)

TUint32

InternalQueryOptimizationFlags

(

TUint32 &

aFlags

)

Get possible query's internal optimization flags from condition.

Parameters

TUint32 & aFlags

NewL(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

CMdEObjectCondition *	NewL	(	TObjectConditionCompareMethod	aCompareMethod,
			TItemId	aObjectId = KNoId ,
			const CMdEObjectDef *	aObjectDef = NULL,
			TInt64	aObjectGuidHigh = 0,
			TInt64	aObjectGuidLow = 0
		)	[static]

Two-phased constructor.

Parameters

TObjectConditionCompareMethod aCompareMethod
TItemId aObjectId = KNoId
const CMdEObjectDef * aObjectDef = NULL
TInt64 aObjectGuidHigh = 0
TInt64 aObjectGuidLow = 0

NewL(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)

CMdEObjectCondition *	NewL	(	TObjectConditionCompareMethod	aCompareMethod,
			const RArray< TItemId > *	aObjectIds = NULL,
			const TDesC *	aString = NULL,
			const TMdEUintRange *	aRange = NULL
		)	[static]

Parameters

TObjectConditionCompareMethod aCompareMethod
const RArray< TItemId > * aObjectIds = NULL
const TDesC * aString = NULL
const TMdEUintRange * aRange = NULL

NewLC(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

CMdEObjectCondition *	NewLC	(	TObjectConditionCompareMethod	aCompareMethod,
			TItemId	aObjectId = KNoId ,
			const CMdEObjectDef *	aObjectDef = NULL,
			TInt64	aObjectGuidHigh = 0,
			TInt64	aObjectGuidLow = 0
		)	[static]

Parameters

TObjectConditionCompareMethod aCompareMethod
TItemId aObjectId = KNoId
const CMdEObjectDef * aObjectDef = NULL
TInt64 aObjectGuidHigh = 0
TInt64 aObjectGuidLow = 0

NewLC(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)

CMdEObjectCondition *	NewLC	(	TObjectConditionCompareMethod	aCompareMethod,
			const RArray< TItemId > *	aObjectIds = NULL,
			const TDesC *	aString = NULL,
			const TMdEUintRange *	aRange = NULL
		)	[static]

Parameters

TObjectConditionCompareMethod aCompareMethod
const RArray< TItemId > * aObjectIds = NULL
const TDesC * aString = NULL
const TMdEUintRange * aRange = NULL

NotPlaceholder()

IMPORT_C TBool

NotPlaceholder

(

)

const

Determines whether the condition requires the object to be a not placeholder object.

NotPresent()

IMPORT_C TBool

NotPresent

(

)

const

Determines whether the condition requires the object to be a present object or not.

ObjectDef()

IMPORT_C const CMdEObjectDef *

ObjectDef

(

)

const

Returns the object definition of the condition.

ObjectId()

IMPORT_C TItemId

ObjectId

(

)

const

Returns the object ID number of the condition.

ObjectIds()

IMPORT_C const RArray< TItemId > *

ObjectIds

(

)

const

Returns the object ID numbers of the condition.

PlaceholderOnly()

IMPORT_C TBool

PlaceholderOnly

(

)

const

Determines whether the condition requires the object to be a not placeholder object.

RequiredBufferSize()

TUint32

RequiredBufferSize

(

)

const

Get required size of serialized buffer when this is serialized.

SerializeL(CMdCSerializationBuffer &, TMdCOffset &)

void	SerializeL	(	CMdCSerializationBuffer &	aBuffer,
			TMdCOffset &	aFreespaceOffset
		)	const

Serialize own data to serialized buffer (correct position must be set before calling) and return new position of serialized buffer.

Parameters

CMdCSerializationBuffer & aBuffer	serialized buffer.
TMdCOffset & aFreespaceOffset

SetConfidentialityLevel(TObjectConditionConfidentialityLevel)

IMPORT_C void

SetConfidentialityLevel

(

TObjectConditionConfidentialityLevel

aLevel

)

Sets the confidentiality level for the condition. Default level is ELevelNormal.

Parameters

TObjectConditionConfidentialityLevel aLevel

focuses the search to confidential or non-confidential objects or both of them.

SetNotPlaceholder(TBool)

IMPORT_C void

SetNotPlaceholder

(

TBool

aNotPlaceholder

)

Sets whether the condition requires the object to be a not placeholder object.

Parameters

TBool aNotPlaceholder

ETrue, if the object should be a not placeholder object. EFalse otherwise.

SetNotPresent(TBool)

IMPORT_C void

SetNotPresent

(

TBool

aNotPresent

)

Sets whether the condition requires the object to be a present object or not.

Parameters

TBool aNotPresent

ETrue, if the object should be a not present object. EFalse otherwise.

SetPlaceholderOnly(TBool)

IMPORT_C void

SetPlaceholderOnly

(

TBool

aPlaceholderOnly

)

Sets whether the condition requires the object to be a not placeholder object.

Parameters

TBool aPlaceholderOnly

String()

IMPORT_C const TDesC *

String

(

)

const

Returns the string of the condition.

Member Data Documentation

TObjectConditionCompareMethod iCompareMethod

TObjectConditionCompareMethod

iCompareMethod

[private]

Compare method for the string.

TObjectConditionConfidentialityLevel iConfidentialityLevel

TObjectConditionConfidentialityLevel

iConfidentialityLevel

[private]

Determines confidentiality level of result object. By default level is ELevelNormal, which means that query returns only non-confidential objects as result.

TUint32 iFlags

TUint32

iFlags

[private]

Object condition flags not present not placeholder

TInt64 iGuidHigh

TInt64

iGuidHigh

[private]

Object's GUID high part.

TInt64 iGuidLow

TInt64

iGuidLow

[private]

Object's GUID low part.

const CMdEObjectDef * iObjectDef

const CMdEObjectDef *

iObjectDef

[private]

Object definition to match. NULL, if not applicable.

TItemId iObjectId

TItemId

iObjectId

[private]

The object's ID.

RArray< TItemId > * iObjectIds

RArray< TItemId > *

iObjectIds

[private]

The objects' ID.

TBool iPlaceholdersOnly

TBool

iPlaceholdersOnly

[private]

TMdEUintRange * iRange

TMdEUintRange *

iRange

[private]

HBufC * iString

HBufC *

iString

[private]

String to match. NULL, if not applicable.

CMdEObjectCondition Class Reference

Constructor & Destructor Documentation

CMdEObjectCondition(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

Parameters

CMdEObjectCondition(TObjectConditionCompareMethod)

Parameters

~CMdEObjectCondition()

Member Functions Documentation

CompareMethod()

ConfidentialityLevel()

ConstructL()

ConstructL(const RArray< TItemId > *, const TDesC *, const TMdEUintRange *)

Parameters

InternalQueryOptimizationFlags(TUint32 &)

Parameters

NewL(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

Parameters

NewL(TObjectConditionCompareMethod, const RArray< TItemId > *, const TDesC *, const TMdEUintRange *)

Parameters

NewLC(TObjectConditionCompareMethod, TItemId, const CMdEObjectDef *, TInt64, TInt64)

Parameters

NewLC(TObjectConditionCompareMethod, const RArray< TItemId > *, const TDesC *, const TMdEUintRange *)

Parameters

NotPlaceholder()

NotPresent()

ObjectDef()

ObjectId()

ObjectIds()

PlaceholderOnly()

RequiredBufferSize()

SerializeL(CMdCSerializationBuffer &, TMdCOffset &)

Parameters

SetConfidentialityLevel(TObjectConditionConfidentialityLevel)

Parameters

SetNotPlaceholder(TBool)

Parameters

SetNotPresent(TBool)

Parameters

SetPlaceholderOnly(TBool)

Parameters

String()

Member Data Documentation

TObjectConditionCompareMethod iCompareMethod

TObjectConditionConfidentialityLevel iConfidentialityLevel

TUint32 iFlags

TInt64 iGuidHigh

TInt64 iGuidLow

const CMdEObjectDef * iObjectDef

TItemId iObjectId

RArray< TItemId > * iObjectIds

TBool iPlaceholdersOnly

TMdEUintRange * iRange

HBufC * iString

ConstructL(const RArray< TItemId > , const TDesC , const TMdEUintRange *)

NewL(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)

NewLC(TObjectConditionCompareMethod, const RArray< TItemId > , const TDesC , const TMdEUintRange *)