Class TScheduleEntryInfo2

class TScheduleEntryInfo2;

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.

Members

Defined in TScheduleEntryInfo2:
Interval(), IntervalType(), SetInterval(), SetIntervalType(), SetStartTime(), SetValidityPeriod(), StartTime(), TScheduleEntryInfo2(), TScheduleEntryInfo2(), TScheduleEntryInfo2(), ValidityPeriod(), operator=()

See also:

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

IMPORT_C TScheduleEntryInfo2();

Description

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

IMPORT_C TScheduleEntryInfo2(const TScheduleEntryInfo2 &aEntryInfo);

Description

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

Parameters

const TScheduleEntryInfo2 &aEntryInfo The TScheduleEntryInfo2 object to be copied

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

Description

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

IMPORT_C TIntervalType IntervalType() const;

Description

Returns the Interval Type

Return value

TIntervalType 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

IMPORT_C void SetIntervalType(TIntervalType aIntervalType);

Description

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.

Parameters

TIntervalType aIntervalType The type of interval to be used.

See also:

• TIntervalType

IMPORT_C const TTsTime &StartTime() const;

Description

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

Return value

const TTsTime & 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).

See also:

• TTsTime

IMPORT_C void SetStartTime(const TTsTime &aStartTime);

Description

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

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

See also:

• TTsTime

IMPORT_C TInt Interval() const;

Description

Returns the interval between execution of tasks.

Return value

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

IMPORT_C void SetInterval(TInt aInterval);

Description

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.

IMPORT_C TTimeIntervalMinutes ValidityPeriod() const;

Description

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 TTimeIntervalMinutes

IMPORT_C void SetValidityPeriod(TTimeIntervalMinutes aValidityPeriod);

Description

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

Parameters

TTimeIntervalMinutes aValidityPeriod

See also:

• TTimeIntervalMinutes

IMPORT_C TScheduleEntryInfo2 &operator=(const TScheduleEntryInfo2 &aEntryInfo);

Description

Assignment operator for TScheduleEntryInfo2

Parameters

const TScheduleEntryInfo2 &aEntryInfo

Return value

TScheduleEntryInfo2 &