Collapse all Symbian^3 Product Developer Library

UserPromptService::CDecisionFilter Class Reference

class UserPromptService::CDecisionFilter : public CBase

Stores the filter key values that used to query the database. A filter object can be created in one phase by supplying all required parameters, or an empty filter is first created and then required filter keys are set separately.

Inherits from

UserPromptService::CDecisionFilter
- CBase

Public Member Functions
	~CDecisionFilter()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CDecisionFilter *	NewL()
IMPORT_C CDecisionFilter *	NewL(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TDesC8 &, const TDesC8 &, const TUint16 &)
IMPORT_C CDecisionFilter *	NewLC()
IMPORT_C CDecisionFilter *	NewLC(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TDesC8 &, const TDesC8 &, const TUint16 &)
IMPORT_C void	SetClientEntityL(const TDesC8 &, const TComparisonOp)
IMPORT_C void	SetClientSid(const TSecureId &, const TComparisonOp)
IMPORT_C void	SetDescriptionL(const TDesC &, const TComparisonOp)
IMPORT_C void	SetEvaluatorId(const TUid &, const TComparisonOp)
IMPORT_C void	SetEvaluatorInfo(const TUint32 &, const TComparisonOp)
IMPORT_C void	SetFingerprintL(const TDesC8 &, const TComparisonOp)
IMPORT_C void	SetMajorPolicyVersion(const TUint16 &, const TComparisonOp)
IMPORT_C void	SetRecordId(const TUint32 &, const TComparisonOp)
IMPORT_C void	SetResult(const TUint8 &, const TComparisonOp)
IMPORT_C void	SetServerSid(const TSecureId &, const TComparisonOp)
IMPORT_C void	SetServiceId(const TUid &, const TComparisonOp)

Private Member Functions
	CDecisionFilter()
	CDecisionFilter(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TUint16 &)
void	ConstructL(const TDesC8 &, const TDesC8 &)
void	ValidateL()

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
HBufC8 *	iClientEntity
TSecureId	iClientSid
HBufC *	iDescription
TUid	iEvaluatorId
TUint32	iEvaluatorInfo
HBufC8 *	iFingerprint
TUint16	iMajorPolicyVersion
TUint32	iRecordId
TUint8	iResult
TSecureId	iServerSid
TUid	iServiceId
TUint32	iSetFlag

Constructor & Destructor Documentation

CDecisionFilter()

CDecisionFilter

(

)

[private]

Constructor for an empty decision filter.

CDecisionFilter(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TUint16 &)

CDecisionFilter	(	const TSecureId &	aClientSid,
		const TUid &	aEvaluatorId,
		const TUid &	aServiceId,
		const TSecureId &	aServerSid,
		const TUint16 &	aVersion
	)	[private]

Constructor for the decision filter. Assigns the ID values.

Parameters

const TSecureId & aClientSid
const TUid & aEvaluatorId
const TUid & aServiceId
const TSecureId & aServerSid
const TUint16 & aVersion

~CDecisionFilter()

~CDecisionFilter

(

)

Destructor for the decision filter

Member Functions Documentation

ConstructL(const TDesC8 &, const TDesC8 &)

void	ConstructL	(	const TDesC8 &	aFingerprint,
			const TDesC8 &	aClientEntity
		)	[private]

Second phase constructor for the decision filter. Sets members allocated on the heap. The function leaves, if any buffer allocation fails.

Parameters

const TDesC8 & aFingerprint
const TDesC8 & aClientEntity

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalise this CDecisionFilter object to the specified stream.

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalise this CDecisionFilter object from the specified stream.

Parameters

RReadStream & aStream

NewL()

IMPORT_C CDecisionFilter *

NewL

(

)

[static]

Creates an empty filter object. The function is used to define any number of filter keys. It leaves, if the creation of the filter object fails.

NewL(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TDesC8 &, const TDesC8 &, const TUint16 &)

IMPORT_C CDecisionFilter *	NewL	(	const TSecureId &	aClientSid,
			const TUid &	aEvaluatorId,
			const TUid &	aServiceId,
			const TSecureId &	aServerSid,
			const TDesC8 &	aFingerprint,
			const TDesC8 &	aClientEntity,
			const TUint16 &	aVersion
		)	[static]

Creates a filter object and assigns all filter keys. The function leaves, if creation of the filter object fails.

Parameters

const TSecureId & aClientSid	Secure Id of client application
const TUid & aEvaluatorId	UID for the policy evaluator DLL
const TUid & aServiceId	UID for service e.g. sms, mms, telephony, gprs
const TSecureId & aServerSid	Secure Id for the system server that the decision applies to
const TDesC8 & aFingerprint	Hash of the destination and/or opaque data.
const TDesC8 & aClientEntity	The name of the entity within the client that requested the service.
const TUint16 & aVersion	Major version of policy file.

NewLC()

IMPORT_C CDecisionFilter *

NewLC

(

)

[static]

Creates an empty filter object. The function is used to define any number of filter keys. It leaves, if the creation of the filter object fails.

NewLC(const TSecureId &, const TUid &, const TUid &, const TSecureId &, const TDesC8 &, const TDesC8 &, const TUint16 &)

IMPORT_C CDecisionFilter *	NewLC	(	const TSecureId &	aClientSid,
			const TUid &	aEvaluatorId,
			const TUid &	aServiceId,
			const TSecureId &	aServerSid,
			const TDesC8 &	aFingerprint,
			const TDesC8 &	aClientEntity,
			const TUint16 &	aVersion
		)	[static]

Creates a filter object and assigns all filter keys. The function leaves, if creation of the filter object fails.

Parameters

const TSecureId & aClientSid	Secure Id of client application
const TUid & aEvaluatorId	UID for the policy evaluator DLL
const TUid & aServiceId	UID for service e.g. sms, mms, telephony, gprs
const TSecureId & aServerSid	Secure Id for the system server that the decision applies to
const TDesC8 & aFingerprint	Hash of the destination and/or opaque data.
const TDesC8 & aClientEntity	The name of the entity within the client that requested the service.
const TUint16 & aVersion	Major version of policy file.

SetClientEntityL(const TDesC8 &, const TComparisonOp)

IMPORT_C void	SetClientEntityL	(	const TDesC8 &	aClientEntity,
			const TComparisonOp	aOp
		)

Sets the client entity. A buffer is allocated on the heap and aClientEntity copied into it. The function leaves, if the buffer allocation fails.

Parameters

const TDesC8 & aClientEntity	The name of the entity within the client. (Maximum length is 32 bytes)
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetClientSid(const TSecureId &, const TComparisonOp)

IMPORT_C void	SetClientSid	(	const TSecureId &	aSid,
			const TComparisonOp	aOp
		)

Sets the Secure ID of the client application.

Parameters

const TSecureId & aSid
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetDescriptionL(const TDesC &, const TComparisonOp)

IMPORT_C void	SetDescriptionL	(	const TDesC &	aDescription,
			const TComparisonOp	aOp
		)

Sets the description field. A buffer is allocated on the heap and aDescription copied into it. The function leaves, if the buffer allocation fails.

Parameters

const TDesC & aDescription	A copy of description and/or opaque. (Maximum length is 32 bytes)
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetEvaluatorId(const TUid &, const TComparisonOp)

IMPORT_C void	SetEvaluatorId	(	const TUid &	aUid,
			const TComparisonOp	aOp
		)

Sets the UID of the policy evaluator DLL.

Parameters

const TUid & aUid	UID for the policy evaluator DLL
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetEvaluatorInfo(const TUint32 &, const TComparisonOp)

IMPORT_C void	SetEvaluatorInfo	(	const TUint32 &	aEvaluatorInfo,
			const TComparisonOp	aOp
		)

Sets the evaluator info field of the decision record which is searched.

Parameters

const TUint32 & aEvaluatorInfo	Policy evaluator specific data
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetFingerprintL(const TDesC8 &, const TComparisonOp)

IMPORT_C void	SetFingerprintL	(	const TDesC8 &	aFingerprint,
			const TComparisonOp	aOp
		)

Sets the fingerprint. A buffer is allocated on the heap and aFingerprint copied into it. The function leaves, if the buffer allocation fails.

Parameters

const TDesC8 & aFingerprint	Hash of the destination and/or opaque data. (Maximum length is 32 bytes)
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetMajorPolicyVersion(const TUint16 &, const TComparisonOp)

IMPORT_C void	SetMajorPolicyVersion	(	const TUint16 &	aVersion,
			const TComparisonOp	aOp
		)

Sets the major version of the policy file.

Parameters

const TUint16 & aVersion	Major policy version.
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetRecordId(const TUint32 &, const TComparisonOp)

IMPORT_C void	SetRecordId	(	const TUint32 &	aId,
			const TComparisonOp	aOp
		)

Sets the unique Id number of the decision record which is searched.

Parameters

const TUint32 & aId	A unique record Id.
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetResult(const TUint8 &, const TComparisonOp)

IMPORT_C void	SetResult	(	const TUint8 &	aResult,
			const TComparisonOp	aOp
		)

Sets the result field of the decision record which is searched.

Parameters

const TUint8 & aResult	Whether the request should be approved.
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetServerSid(const TSecureId &, const TComparisonOp)

IMPORT_C void	SetServerSid	(	const TSecureId &	aSid,
			const TComparisonOp	aOp
		)

Sets the Secure ID of the system server.

Parameters

const TSecureId & aSid
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

SetServiceId(const TUid &, const TComparisonOp)

IMPORT_C void	SetServiceId	(	const TUid &	aUid,
			const TComparisonOp	aOp
		)

Sets the Secure ID of the service.

Parameters

const TUid & aUid	UID for the service
const TComparisonOp aOp	Comparision operator which is used to create SQL statement.

ValidateL()

void

ValidateL

(

)

[private]

Check fingerprint and client entity lengths are valid.

Member Data Documentation

HBufC8 * iClientEntity

HBufC8 *

iClientEntity

[private]

Name of the entity within client NULL pointer if not specified.

TSecureId iClientSid

TSecureId

iClientSid

[private]

Secure Id for client application

HBufC * iDescription

HBufC *

iDescription

[private]

A copy of description and/or opaque

TUid iEvaluatorId

TUid

iEvaluatorId

[private]

UID for the policy evaluator DLL

TUint32 iEvaluatorInfo

TUint32

iEvaluatorInfo

[private]

Policy evaluator specific data

HBufC8 * iFingerprint

HBufC8 *

iFingerprint

[private]

Fingerprint. NULL pointer if not specified.

TUint16 iMajorPolicyVersion

TUint16

iMajorPolicyVersion

[private]

Major version of policy file.

TUint32 iRecordId

TUint32

iRecordId

[private]

Unique decision record Id.

TUint8 iResult

TUint8

iResult

[private]

Whether the request should be approved

TSecureId iServerSid

TSecureId

iServerSid

[private]

Secure Id for system server

TUid iServiceId

TUid

iServiceId

[private]

UID for service

TUint32 iSetFlag

TUint32

iSetFlag

[private]

An array of flags which shows which attributes are set and what operator(=,!=,<,>, etc.) is assigned. NULL pointer if not specified.