Class CMsvScheduledEntry

class CMsvScheduledEntry : public CBase;

Description

Abstract base class which stores the schedule data and recipients of a message.

CMsvScheduledEntry does not force the Server MTM to store the message recipients in a certain way. However, it is recommended that the Server MTM derive its recipients class from CMsvRecipient, because the class already has support for the number of retries to send a message to a recipient.

CMsvScheduledEntry stores the TMsvEntry to which it relates to provide quick access to the scheduling-related index data without needing calls to CMsvServerEntry::SetEntry(). However, CMsvScheduledEntry does not provide access to all the members of the TMsvEntry. This is to stop the user of the CMsvScheduledEntry from accessing the descriptor members of the TMsvEntry while the server entry is not set to the TMsvEntry.

Derivation

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

• CMsvScheduledEntry - Abstract base class which stores the schedule data and recipients of a message

Members

Defined in CMsvScheduledEntry:
CMsvScheduledEntry(), CanSendToAnyRecipients(), CanSendToAnyRecipients(), Entry(), Error(), Failed(), Id(), Mtm(), OffPeak(), PendingConditions(), RecipientsAllSent(), RecipientsIncreaseRetries(), RecipientsResetRetries(), RecipientsRestoreL(), RecipientsSetFailed(), RecipientsStoreL(), RestoreL(), ScheduleDate(), Scheduled(), SendingState(), SetFailed(), SetPendingConditions(), SetScheduleDate(), SetScheduled(), SetSendingState(), StoreL(), iData

Inherited from CBase:
Delete(), Extension_(), operator new()

protected: IMPORT_C CMsvScheduledEntry(const TMsvEntry &aEntry);

Description

Constructor.

Parameters

const TMsvEntry &aEntry Scheduled message.

virtual TBool CanSendToAnyRecipients(const CMsvSendErrorActions &aErrorActions, TMsvSendErrorAction &aAction)=0;

Description

Tests if any of the recipients of this message can still be sent to.

Parameters

const CMsvSendErrorActions &aErrorActions Error-actions TMsvSendErrorAction &aAction Default error-action

Return value

TBool True if at least one of the recipients has not been sent the message.

virtual TBool CanSendToAnyRecipients(const TMsvSendErrorAction &aAction)=0;

Description

Tests if any of the recipients of this message can still be sent to.

Parameters

const TMsvSendErrorAction &aAction Default error-action

Return value

TBool True if at least one of the recipients has not been sent the message.

virtual void RecipientsResetRetries()=0;

Description

Sets all the recipients' retries to zero.

virtual void RecipientsIncreaseRetries()=0;

Description

Increases all the recipients' retries by one.

virtual void RecipientsSetFailed()=0;

Description

Sets all the recipients' flags to sending failed.

virtual TBool RecipientsAllSent() const=0;

Description

Tests if all recipients of the message have been sent successfully.

Return value

TBool True if all recipients have been sent successfully.

virtual IMPORT_C void StoreL(CMsvStore &aStore) const;

Description

Stores the object.

Parameters

CMsvStore &aStore Store to write to.

Leave codes

TMsvEntryScheduleData::StoreL() RecipientsStoreL()

virtual IMPORT_C void RestoreL(CMsvStore &aStore);

Description

Restores the object.

Parameters

CMsvStore &aStore Store to read from.

Leave codes

TMsvEntryScheduleData::RestoreL() RecipientsRestoreL()

virtual void RecipientsStoreL(CMsvStore &aStore) const=0;

Description

Stores the recipients.

Parameters

CMsvStore &aStore Store to write to.

virtual void RecipientsRestoreL(CMsvStore &aStore)=0;

Description

Restores the recipients.

Parameters

CMsvStore &aStore Store to read from.

inline const TTime &ScheduleDate() const;

Description

Gets the entry's iDate member.

Return value

const TTime & Entry's iDate member.

inline void SetScheduleDate(const TTime &aDate);

Description

Sets the entry's iDate member.

Parameters

const TTime &aDate Entry's iDate member.

inline const TBool Scheduled() const;

Description

Gets the entry's Scheduled() flag.

Return value

const TBool The entry's Scheduled() flag.

inline void SetScheduled(const TBool aScheduled);

Description

Sets the entry's Scheduled() flag.

Parameters

const TBool aScheduled The entry's Scheduled() flag.

inline const TInt SendingState() const;

Description

Gets the entry's SendingState() flag.

Return value

const TInt The entry's SendingState() flag.

inline void SetSendingState(TInt aState);

Description

Sets the entry's SendingState() flag.

Parameters

TInt aState The entry's SendingState() flag.

inline const TInt Error() const;

Description

Gets the entry's iError data member.

Return value

const TInt The entry's iError data member.

inline const TMsvId Id() const;

Description

Gets the entry's ID.

Return value

const TMsvId The entry's ID.

inline const TBool OffPeak() const;

Description

Gets the entry's OffPeak() flag.

Return value

const TBool The entry's OffPeak() flag.

inline void SetFailed(const TBool aFail);

Description

Sets the entry's Failed() flag.

Parameters

const TBool aFail The entry's Failed() flag.

inline const TBool Failed() const;

Description

Gets the entry's Failed() flag.

Return value

const TBool The entry's Failed() flag.

IMPORT_C TBool PendingConditions() const;

Description

Gets the entry's pending conditions flag.

Return value

TBool The entry's pending conditions flag.

IMPORT_C void SetPendingConditions(TBool aPendingConditions);

Description

sets the entry's pending conditions flag.

Parameters

TBool aPendingConditions

inline const TUid Mtm() const;

Description

Gets the entry's iMtm data member.

Return value

const TUid The entry's iMtm data member.

IMPORT_C void Entry(TMsvEntry &aEntry) const;

Description

Gets the message entry.

Parameters

TMsvEntry &aEntry On return, the message entry.

TMsvEntryScheduleData iData;

Description

Message schedule data.