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.
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. |
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()
Method returns the client application UID.
ConstructL()
void | ConstructL | ( | ) | [private] |
Default constructor for performing 2nd stage construction
ErrorCode()
Method returns error code of harvesting.
EventType()
Method returns harvesting type.
HarvesterPluginInfo()
Method returns harvester plug-in info structure.
IsBinary()
Method returns whether item in harvesting is a binary file.
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 *)
Parameters
const HBufC * aUri | URI of the file, usually filename. With messages can be messageID. |
NewLC(const HBufC *)
Parameters
const HBufC * aUri | URI of the file, usually filename. With messages can be messageID. |
ObjectType()
Method retursn the (object) type of the harvesting procedure.
Origin()
Method returns origin of the file/item.
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
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)
Method sets harvesting type.
SetHarvesterPluginInfo(CHarvesterPluginInfo *)
Method sets harvesting plug-in information which is needed to carry out the harvesting procedure
SetLocationData(TLocationData *)
Method sets location metadadata (GPS).
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)
Method sets (object) 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 &)
Method sets observer for this harvesting request (Harvester server)
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 | ( | ) | |
Member Data Documentation
TBool
iAddLocation
TBool
| iAddLocation | [private] |
CBase * iClientData
CBase * | iClientData | [private] |
THarvesterEventType
iEventType
TLocationData * iLocationData
CMdEObject * iMdeObject
CMdEObject * | iMdeObject | [private] |
THarvesterObjectType
iObjectType
MHarvesterPluginObserver * iObserver
CHarvesterPluginInfo * iPluginInfo
TBool
iTakeSnapshot
TBool
| iTakeSnapshot | [private] |
const HBufC * iUri
const HBufC * | iUri | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.