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

Public Member Functions
~CHarvesterData()
IMPORT_C TBoolAddLocation()
IMPORT_C CBase *ClientData()
IMPORT_C TUidClientId()
IMPORT_C TIntErrorCode()
IMPORT_C THarvesterEventTypeEventType()
IMPORT_C CHarvesterPluginInfo *HarvesterPluginInfo()
IMPORT_C TBoolIsBinary()
IMPORT_C TLocationData *LocationData()
IMPORT_C CMdEObject &MdeObject()
IMPORT_C CHarvesterData *NewL(const HBufC *)
IMPORT_C CHarvesterData *NewLC(const HBufC *)
IMPORT_C THarvesterObjectTypeObjectType()
IMPORT_C TOriginOrigin()
IMPORT_C MHarvesterPluginObserver *PluginObserver()
IMPORT_C voidSetAddLocation(TBool)
IMPORT_C voidSetBinary(TBool)
IMPORT_C voidSetClientData(CBase *)
IMPORT_C voidSetClientId(TUid)
IMPORT_C voidSetErrorCode(TInt)
IMPORT_C voidSetEventType(THarvesterEventType)
IMPORT_C voidSetHarvesterPluginInfo(CHarvesterPluginInfo *)
IMPORT_C voidSetLocationData(TLocationData *)
IMPORT_C voidSetMdeObject(CMdEObject *)
IMPORT_C voidSetObjectType(THarvesterObjectType)
IMPORT_C voidSetOrigin(TOrigin)
IMPORT_C voidSetPluginObserver(MHarvesterPluginObserver &)
IMPORT_C voidSetTakeSnapshot(TBool)
IMPORT_C TBoolTakeSnapshot()
IMPORT_C const TDesC &Uri()
Private Member Functions
CHarvesterData(const HBufC *)
voidConstructL()
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 * aUriURI of the item ie. filename.

~CHarvesterData()

~CHarvesterData()

Destructor.

Member Functions Documentation

AddLocation()

IMPORT_C TBoolAddLocation()

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 TUidClientId()

Method returns the client application UID.

ConstructL()

voidConstructL()[private]

Default constructor for performing 2nd stage construction

ErrorCode()

IMPORT_C TIntErrorCode()

Method returns error code of harvesting.

EventType()

IMPORT_C THarvesterEventTypeEventType()

Method returns harvesting type.

HarvesterPluginInfo()

IMPORT_C CHarvesterPluginInfo *HarvesterPluginInfo()

Method returns harvester plug-in info structure.

IsBinary()

IMPORT_C TBoolIsBinary()

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 * aUriURI 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 * aUriURI of the file, usually filename. With messages can be messageID.

ObjectType()

IMPORT_C THarvesterObjectTypeObjectType()

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

Origin()

IMPORT_C TOriginOrigin()

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 voidSetAddLocation(TBoolaAdd)

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

Parameters

TBool aAddClient application UID.

SetBinary(TBool)

IMPORT_C voidSetBinary(TBoolaValue)

Method sets a flag determinning

Parameters

TBool aValue

SetClientData(CBase *)

IMPORT_C voidSetClientData(CBase *aClientData)

Method sets the custom harvesting data from client.

Parameters

CBase * aClientDataCustom harvesting data from client.

SetClientId(TUid)

IMPORT_C voidSetClientId(TUidaClientId)

Method sets the client application UID.

Parameters

TUid aClientIdClient application UID.

SetErrorCode(TInt)

IMPORT_C voidSetErrorCode(TIntaErrorCode)

Method sets the error code for harvesting.

Parameters

TInt aErrorCodeError code for harvesting

SetEventType(THarvesterEventType)

IMPORT_C voidSetEventType(THarvesterEventTypeaEventType)

Method sets harvesting type.

Parameters

THarvesterEventType aEventTypeHarvesting type

SetHarvesterPluginInfo(CHarvesterPluginInfo *)

IMPORT_C voidSetHarvesterPluginInfo(CHarvesterPluginInfo *aPluginInfo)

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

Parameters

CHarvesterPluginInfo * aPluginInfoPointer to harvester plug-in info structure.

SetLocationData(TLocationData *)

IMPORT_C voidSetLocationData(TLocationData *aLD)

Method sets location metadadata (GPS).

Parameters

TLocationData * aLDPointer to the location metadata structure.

SetMdeObject(CMdEObject *)

IMPORT_C voidSetMdeObject(CMdEObject *aMdeObject)

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

Parameters

CMdEObject * aMdeObjectPointer to the metadata object that will be used to store the metadata from the file/item.

SetObjectType(THarvesterObjectType)

IMPORT_C voidSetObjectType(THarvesterObjectTypeaObjectType)

Method sets (object) type of the harvesting procedure.

Parameters

THarvesterObjectType aObjectTypeType of the harvesting procedure.

SetOrigin(TOrigin)

IMPORT_C voidSetOrigin(TOriginaOrigin)

Method sets the origin information for the file/item.

Parameters

TOrigin aOriginOrigin of the file/item.

SetPluginObserver(MHarvesterPluginObserver &)

IMPORT_C voidSetPluginObserver(MHarvesterPluginObserver &aObserver)

Method sets observer for this harvesting request (Harvester server)

Parameters

MHarvesterPluginObserver & aObserverPointer to the harvesting observer in the harvesting FW

SetTakeSnapshot(TBool)

IMPORT_C voidSetTakeSnapshot(TBoolaTakeSnapshot)

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

Parameters

TBool aTakeSnapshotWhether Context snapshot is required or not.

TakeSnapshot()

IMPORT_C TBoolTakeSnapshot()

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]