Collapse all Symbian^3 Application Developer Library

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

CMsvScheduledEntry
- CBase

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 &)

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()

Public Attributes
TMsvEntryScheduleData	iData

Private Attributes
TMsvEntry	iEntry

Constructor & Destructor Documentation

CMsvScheduledEntry(const TMsvEntry &)

IMPORT_C

CMsvScheduledEntry

(

const TMsvEntry &

aEntry

)

[protected]

Constructor.

Parameters

const TMsvEntry & aEntry

Scheduled message.

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.

Parameters

const CMsvSendErrorActions & aErrorActions	Error-actions
TMsvSendErrorAction & aAction	Default 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.

Parameters

const TMsvSendErrorAction & aAction

Default error-action

Entry(TMsvEntry &)

IMPORT_C void

Entry

(

TMsvEntry &

aEntry

)

const

Gets the message entry.

Parameters

TMsvEntry & aEntry

On return, the message entry.

Error()

const TInt

Error

(

)

const [inline]

Gets the entry's iError data member.

Failed()

const TBool

Failed

(

)

const [inline]

Gets the entry's Failed() flag.

Id()

const TMsvId

(

)

const [inline]

Gets the entry's ID.

Mtm()

const TUid

Mtm

(

)

const [inline]

Gets the entry's iMtm data member.

OffPeak()

const TBool

OffPeak

(

)

const [inline]

Gets the entry's OffPeak() flag.

PendingConditions()

IMPORT_C TBool

PendingConditions

(

)

const

Gets the entry's pending conditions flag.

RecipientsAllSent()

TBool

RecipientsAllSent

(

)

const [pure virtual]

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

RecipientsIncreaseRetries()

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.

Parameters

CMsvStore & 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.

Parameters

CMsvStore & aStore

Store to write to.

RestoreL(CMsvStore &)

IMPORT_C void

RestoreL

(

CMsvStore &

aStore

)

[virtual]

Restores the object.

leave: TMsvEntryScheduleData::RestoreL()

leave: RecipientsRestoreL()

Parameters

CMsvStore & aStore

Store to read from.

ScheduleDate()

const TTime &

ScheduleDate

(

)

const [inline]

Gets the entry's iDate member.

Scheduled()

const TBool

Scheduled

(

)

const [inline]

Gets the entry's Scheduled() flag.

SendingState()

const TInt

SendingState

(

)

const [inline]

Gets the entry's SendingState() flag.

SetFailed(const TBool)

void

SetFailed

(

const TBool

aFail

)

[inline]

Sets the entry's Failed() flag.

Parameters

const TBool aFail

The entry's Failed() flag.

SetPendingConditions(TBool)

IMPORT_C void

SetPendingConditions

(

TBool

aPendingConditions

)

sets the entry's pending conditions flag.

Parameters

TBool aPendingConditions

SetScheduleDate(const TTime &)

void

SetScheduleDate

(

const TTime &

aDate

)

[inline]

Sets the entry's iDate member.

Parameters

const TTime & aDate

Entry's iDate member.

SetScheduled(const TBool)

void

SetScheduled

(

const TBool

aScheduled

)

[inline]

Sets the entry's Scheduled() flag.

Parameters

const TBool aScheduled

The entry's Scheduled() flag.

SetSendingState(TInt)

void

SetSendingState

(

TInt

aState

)

[inline]

Sets the entry's SendingState() flag.

Parameters

TInt aState

The entry's SendingState() flag.

StoreL(CMsvStore &)

IMPORT_C void

StoreL

(

CMsvStore &

aStore

)

const [virtual]

Stores the object.

leave: TMsvEntryScheduleData::StoreL()

leave: RecipientsStoreL()

Parameters

CMsvStore & aStore

Store to write to.

Member Data Documentation

TMsvEntryScheduleData iData

TMsvEntryScheduleData

iData

Message schedule data.

TMsvEntry iEntry

TMsvEntry

iEntry

[private]