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 void	Entry(TMsvEntry &)
const TInt	Error()
const TBool	Failed()
const TMsvId	Id()
const TUid	Mtm()
const TBool	OffPeak()
IMPORT_C TBool	PendingConditions()
pure virtual TBool	RecipientsAllSent()
pure virtual void	RecipientsIncreaseRetries()
pure virtual void	RecipientsResetRetries()
pure virtual void	RecipientsRestoreL(CMsvStore &)
pure virtual void	RecipientsSetFailed()
pure virtual void	RecipientsStoreL(CMsvStore &)
virtual 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)
virtual IMPORT_C void	StoreL(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_C

CMsvScheduledEntry

(

const TMsvEntry &

aEntry

)

[protected]

Constructor.

Parameter	Description
aEntry	Scheduled 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.

Parameter	Description
aErrorActions	Error-actions
aAction	Default 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.

Parameter	Description
aAction	Default error-action

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

Entry ( TMsvEntry & )

IMPORT_C void

Entry

(

TMsvEntry &

aEntry

)

const

Gets the message entry.

Parameter	Description
aEntry	On return, the message entry.

Error ( )

const TInt

Error

(

)

const [inline]

Gets the entry's iError data member.

Returns: The entry's iError data member.

Failed ( )

const TBool

Failed

(

)

const [inline]

Gets the entry's Failed() flag.

Returns: The entry's Failed() flag.

void

RecipientsIncreaseRetries

(

)

[pure virtual]

Increases all the recipients' retries by one.

RecipientsResetRetries ( )

void

RecipientsResetRetries

(

)

[pure virtual]

Sets all the recipients' retries to zero.

RecipientsRestoreL ( CMsvStore & )

void

RecipientsRestoreL

(

CMsvStore &

aStore

)

[pure virtual]

Restores the recipients.

Parameter	Description
aStore	Store to read from.

RecipientsSetFailed ( )

void

RecipientsSetFailed

(

)

[pure virtual]

Sets all the recipients' flags to sending failed.

RecipientsStoreL ( CMsvStore & )

void

RecipientsStoreL

(

CMsvStore &

aStore

)

const [pure virtual]

Stores the recipients.

Parameter	Description
aStore	Store to write to.

RestoreL ( CMsvStore & )

IMPORT_C void

RestoreL

(

CMsvStore &

aStore

)

[virtual]

Restores the object.

leave: TMsvEntryScheduleData::RestoreL()

leave: RecipientsRestoreL()

Parameter	Description
aStore	Store to read from.

ScheduleDate ( )

const TTime &

ScheduleDate

(

)

const [inline]

Gets the entry's iDate member.

Returns: Entry's iDate member.

Scheduled ( )

const TBool

Scheduled

(

)

const [inline]

Gets the entry's Scheduled() flag.

Returns: The entry's Scheduled() flag.

SendingState ( )

const TInt

SendingState

(

)

const [inline]

Gets the entry's SendingState() flag.

Returns: The entry's SendingState() flag.

SetFailed ( const TBool )

void

SetFailed

(

const TBool

aFail

)

[inline]

Sets the entry's Failed() flag.

Parameter	Description
aFail	The entry's Failed() flag.

SetPendingConditions ( TBool )

IMPORT_C void

SetPendingConditions

(

TBool

aPendingConditions

)

sets the entry's pending conditions flag.

SetScheduleDate ( const TTime & )

void

SetScheduleDate

(

const TTime &

aDate

)

[inline]

Sets the entry's iDate member.

Parameter	Description
aDate	Entry's iDate member.

SetScheduled ( const TBool )

void

SetScheduled

(

const TBool

aScheduled

)

[inline]

Sets the entry's Scheduled() flag.

Parameter	Description
aScheduled	The entry's Scheduled() flag.

SetSendingState ( TInt )

void

SetSendingState

(

TInt

aState

)

[inline]

Sets the entry's SendingState() flag.

Parameter	Description
aState	The entry's SendingState() flag.

StoreL ( CMsvStore & )

IMPORT_C void

StoreL

(

CMsvStore &

aStore

)

const [virtual]

Stores the object.

leave: TMsvEntryScheduleData::StoreL()

leave: RecipientsStoreL()

Parameter	Description
aStore	Store to write to.