Class CSyncMLHistoryJob

class CSyncMLHistoryJob : public CSyncMLHistoryEntry;

Description

This class holds the result of a session with a server.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CSyncMLHistoryEntry - Base class for a history log entry.

• CSyncMLHistoryJob - This class holds the result of a session with a server.

Members

Defined in CSyncMLHistoryJob:

• DynamicCast(CSyncMLHistoryEntry *)
• DynamicCast(const CSyncMLHistoryEntry *)
• ExternalizeL(RWriteStream &)constThis method writes the details associated with this entry to the specified strea...
• FinishTime()constThis method returns the time that the Sync Job completed.
• InternalizeL(RReadStream &)
• NewL()This method creates a new Job History entry representing a Sync Job.
• NewL(TSmlProfileId,const RArray< TSmlTaskId > &)This method creates a new Job History entry representing a Sync Job.
• Profile()constThis method returns the ID of the Server Profile that this entry is associated w...
• ResultCode()constThis method returns the result of the Sync Job.
• SetResult(TTime,TInt)This method sets the finish time, and result code for the Sync Job entry.
• TTaskInfoThis class identifies a sync task within the profile, and the result of the atte...
• TaskAt(TInt)constThis method returns the task information at the specified index in the entry.
• TaskById(TSmlTaskId)This method returns a modifiable reference to the information for the specified ...
• TaskCount()constThis method returns the number of tasks that were synchronised by the Job this e...
• TimeStamp()constThis method returns the time stamp of this entry. i.e. when the Job started.
• ~CSyncMLHistoryJob()Destructor for CSyncMLHistoryJob

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CSyncMLHistoryEntry:

• ESortByTimeOrdered by Time Stamp.
• ESortByTypeOrdered by Entry Type.
• EntryId()constThis method returns the unique ID of the entry. This identifier is unique within...
• EntryType()constThis method may be used to determine the type of the entry.
• NewL(RReadStream &)This method creates a new history log entry from a stream, internalizing all dat...
• NewL(TUid)This method creates a new history log entry of the specified type.
• NewL(const CSyncMLHistoryEntry &)This method creates a new copy of an existing History Log entry.
• TSortOrderAn ordering of History Entries.

IMPORT_C static CSyncMLHistoryJob* NewL();

Description

This method creates a new Job History entry representing a Sync Job.

Return value

CSyncMLHistoryJob * New Job History entry

Leave codes

KErrNoMemory Insufficient free system RAM.

IMPORT_C static CSyncMLHistoryJob* NewL(TSmlProfileId, const RArray< TSmlTaskId > &);

Description

This method creates a new Job History entry representing a Sync Job.

Parameters

TSmlProfileId The ID of the Profile the Job is associated with const RArray< TSmlTaskId > & The set of Tasks the Job is synchronising.

Return value

CSyncMLHistoryJob * New Job History entry

Leave codes

KErrNoMemory Insufficient free system RAM.

IMPORT_C virtual ~CSyncMLHistoryJob();

Description

Destructor for CSyncMLHistoryJob

static inline CSyncMLHistoryJob* DynamicCast(CSyncMLHistoryEntry *);

Description

Parameters

CSyncMLHistoryEntry *

Return value

CSyncMLHistoryJob *

static inline const CSyncMLHistoryJob* DynamicCast(const CSyncMLHistoryEntry *);

Description

Parameters

const CSyncMLHistoryEntry *

Return value

const CSyncMLHistoryJob *

IMPORT_C virtual void ExternalizeL(RWriteStream &) const;

Description

This method writes the details associated with this entry to the specified stream.

Parameters

RWriteStream & The stream to write the entry to.

IMPORT_C virtual TSmlProfileId Profile() const;

Description

This method returns the ID of the Server Profile that this entry is associated with. Returns KSmlNullId if this entry is not associated with any Profile.

Return value

TSmlProfileId The ID of the Server Profile that this entry is associated with.

IMPORT_C virtual TTime TimeStamp() const;

Description

This method returns the time stamp of this entry. i.e. when the Job started.

Return value

TTime The time stamp in Universal Time.

IMPORT_C virtual TInt ResultCode() const;

Description

This method returns the result of the Sync Job.

Return value

TInt The error code that the job completed with.

IMPORT_C TTime FinishTime() const;

Description

This method returns the time that the Sync Job completed.

Return value

TTime The finish time in Universal Time.

IMPORT_C TInt TaskCount() const;

Description

This method returns the number of tasks that were synchronised by the Job this entry represents.

Return value

TInt The number of tasks.

IMPORT_C const TTaskInfo& TaskAt(TInt) const;

Description

This method returns the task information at the specified index in the entry.

Parameters

TInt The index of the task to fetch.

Return value

const CSyncMLHistoryJob::TTaskInfo & The task information at the specified index.

IMPORT_C TTaskInfo& TaskById(TSmlTaskId);

Description

This method returns a modifiable reference to the information for the specified task.

Parameters

TSmlTaskId Identifies the task.

Return value

CSyncMLHistoryJob::TTaskInfo & The information for the specified task.

Panic codes

SmlHistory::Shared ESmlPanicHistoryShared_BadTaskId The specified task is not a part of this entry.

IMPORT_C void SetResult(TTime aFinishTime, TInt aResultCode);

Description

This method sets the finish time, and result code for the Sync Job entry.

Parameters

TTime aFinishTime The time the Job completed. TInt aResultCode The result of the Job.

private: virtual void InternalizeL(RReadStream &);

Description

Parameters

RReadStream &

class TTaskInfo;

Description

This class identifies a sync task within the profile, and the result of the attempt to synchronise it.

Members

Defined in CSyncMLHistoryJob::TTaskInfo:

• ExternalizeL(RWriteStream &)constThis method writes a CSyncMLHistoryJob::TTaskInfo object to a stream.
• InternalizeL(RReadStream &)This method reads a CSyncMLHistoryJob::TTaskInfo object from a stream.
• TTaskInfo()Default constructor for CSyncMLHistoryJob::TTaskInfo.
• iErrorIndicates the synchronisation result
• iItemsAddedIndicates the number of items added to the db
• iItemsChangedIndicates the number of items modified in the db
• iItemsDeletedIndicates the number of items deleted from the db
• iItemsFailedIndicates the number of items that failed synchronisation
• iItemsMovedIndicates the number of items moved in the db
• iServerItemsAddedIndicates the number of items added on the server
• iServerItemsChangedIndicates the number of items changed on the server
• iServerItemsDeletedIndicates the number of items deleted on the server
• iServerItemsFailedIndicates the number of items failed synchronisation on the server
• iServerItemsMovedIndicates the number of items moved on the server
• iSyncTypeIndicates the Synchronisation type used for the task.
• iTaskIdIdentifies the profile sync task

Construction and destruction

---

TTaskInfo()

IMPORT_C TTaskInfo();

Description

Default constructor for CSyncMLHistoryJob::TTaskInfo.

Member functions

---

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL(RReadStream &);

Description

This method reads a CSyncMLHistoryJob::TTaskInfo object from a stream.

Parameters

RReadStream & A stream containing a valid CSyncMLHistoryJob::TTaskInfo object.

---

ExternalizeL(RWriteStream &)const

IMPORT_C void ExternalizeL(RWriteStream &) const;

Description

This method writes a CSyncMLHistoryJob::TTaskInfo object to a stream.

Parameters

RWriteStream & A stream to write the object to.

Member data

---

iTaskId

TSmlTaskId iTaskId;

Description

Identifies the profile sync task

---

iError

TInt iError;

Description

Indicates the synchronisation result

---

iItemsAdded

TInt iItemsAdded;

Description

Indicates the number of items added to the db

---

iItemsChanged

TInt iItemsChanged;

Description

Indicates the number of items modified in the db

---

iItemsDeleted

TInt iItemsDeleted;

Description

Indicates the number of items deleted from the db

---

iItemsMoved

TInt iItemsMoved;

Description

Indicates the number of items moved in the db

---

iItemsFailed

TInt iItemsFailed;

Description

Indicates the number of items that failed synchronisation

---

iServerItemsAdded

TInt iServerItemsAdded;

Description

Indicates the number of items added on the server

---

iServerItemsDeleted

TInt iServerItemsDeleted;

Description

Indicates the number of items deleted on the server

---

iServerItemsMoved

TInt iServerItemsMoved;

Description

Indicates the number of items moved on the server

---

iServerItemsChanged

TInt iServerItemsChanged;

Description

Indicates the number of items changed on the server

---

iServerItemsFailed

TInt iServerItemsFailed;

Description

Indicates the number of items failed synchronisation on the server

---

iSyncType

TSmlSyncType iSyncType;

Description

Indicates the Synchronisation type used for the task.