TScheduleEntryInfo2 Class Reference

#include <schinfo.h>

Link against: schsvr.lib

class TScheduleEntryInfo2

Detailed Description

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.

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

Constructor & Destructor Documentation

TScheduleEntryInfo2 ( )

IMPORT_CTScheduleEntryInfo2()

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_CTScheduleEntryInfo2(const TScheduleEntryInfo2 &aEntryInfo)

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

Parameters
aEntryInfoThe TScheduleEntryInfo2 object to be copied

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

IMPORT_CTScheduleEntryInfo2(const TTsTime &aStartTime,
TIntervalTypeaIntervalType,
TIntaInterval,
TTimeIntervalMinutesaValidityPeriod
)

TScheduleEntryInfo2 constructor taking the specified parameters.

Parameters
aStartTimeThe first time that the entry will cause execution of tasks
aIntervalTypeDefines 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
aIntervalThe interval between execution of tasks For a schedule entry interval to be valid, it should be greater than or equal to 1

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.

See also: TScheduleEntryInfo

Parameters
aEntryInfoEntry info of deprecated type TScheduleEntryInfo

Member Function Documentation

ExternalizeL ( RWriteStream & )

voidExternalizeL(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
aStreamStream to which the object should be externalised. only used by server

InternalizeL ( RReadStream & )

voidInternalizeL(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
aStreamStream from which the object is to be internalised. only used by server

Interval ( )

IMPORT_C TIntInterval()const

Returns the interval between execution of tasks.

See also: TScheduleEntryInfo2::SetInterval

Return Value
Interval between execution of tasks. For a schedule entry interval to be valid, it should be greater than or equal to 1.

IntervalType ( )

IMPORT_C TIntervalTypeIntervalType()const

Returns the Interval Type

See also: TIntervalType

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

ProcessOffsetEvent ( )

voidProcessOffsetEvent()

Calls ProcessOffsetEvent() on TScheduleEntryInfo's start time member

See also: TTsTime::ProcessOffsetEvent only used by the server

SetInterval ( TInt )

IMPORT_C voidSetInterval(TIntaInterval)

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
aIntervalFor a schedule entry interval to be valid, it should be greater than or equal to 1.

SetIntervalType ( TIntervalType )

IMPORT_C voidSetIntervalType(TIntervalTypeaIntervalType)

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.

See also: TIntervalType

Parameters
aIntervalTypeThe type of interval to be used.

SetStartTime ( const TTsTime & )

IMPORT_C voidSetStartTime(const TTsTime &aStartTime)

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

See also: TTsTime

Parameters
aStartTimeThis 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 voidSetValidityPeriod(TTimeIntervalMinutesaValidityPeriod)

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

See also: TTimeIntervalMinutes

StartTime ( )

IMPORT_C const TTsTime &StartTime()const

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

See also: TTsTime

Return Value
Start time - this TTsTime value may be either UTC or local time based. Entries with local time based start times will remain at that local time regardless of timezone or DST changes (ie. will float). Entries with UTC based start times, will remain at the given UTC time (will not float).

ValidityPeriod ( )

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

Return Value
TTimeIntervalMinutes

operator= ( const TScheduleEntryInfo2 & )

IMPORT_C TScheduleEntryInfo2 &operator=(const TScheduleEntryInfo2 &aEntryInfo)

Assignment operator for TScheduleEntryInfo2

See also: Mem::Copy