Collapse all Symbian^3 Product Developer Library

CHarvesterData Class Reference

class CHarvesterData : public CBase

Class that encapsulates harvesting related data/harvesting request data. These instances are moved around the MdS Harvesting framework and this class encapsulates all information needed when harvesting a file/item.

Inherits from

CHarvesterData
- CBase

Public Member Functions
	~CHarvesterData()
IMPORT_C TBool	AddLocation()
IMPORT_C CBase *	ClientData()
IMPORT_C TUid	ClientId()
IMPORT_C TInt	ErrorCode()
IMPORT_C THarvesterEventType	EventType()
IMPORT_C CHarvesterPluginInfo *	HarvesterPluginInfo()
IMPORT_C TBool	IsBinary()
IMPORT_C TLocationData *	LocationData()
IMPORT_C CMdEObject &	MdeObject()
IMPORT_C CHarvesterData *	NewL(const HBufC *)
IMPORT_C CHarvesterData *	NewLC(const HBufC *)
IMPORT_C THarvesterObjectType	ObjectType()
IMPORT_C TOrigin	Origin()
IMPORT_C MHarvesterPluginObserver *	PluginObserver()
IMPORT_C void	SetAddLocation(TBool)
IMPORT_C void	SetBinary(TBool)
IMPORT_C void	SetClientData(CBase *)
IMPORT_C void	SetClientId(TUid)
IMPORT_C void	SetErrorCode(TInt)
IMPORT_C void	SetEventType(THarvesterEventType)
IMPORT_C void	SetHarvesterPluginInfo(CHarvesterPluginInfo *)
IMPORT_C void	SetLocationData(TLocationData *)
IMPORT_C void	SetMdeObject(CMdEObject *)
IMPORT_C void	SetObjectType(THarvesterObjectType)
IMPORT_C void	SetOrigin(TOrigin)
IMPORT_C void	SetPluginObserver(MHarvesterPluginObserver &)
IMPORT_C void	SetTakeSnapshot(TBool)
IMPORT_C TBool	TakeSnapshot()
IMPORT_C const TDesC &	Uri()

Private Member Functions
	CHarvesterData(const HBufC *)
void	ConstructL()

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
TBool	iAddLocation
CBase *	iClientData
TUid	iClientId
TInt	iErrorCode
THarvesterEventType	iEventType
TBool	iIsBinary
TLocationData *	iLocationData
CMdEObject *	iMdeObject
THarvesterObjectType	iObjectType
MHarvesterPluginObserver *	iObserver
TOrigin	iOrigin
CHarvesterPluginInfo *	iPluginInfo
TBool	iTakeSnapshot
const HBufC *	iUri

Constructor & Destructor Documentation

CHarvesterData(const HBufC *)

CHarvesterData

(

const HBufC *

aUri

)

[private]

Constructor for performing 1st stage construction

Parameters

const HBufC * aUri

URI of the item ie. filename.

~CHarvesterData()

~CHarvesterData

(

)

Destructor.

Member Functions Documentation

AddLocation()

IMPORT_C TBool

AddLocation

(

)

Method returns whether location data should be added to MdE DB or not.

ClientData()

IMPORT_C CBase *

ClientData

(

)

Method returns the custom harvesting data (received from client)

ClientId()

IMPORT_C TUid

ClientId

(

)

Method returns the client application UID.

ConstructL()

void

ConstructL

(

)

[private]

Default constructor for performing 2nd stage construction

ErrorCode()

IMPORT_C TInt

ErrorCode

(

)

Method returns error code of harvesting.

EventType()

IMPORT_C THarvesterEventType

EventType

(

)

Method returns harvesting type.

HarvesterPluginInfo()

IMPORT_C CHarvesterPluginInfo *

HarvesterPluginInfo

(

)

Method returns harvester plug-in info structure.

IsBinary()

IMPORT_C TBool

IsBinary

(

)

Method returns whether item in harvesting is a binary file.

LocationData()

IMPORT_C TLocationData *

LocationData

(

)

Method returns the location metadata structure.

MdeObject()

IMPORT_C CMdEObject &

MdeObject

(

)

Method returns the metadata objects which is used to store the metadata from the file/item that is harvested.

NewL(const HBufC *)

IMPORT_C CHarvesterData *

NewL

(

const HBufC *

aUri

)

[static]

Two-phased constructor.

Parameters

const HBufC * aUri

URI of the file, usually filename. With messages can be messageID.

NewLC(const HBufC *)

IMPORT_C CHarvesterData *

NewLC

(

const HBufC *

aUri

)

[static]

Two-phased constructor.

Parameters

const HBufC * aUri

URI of the file, usually filename. With messages can be messageID.

ObjectType()

IMPORT_C THarvesterObjectType

ObjectType

(

)

Method retursn the (object) type of the harvesting procedure.

Origin()

IMPORT_C TOrigin

Origin

(

)

Method returns origin of the file/item.

PluginObserver()

IMPORT_C MHarvesterPluginObserver *

PluginObserver

(

)

Method returns pointer to the harvesting observer (Harvester server).

SetAddLocation(TBool)

IMPORT_C void

SetAddLocation

(

TBool

aAdd

)

Method sets a flag which defines whether location data should be added to MdE DB or not.

Parameters

TBool aAdd

Client application UID.

SetBinary(TBool)

IMPORT_C void

SetBinary

(

TBool

aValue

)

Method sets a flag determinning

Parameters

TBool aValue

SetClientData(CBase *)

IMPORT_C void

SetClientData

(

CBase *

aClientData

)

Method sets the custom harvesting data from client.

Parameters

CBase * aClientData

Custom harvesting data from client.

SetClientId(TUid)

IMPORT_C void

SetClientId

(

TUid

aClientId

)

Method sets the client application UID.

Parameters

TUid aClientId

Client application UID.

SetErrorCode(TInt)

IMPORT_C void

SetErrorCode

(

TInt

aErrorCode

)

Method sets the error code for harvesting.

Parameters

TInt aErrorCode

Error code for harvesting

SetEventType(THarvesterEventType)

IMPORT_C void

SetEventType

(

THarvesterEventType

aEventType

)

Method sets harvesting type.

Parameters

THarvesterEventType aEventType

Harvesting type

SetHarvesterPluginInfo(CHarvesterPluginInfo *)

IMPORT_C void

SetHarvesterPluginInfo

(

CHarvesterPluginInfo *

aPluginInfo

)

Method sets harvesting plug-in information which is needed to carry out the harvesting procedure

Parameters

CHarvesterPluginInfo * aPluginInfo

Pointer to harvester plug-in info structure.

SetLocationData(TLocationData *)

IMPORT_C void

SetLocationData

(

TLocationData *

aLD

)

Method sets location metadadata (GPS).

Parameters

TLocationData * aLD

Pointer to the location metadata structure.

SetMdeObject(CMdEObject *)

IMPORT_C void

SetMdeObject

(

CMdEObject *

aMdeObject

)

Method sets metadata object which will be used to store the metadata in the harvesting plug-in.

Parameters

CMdEObject * aMdeObject

Pointer to the metadata object that will be used to store the metadata from the file/item.

SetObjectType(THarvesterObjectType)

IMPORT_C void

SetObjectType

(

THarvesterObjectType

aObjectType

)

Method sets (object) type of the harvesting procedure.

Parameters

THarvesterObjectType aObjectType

Type of the harvesting procedure.

SetOrigin(TOrigin)

IMPORT_C void

SetOrigin

(

TOrigin

aOrigin

)

Method sets the origin information for the file/item.

Parameters

TOrigin aOrigin

Origin of the file/item.

SetPluginObserver(MHarvesterPluginObserver &)

IMPORT_C void

SetPluginObserver

(

MHarvesterPluginObserver &

aObserver

)

Method sets observer for this harvesting request (Harvester server)

Parameters

MHarvesterPluginObserver & aObserver

Pointer to the harvesting observer in the harvesting FW

SetTakeSnapshot(TBool)

IMPORT_C void

SetTakeSnapshot

(

TBool

aTakeSnapshot

)

Method sets flag whether Context snapshot (with Context Engine) is required during harvesting.

Parameters

TBool aTakeSnapshot

Whether Context snapshot is required or not.

TakeSnapshot()

IMPORT_C TBool

TakeSnapshot

(

)

Method returns whether Context snapshot is required or not.

Uri()

IMPORT_C const TDesC &

Uri

(

)

Method returns the URI.

Member Data Documentation

TBool iAddLocation

TBool

iAddLocation

[private]

CBase * iClientData

CBase *

iClientData

[private]

TUid iClientId

TUid

iClientId

[private]

TInt iErrorCode

TInt

iErrorCode

[private]

THarvesterEventType iEventType

THarvesterEventType

iEventType

[private]

TBool iIsBinary

TBool

iIsBinary

[private]

TLocationData * iLocationData

TLocationData *

iLocationData

[private]

CMdEObject * iMdeObject

CMdEObject *

iMdeObject

[private]

THarvesterObjectType iObjectType

THarvesterObjectType

iObjectType

[private]

MHarvesterPluginObserver * iObserver

MHarvesterPluginObserver *

iObserver

[private]

TOrigin iOrigin

TOrigin

iOrigin

[private]

CHarvesterPluginInfo * iPluginInfo

CHarvesterPluginInfo *

iPluginInfo

[private]

TBool iTakeSnapshot

TBool

iTakeSnapshot

[private]

const HBufC * iUri

const HBufC *

iUri

[private]