| 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.
| Public Member Functions | |
|---|---|
| TBool | CanSendToAnyRecipients(const CMsvSendErrorActions &, TMsvSendErrorAction &) |
| TBool | CanSendToAnyRecipients(const TMsvSendErrorAction &) |
| IMPORT_C void | Entry(TMsvEntry &) |
| const TInt | Error() |
| const TBool | Failed() |
| const TMsvId | Id() |
| const TUid | Mtm() |
| const TBool | OffPeak() |
| IMPORT_C TBool | PendingConditions() |
| TBool | RecipientsAllSent() |
| void | RecipientsIncreaseRetries() |
| void | RecipientsResetRetries() |
| void | RecipientsRestoreL(CMsvStore &) |
| void | RecipientsSetFailed() |
| void | RecipientsStoreL(CMsvStore &) |
| IMPORT_C void | RestoreL(CMsvStore &) |
| const TTime & | ScheduleDate() |
| const TBool | Scheduled() |
| const TInt | SendingState() |
| void | SetFailed(const TBool) |
| IMPORT_C void | SetPendingConditions(TBool) |
| void | SetScheduleDate(const TTime &) |
| void | SetScheduled(const TBool) |
| void | SetSendingState(TInt) |
| IMPORT_C void | StoreL(CMsvStore &) |
| Protected Member Functions | |
|---|---|
| CMsvScheduledEntry(const TMsvEntry &) | |
| Public Attributes | |
|---|---|
| TMsvEntryScheduleData | iData |
| Private Attributes | |
|---|---|
| TMsvEntry | iEntry |
| IMPORT_C | CMsvScheduledEntry | ( | const TMsvEntry & | aEntry | ) | [protected] |
| const TMsvEntry & aEntry |
| 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.
| const CMsvSendErrorActions & aErrorActions | Error-actions |
| TMsvSendErrorAction & aAction | Default error-action |
| 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.
| const TMsvSendErrorAction & aAction | Default error-action |
| const TInt | Error | ( | ) | const [inline] |
Gets the entry's iError data member.
The entry's iError data member.
| const TUid | Mtm | ( | ) | const [inline] |
Gets the entry's iMtm data member.
The entry's iMtm data member.
| TBool | RecipientsAllSent | ( | ) | const [pure virtual] |
Tests if all recipients of the message have been sent successfully.
True if all recipients have been sent successfully.
| void | RecipientsIncreaseRetries | ( | ) | [pure virtual] |
Increases all the recipients' retries by one.
| void | RecipientsResetRetries | ( | ) | [pure virtual] |
Sets all the recipients' retries to zero.
| void | RecipientsRestoreL | ( | CMsvStore & | aStore | ) | [pure virtual] |
Restores the recipients.
| CMsvStore & aStore | Store to read from. |
| void | RecipientsSetFailed | ( | ) | [pure virtual] |
Sets all the recipients' flags to sending failed.
| void | RecipientsStoreL | ( | CMsvStore & | aStore | ) | const [pure virtual] |
Stores the recipients.
| CMsvStore & aStore | Store to write to. |
| IMPORT_C void | RestoreL | ( | CMsvStore & | aStore | ) | [virtual] |
| CMsvStore & aStore |
| const TTime & | ScheduleDate | ( | ) | const [inline] |
Gets the entry's iDate member.
Entry's iDate member.
| const TBool | Scheduled | ( | ) | const [inline] |
Gets the entry's Scheduled() flag.
The entry's Scheduled() flag.
| const TInt | SendingState | ( | ) | const [inline] |
Gets the entry's SendingState() flag.
The entry's SendingState() flag.
| void | SetFailed | ( | const TBool | aFail | ) | [inline] |
Sets the entry's Failed() flag.
| const TBool aFail | The entry's Failed() flag. |
| IMPORT_C void | SetPendingConditions | ( | TBool | aPendingConditions | ) |
| TBool aPendingConditions |
| void | SetScheduleDate | ( | const TTime & | aDate | ) | [inline] |
Sets the entry's iDate member.
| const TTime & aDate | Entry's iDate member. |
| void | SetScheduled | ( | const TBool | aScheduled | ) | [inline] |
Sets the entry's Scheduled() flag.
| const TBool aScheduled | The entry's Scheduled() flag. |
| void | SetSendingState | ( | TInt | aState | ) | [inline] |
Sets the entry's SendingState() flag.
| TInt aState | The entry's SendingState() flag. |
| IMPORT_C void | StoreL | ( | CMsvStore & | aStore | ) | const [virtual] |
| CMsvStore & aStore |