CMsvScheduledEntry Class Reference

#include <mw/msvscheduledentry.h>

Link against: schsend.lib

class CMsvScheduledEntry : public CBase

Inherits from

  • CMsvScheduledEntry
    Public Attributes
    TMsvEntryScheduleData iData
    Public Member Functions
    pure virtual TBool CanSendToAnyRecipients(const CMsvSendErrorActions &, TMsvSendErrorAction &)
    pure virtual TBool CanSendToAnyRecipients(const TMsvSendErrorAction &)
    IMPORT_C voidEntry(TMsvEntry &)
    const TIntError()
    const TBoolFailed()
    const TMsvIdId()
    const TUidMtm()
    const TBoolOffPeak()
    IMPORT_C TBoolPendingConditions()
    pure virtual TBool RecipientsAllSent()
    pure virtual voidRecipientsIncreaseRetries()
    pure virtual voidRecipientsResetRetries()
    pure virtual voidRecipientsRestoreL(CMsvStore &)
    pure virtual voidRecipientsSetFailed()
    pure virtual voidRecipientsStoreL(CMsvStore &)
    virtual IMPORT_C voidRestoreL(CMsvStore &)
    const TTime &ScheduleDate()
    const TBoolScheduled()
    const TIntSendingState()
    voidSetFailed(const TBool)
    IMPORT_C voidSetPendingConditions(TBool)
    voidSetScheduleDate(const TTime &)
    voidSetScheduled(const TBool)
    voidSetSendingState(TInt)
    virtual IMPORT_C voidStoreL(CMsvStore &)
    Protected Member Functions
    CMsvScheduledEntry(const TMsvEntry &)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    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

    TMsvEntryScheduleData iData

    Message schedule data.

    Constructor & Destructor Documentation

    CMsvScheduledEntry ( const TMsvEntry & )

    IMPORT_CCMsvScheduledEntry(const TMsvEntry &aEntry)[protected]

    Constructor.

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

    ParameterDescription
    aErrorActionsError-actions
    aActionDefault error-action

    Returns: 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.

    ParameterDescription
    aActionDefault error-action

    Returns: 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.

    ParameterDescription
    aEntryOn return, the message entry.

    Error ( )

    const TIntError()const [inline]

    Gets the entry's iError data member.

    Returns: The entry's iError data member.

    Failed ( )

    const TBoolFailed()const [inline]

    Gets the entry's Failed() flag.

    Returns: The entry's Failed() flag.

    Id ( )

    const TMsvIdId()const [inline]

    Gets the entry's ID.

    Returns: The entry's ID.

    Mtm ( )

    const TUidMtm()const [inline]

    Gets the entry's iMtm data member.

    Returns: The entry's iMtm data member.

    OffPeak ( )

    const TBoolOffPeak()const [inline]

    Gets the entry's OffPeak() flag.

    Returns: The entry's OffPeak() flag.

    PendingConditions ( )

    IMPORT_C TBoolPendingConditions()const

    Gets the entry's pending conditions flag.

    Returns: The entry's pending conditions flag.

    RecipientsAllSent ( )

    TBool RecipientsAllSent()const [pure virtual]

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

    Returns: 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.

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

    ParameterDescription
    aStoreStore to write to.

    RestoreL ( CMsvStore & )

    IMPORT_C voidRestoreL(CMsvStore &aStore)[virtual]

    Restores the object.

    leave
    TMsvEntryScheduleData::RestoreL()
    leave
    RecipientsRestoreL()
    ParameterDescription
    aStoreStore to read from.

    ScheduleDate ( )

    const TTime &ScheduleDate()const [inline]

    Gets the entry's iDate member.

    Returns: Entry's iDate member.

    Scheduled ( )

    const TBoolScheduled()const [inline]

    Gets the entry's Scheduled() flag.

    Returns: The entry's Scheduled() flag.

    SendingState ( )

    const TIntSendingState()const [inline]

    Gets the entry's SendingState() flag.

    Returns: The entry's SendingState() flag.

    SetFailed ( const TBool )

    voidSetFailed(const TBoolaFail)[inline]

    Sets the entry's Failed() flag.

    ParameterDescription
    aFailThe entry's Failed() flag.

    SetPendingConditions ( TBool )

    IMPORT_C voidSetPendingConditions(TBoolaPendingConditions)

    sets the entry's pending conditions flag.

    SetScheduleDate ( const TTime & )

    voidSetScheduleDate(const TTime &aDate)[inline]

    Sets the entry's iDate member.

    ParameterDescription
    aDateEntry's iDate member.

    SetScheduled ( const TBool )

    voidSetScheduled(const TBoolaScheduled)[inline]

    Sets the entry's Scheduled() flag.

    ParameterDescription
    aScheduledThe entry's Scheduled() flag.

    SetSendingState ( TInt )

    voidSetSendingState(TIntaState)[inline]

    Sets the entry's SendingState() flag.

    ParameterDescription
    aStateThe entry's SendingState() flag.

    StoreL ( CMsvStore & )

    IMPORT_C voidStoreL(CMsvStore &aStore)const [virtual]

    Stores the object.

    leave
    TMsvEntryScheduleData::StoreL()
    leave
    RecipientsStoreL()
    ParameterDescription
    aStoreStore to write to.
    © Nokia 2011.