CMsvScheduledEntry Class Reference

#include <mw/msvscheduledentry.h>

Link against: schsend.lib

class CMsvScheduledEntry : public CBase

Inherits from

Detailed 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.

Member Attribute Documentation

iData

Message schedule data.

Constructor & Destructor Documentation

CMsvScheduledEntry ( const TMsvEntry & )

IMPORT_CCMsvScheduledEntry(const TMsvEntry &aEntry)[protected]

Constructor.

Parameters
aEntryScheduled message.

Member Function 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.

Parameters
aErrorActionsError-actions
aActionDefault error-action
Return Value
True if at least one of the recipients has not been sent the message.

CanSendToAnyRecipients ( const TMsvSendErrorAction & )

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

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

Parameters
aActionDefault error-action
Return Value
True if at least one of the recipients has not been sent the message.

Entry ( TMsvEntry & )

IMPORT_C voidEntry(TMsvEntry &aEntry)const

Gets the message entry.

Parameters
aEntryOn return, the message entry.

Error ( )

const TIntError()const [inline]

Failed ( )

const TBoolFailed()const [inline]

Id ( )

const TMsvIdId()const [inline]

Mtm ( )

const TUidMtm()const [inline]

OffPeak ( )

const TBoolOffPeak()const [inline]

PendingConditions ( )

IMPORT_C TBoolPendingConditions()const

Gets the entry's pending conditions flag.

Return Value
The entry's pending conditions flag.

RecipientsAllSent ( )

TBool RecipientsAllSent()const [pure virtual]

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

Return Value
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
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
aStoreStore to write to.

RestoreL ( CMsvStore & )

IMPORT_C voidRestoreL(CMsvStore &aStore)[virtual]

Restores the object.

Parameters
aStoreStore to read from.
Leave Codes

ScheduleDate ( )

const TTime &ScheduleDate()const [inline]

Scheduled ( )

const TBoolScheduled()const [inline]

SendingState ( )

const TIntSendingState()const [inline]

SetFailed ( const TBool )

voidSetFailed(const TBoolaFail)[inline]

SetPendingConditions ( TBool )

IMPORT_C voidSetPendingConditions(TBoolaPendingConditions)

sets the entry's pending conditions flag.

SetScheduleDate ( const TTime & )

voidSetScheduleDate(const TTime &aDate)[inline]

SetScheduled ( const TBool )

voidSetScheduled(const TBoolaScheduled)[inline]

SetSendingState ( TInt )

voidSetSendingState(TIntaState)[inline]

StoreL ( CMsvStore & )

IMPORT_C voidStoreL(CMsvStore &aStore)const [virtual]

Stores the object.

Parameters
aStoreStore to write to.
Leave Codes