CMsvScheduledEntry Class Reference

class CMsvScheduledEntry : public CBase

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.

Inherits from

Constructor & Destructor Documentation

CMsvScheduledEntry(const TMsvEntry &)

IMPORT_CCMsvScheduledEntry(const TMsvEntry &aEntry)[protected]

Parameters

const TMsvEntry & aEntry

Member Functions Documentation

CanSendToAnyRecipients(const CMsvSendErrorActions &, TMsvSendErrorAction &)

TBool CanSendToAnyRecipients(const CMsvSendErrorActions &aErrorActions,
TMsvSendErrorAction &aAction
)[pure virtual]

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

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

Parameters

const CMsvSendErrorActions & aErrorActionsError-actions
TMsvSendErrorAction & aActionDefault error-action

CanSendToAnyRecipients(const TMsvSendErrorAction &)

TBool CanSendToAnyRecipients(const TMsvSendErrorAction &aAction)[pure virtual]

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

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

Parameters

const TMsvSendErrorAction & aActionDefault error-action

Entry(TMsvEntry &)

IMPORT_C voidEntry(TMsvEntry &aEntry)const

Parameters

TMsvEntry & aEntry

Error()

const TIntError()const [inline]

Gets the entry's iError data member.

The entry's iError data member.

Failed()

const TBoolFailed()const [inline]

Gets the entry's Failed() flag.

The entry's Failed() flag.

Id()

const TMsvIdId()const [inline]

Gets the entry's ID.

The entry's ID.

Mtm()

const TUidMtm()const [inline]

Gets the entry's iMtm data member.

The entry's iMtm data member.

OffPeak()

const TBoolOffPeak()const [inline]

Gets the entry's OffPeak() flag.

The entry's OffPeak() flag.

PendingConditions()

IMPORT_C TBoolPendingConditions()const

RecipientsAllSent()

TBool RecipientsAllSent()const [pure virtual]

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

True if all recipients have been sent successfully.

RecipientsIncreaseRetries()

voidRecipientsIncreaseRetries()[pure virtual]

Increases all the recipients' retries by one.

RecipientsResetRetries()

voidRecipientsResetRetries()[pure virtual]

Sets all the recipients' retries to zero.

RecipientsRestoreL(CMsvStore &)

voidRecipientsRestoreL(CMsvStore &aStore)[pure virtual]

Restores the recipients.

Parameters

CMsvStore & aStoreStore to read from.

RecipientsSetFailed()

voidRecipientsSetFailed()[pure virtual]

Sets all the recipients' flags to sending failed.

RecipientsStoreL(CMsvStore &)

voidRecipientsStoreL(CMsvStore &aStore)const [pure virtual]

Stores the recipients.

Parameters

CMsvStore & aStoreStore to write to.

RestoreL(CMsvStore &)

IMPORT_C voidRestoreL(CMsvStore &aStore)[virtual]

Parameters

CMsvStore & aStore

ScheduleDate()

const TTime &ScheduleDate()const [inline]

Gets the entry's iDate member.

Entry's iDate member.

Scheduled()

const TBoolScheduled()const [inline]

Gets the entry's Scheduled() flag.

The entry's Scheduled() flag.

SendingState()

const TIntSendingState()const [inline]

Gets the entry's SendingState() flag.

The entry's SendingState() flag.

SetFailed(const TBool)

voidSetFailed(const TBoolaFail)[inline]

Sets the entry's Failed() flag.

Parameters

const TBool aFailThe entry's Failed() flag.

SetPendingConditions(TBool)

IMPORT_C voidSetPendingConditions(TBoolaPendingConditions)

Parameters

TBool aPendingConditions

SetScheduleDate(const TTime &)

voidSetScheduleDate(const TTime &aDate)[inline]

Sets the entry's iDate member.

Parameters

const TTime & aDateEntry's iDate member.

SetScheduled(const TBool)

voidSetScheduled(const TBoolaScheduled)[inline]

Sets the entry's Scheduled() flag.

Parameters

const TBool aScheduledThe entry's Scheduled() flag.

SetSendingState(TInt)

voidSetSendingState(TIntaState)[inline]

Sets the entry's SendingState() flag.

Parameters

TInt aStateThe entry's SendingState() flag.

StoreL(CMsvStore &)

IMPORT_C voidStoreL(CMsvStore &aStore)const [virtual]

Parameters

CMsvStore & aStore

Member Data Documentation

TMsvEntryScheduleData iData

TMsvEntryScheduleData iData

Message schedule data.

TMsvEntry iEntry

TMsvEntry iEntry[private]