UserPromptService::CDecisionFilter Class Reference

#include <ups/upstypes.h>

Link against: upsmanagement.lib

class UserPromptService::CDecisionFilter : public CBase

Inherits from

UserPromptService::CDecisionFilter

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)

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

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.

Constructor & Destructor Documentation

~CDecisionFilter ( )

~CDecisionFilter

(

)

Destructor for the decision filter

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalise this CDecisionFilter object to the specified stream.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalise this CDecisionFilter object from the specified stream.

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.

Returns: A pointer to the newly allocated filter object, if creation is successful.

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.

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

Returns: A pointer to the newly allocated filter object, if creation is successful.

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.

Returns: A pointer to the newly allocated filter object, if creation is successful. The pointer is also put onto the cleanup stack.

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.

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

Returns: A pointer to the newly allocated filter object, if creation is successful. The pointer is also put onto the cleanup stack.

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.

Parameter	Description
aClientEntity	The name of the entity within the client. (Maximum length is 32 bytes)
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.

Parameter	Description
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.

Parameter	Description
aDescription	A copy of description and/or opaque. (Maximum length is 32 bytes)
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.

Parameter	Description
aUid	UID for the policy evaluator DLL
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.

Parameter	Description
aEvaluatorInfo	Policy evaluator specific data
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.

Parameter	Description
aFingerprint	Hash of the destination and/or opaque data. (Maximum length is 32 bytes)
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.

Parameter	Description
aVersion	Major policy version.
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.

Parameter	Description
aId	A unique record Id.
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.

Parameter	Description
aResult	Whether the request should be approved.
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.

Parameter	Description
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.

Parameter	Description
aUid	UID for the service
aOp	Comparision operator which is used to create SQL statement.