CAiwCriteriaItem Class Reference

#include <mw/AiwCommon.h>

Link against: ServiceHandler.lib

class CAiwCriteriaItem : public CBase

Inherits from

CAiwCriteriaItem

Public Member Functions
virtual	~CAiwCriteriaItem()
IMPORT_C const TDesC8 &	ContentType()
IMPORT_C TUid	DefaultProvider()
IMPORT_C TInt	Id()
IMPORT_C TInt	MaxProviders()
IMPORT_C CAiwCriteriaItem *	NewL()
IMPORT_C CAiwCriteriaItem *	NewL(TInt, TInt, const TDesC8 &)
IMPORT_C CAiwCriteriaItem *	NewLC()
IMPORT_C CAiwCriteriaItem *	NewLC(TInt, TInt, const TDesC8 &)
IMPORT_C TUint	Options()
IMPORT_C void	ReadFromResoureL(TResourceReader &)
TBool	RomOnly()
IMPORT_C const TUid &	ServiceClass()
IMPORT_C TInt	ServiceCmd()
IMPORT_C void	SetContentTypeL(const TDesC8 &)
IMPORT_C void	SetDefaultProvider(TInt)
IMPORT_C void	SetId(TInt)
IMPORT_C void	SetMaxProviders(TInt)
IMPORT_C void	SetOptions(TUint)
IMPORT_C void	SetServiceClass(const TUid &)
IMPORT_C void	SetServiceCmd(TInt)
IMPORT_C TBool	operator==(const CAiwCriteriaItem &)

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

Criteria item data. This class encapsulates an AIW criteria item. Criteria items are building blocks for AIW interests, i.e. an interest is a list of criteria items. A criteria item can be defined dynamically (by using this class) or in a resource file.

Since: Series 60 2.6

Constructor & Destructor Documentation

~CAiwCriteriaItem ( )

IMPORT_C

~CAiwCriteriaItem

(

)

[virtual]

Destructor.

Member Function Documentation

ContentType ( )

IMPORT_C const TDesC8 &

ContentType

(

)

const

Gets the content type.

Returns: The content type.

DefaultProvider ( )

IMPORT_C TUid

DefaultProvider

(

)

const

Returns the default provider.

Returns: The default provider UID.

Id ( )

IMPORT_C TInt

(

)

const

Gets the criteria ID, 0 if not defined.

Returns: The criteria ID.

MaxProviders ( )

IMPORT_C TInt

MaxProviders

(

)

const

Maximum number of providers allowed for this criteria item.

Returns: Maximum number of providers allowed for this criteria item.

NewL ( )

IMPORT_C CAiwCriteriaItem *

NewL

(

)

[static]

Constructs a criteria item instance with null items.

Returns: A pointer to the new object.

NewL ( TInt, TInt, const TDesC8 & )

IMPORT_C CAiwCriteriaItem *	NewL	(	TInt	aCriteriaId,
			TInt	aServiceCmd,
			const TDesC8 &	aContentType
		)	[static]

Constructs a criteria item instance.

Parameter	Description
aCriteriaId	The criteria ID.
aServiceCmd	The service command.
aContentType	The content type.

Returns: A pointer to the new object.

NewLC ( )

IMPORT_C CAiwCriteriaItem *

NewLC

(

)

[static]

Constructs a criteria item instance with null items. Leaves the pointer to the cleanup stack.

Returns: A pointer to the new object.

NewLC ( TInt, TInt, const TDesC8 & )

IMPORT_C CAiwCriteriaItem *	NewLC	(	TInt	aCriteriaId,
			TInt	aServiceCmd,
			const TDesC8 &	aContentType
		)	[static]

Constructs a criteria item instance. Leaves the pointer to the cleanup stack.

Parameter	Description
aCriteriaId	The criteria ID.
aServiceCmd	The service command.
aContentType	The content type.

Returns: A pointer to the new object.

Options ( )

IMPORT_C TUint

Options

(

)

const

Gets the options.

Returns: Options.

ReadFromResoureL ( TResourceReader & )

IMPORT_C void

ReadFromResoureL

(

TResourceReader &

aReader

)

Reads a criteria item from a resource.

Parameter	Description
aReader	A resource reader pointing to a criteria item.

RomOnly ( )

TBool

RomOnly

(

)

const [inline]

If set, only ROM based providers can be attached to this criteria.

Returns: ETrue if AIW_OPTIONS_ROM_ONLY bit is set, EFalse otherwise.

ServiceClass ( )

IMPORT_C const TUid &

ServiceClass

(

)

const

Gets the service class UID.

Returns: The service class UID, see TAiwServiceClass.

ServiceCmd ( )

IMPORT_C TInt

ServiceCmd

(

)

const

Gets the service command UID. KNullUid, if not defined.

Returns: The service command UID, see TAiwServiceCommands.

SetContentTypeL ( const TDesC8 & )

IMPORT_C void

SetContentTypeL

(

const TDesC8 &

aContentType

)

Sets the content type. Makes a copy of the string data.

Parameter	Description
aContentType	Content MIME type, event type or any agreed one.

SetDefaultProvider ( TInt )

IMPORT_C void

SetDefaultProvider

(

TInt

aDefault

)

Sets the default provider.

Parameter	Description
aDefault	The UID of a default provider.

SetId ( TInt )

IMPORT_C void

SetId

(

TInt

aId

)

Sets the criteria ID.

Parameter	Description
aId	The criteria ID.

SetMaxProviders ( TInt )

IMPORT_C void

SetMaxProviders

(

TInt

aMaxProviders

)

Sets the maximum number of providers.

Parameter	Description
aMaxProviders	The maximum number of providers.

SetOptions ( TUint )

IMPORT_C void

SetOptions

(

TUint

aOptions

)

Sets the options.

Parameter	Description
aOptions	Options.

SetServiceClass ( const TUid & )

IMPORT_C void

SetServiceClass

(

const TUid &

aServiceUid

)

Sets the service class.

Parameter	Description
aServiceUid	The service class, see TAiwServiceClass.

SetServiceCmd ( TInt )

IMPORT_C void

SetServiceCmd

(

TInt

aServiceCmd

)

Sets the service command UID.

Parameter	Description
aServiceCmd	The AIW service command, see TAiwServiceCommands.

operator== ( const CAiwCriteriaItem & )

IMPORT_C TBool

operator==

(

const CAiwCriteriaItem &

aItem

)

Equality operator. Two criteria items are considered equal only if all parameters match. The parameters are: criteria id, service command, content type, service class, default provider, max providers and options).

Parameter	Description
aItem	Criteria item to compare.

Returns: ETrue if criteria items are equal, EFalse otherwise.