Collapse all Symbian^3 Application Developer Library

TScheduleEntryInfo2 Class Reference

class TScheduleEntryInfo2

Contains detailed information for a single schedule entry.

A schedule can have any number of schedule entries. A client passes one or more of these objects, contained within an array, to the RScheduler functions that create or amend a schedule.

RScheduler::CreatePersistentSchedule() RScheduler::EditSchedule() RScheduler::ScheduleTask() RScheduler::GetScheduleL()

Public Member Functions
	TScheduleEntryInfo2 ()
	TScheduleEntryInfo2 (const TScheduleEntryInfo2 &)
	TScheduleEntryInfo2 (const TTsTime &, TIntervalType , TInt , TTimeIntervalMinutes )
	TScheduleEntryInfo2 (const TScheduleEntryInfo &)
void	ExternalizeL ( RWriteStream &)
void	InternalizeL ( RReadStream &)
IMPORT_C TInt	Interval ()
IMPORT_C TIntervalType	IntervalType ()
void	ProcessOffsetEvent ()
IMPORT_C void	SetInterval ( TInt )
IMPORT_C void	SetIntervalType ( TIntervalType )
IMPORT_C void	SetStartTime (const TTsTime &)
IMPORT_C void	SetValidityPeriod ( TTimeIntervalMinutes )
IMPORT_C const TTsTime &	StartTime ()
IMPORT_C TTimeIntervalMinutes	ValidityPeriod ()
IMPORT_C TScheduleEntryInfo2 &	operator= (const TScheduleEntryInfo2 &)

Private Attributes
TInt	iInterval
TIntervalType	iIntervalType
TAny *	iReserved
TTsTime	iStartTime
TTimeIntervalMinutes	iValidityPeriod

Constructor & Destructor Documentation

TScheduleEntryInfo2()

IMPORT_C

TScheduleEntryInfo2

(

)

TScheduleEntryInfo2 Default constructor. It sets the object's members data to the following default values. iIntervalType : EHourly iStartTime : UTC time set to 0 iInterval : 0 iValidityPeriod : 0

TScheduleEntryInfo2(const TScheduleEntryInfo2 &)

IMPORT_C

TScheduleEntryInfo2

(

const TScheduleEntryInfo2 &

aEntryInfo

)

Copy constructor for TScheduleEntryInfo2 Sets the parameter's data to this object.

Parameters

const TScheduleEntryInfo2 & aEntryInfo

The TScheduleEntryInfo2 object to be copied

TScheduleEntryInfo2(const TTsTime &, TIntervalType, TInt, TTimeIntervalMinutes)

IMPORT_C	TScheduleEntryInfo2	(	const TTsTime &	aStartTime,
			TIntervalType	aIntervalType,
			TInt	aInterval,
			TTimeIntervalMinutes	aValidityPeriod
		)

TScheduleEntryInfo2 constructor taking the specified parameters.

Parameters

const TTsTime & aStartTime	The first time that the entry will cause execution of tasks
TIntervalType aIntervalType	Defines the type of time-frame relative to which execution of tasks is timed; for example, EHourly implies relative to the current hour, EDaily implies relative to the current day
TInt aInterval	The interval between execution of tasks For a schedule entry interval to be valid, it should be greater than or equal to 1
TTimeIntervalMinutes aValidityPeriod

TScheduleEntryInfo2(const TScheduleEntryInfo &)

TScheduleEntryInfo2

(

const TScheduleEntryInfo &

aEntryInfo

)

Non exported constructor accepting a TScheduleEntryInfo parameter This constructor is provided for use with the deprecated APIs. This will assume home time in order to maintain backwards compatibility and will create a # TScheduleEntryInfo2 object with a local time based start time. TScheduleEntryInfo

Parameters

const TScheduleEntryInfo & aEntryInfo

Entry info of deprecated type TScheduleEntryInfo

Member Functions Documentation

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises an object of this class to a write stream. The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters

RWriteStream & aStream

Stream to which the object should be externalised. only used by server

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

Internalises an object of this class from a read stream. The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Parameters

RReadStream & aStream

Stream from which the object is to be internalised. only used by server

Interval()

IMPORT_C TInt

Interval

(

)

const

Returns the interval between execution of tasks. TScheduleEntryInfo2::SetInterval

IntervalType()

IMPORT_C TIntervalType

IntervalType

(

)

const

Returns the Interval Type TIntervalType

ProcessOffsetEvent()

void

ProcessOffsetEvent

(

)

Calls ProcessOffsetEvent() on TScheduleEntryInfo's start time member TTsTime::ProcessOffsetEvent only used by the server

SetInterval(TInt)

IMPORT_C void

SetInterval

(

TInt

aInterval

)

Sets the interval between execution of tasks. The way that this value is interpreted depends on the value of iIntervalType. For example, if the interval is 2 and iIntervalType has a value of EMonthly, then the interval is 2 months.

Parameters

TInt aInterval

For a schedule entry interval to be valid, it should be greater than or equal to 1.

SetIntervalType(TIntervalType)

IMPORT_C void

SetIntervalType

(

TIntervalType

aIntervalType

)

Sets the type of interval used between due times for this schedule entry. The type of interval used may be EHourly, EDaily, EMonthly or EYearly. TIntervalType

Parameters

TIntervalType aIntervalType

The type of interval to be used.

SetStartTime(const TTsTime &)

IMPORT_C void

SetStartTime

(

const TTsTime &

aStartTime

)

Sets the first time the entry will cause execution of tasks. TTsTime

Parameters

const TTsTime & aStartTime

This TTsTime value may be either UTC or local time based. If this is a local time based value, the schedule entry will remain at that local time regardless of timezone and DST changes (ie. it will float) If the value is UTC based, the schedule entry will remain at that UTC time (will not float).

SetValidityPeriod(TTimeIntervalMinutes)

IMPORT_C void

SetValidityPeriod

(

TTimeIntervalMinutes

aValidityPeriod

)

Sets the period for which the entry is valid. After the validity period has expired, tasks associated with the entry will not be eligible for execution TTimeIntervalMinutes

Parameters

TTimeIntervalMinutes aValidityPeriod

StartTime()

IMPORT_C const TTsTime &

StartTime

(

)

const

Returns the first time at which the entry will cause execution of tasks. TTsTime

ValidityPeriod()

IMPORT_C TTimeIntervalMinutes

ValidityPeriod

(

)

const

Return the period for which the entry is valid. After the validity period has expired, tasks associated with the entry will not be eligible for execution

operator=(const TScheduleEntryInfo2 &)

IMPORT_C TScheduleEntryInfo2 &

operator=

(

const TScheduleEntryInfo2 &

aEntryInfo

)

Assignment operator for TScheduleEntryInfo2 Mem::Copy

Parameters

const TScheduleEntryInfo2 & aEntryInfo

Member Data Documentation

TInt iInterval

TInt

iInterval

[private]

The interval between execution of tasks. The way that this value is interpreted depends on the value of iIntervalType. For example, if the interval is 2 and iIntervalType has a value of EMonthly, then the interval is 2 months. The interval must have a minimum value of 1.