Class TScheduleState2

class TScheduleState2;

Description

Defines the state of a schedule.

An object of this type is passed to, and populated by, a call to RScheduler::GetScheduleL().

Members

Defined in TScheduleState2:
DueTime(), Enabled(), Name(), Persists(), SetDueTime(), SetEnabled(), SetName(), SetPersists(), TScheduleState2(), TScheduleState2(), TScheduleState2(), operator=()

See also:

• RScheduler::GetScheduleL()

IMPORT_C TScheduleState2();

Description

Default Constructor for TScheduleState2. By default, this state: has an empty string name, is non persistent, non enabled and its due time is set to zero.

IMPORT_C TScheduleState2(const TScheduleState2 &aScheduleState);

Description

Copy constructor for TScheduleState2

Parameters

const TScheduleState2 &aScheduleState The TScheduleState2 object to be copied

IMPORT_C TScheduleState2(const TName &aName, const TTsTime &aDueTime, TBool aPersists, TBool aEnabled);

Description

Constructor taking the specified parameters.

Parameters

const TName &aName The name of the schedule const TTsTime &aDueTime The time when the schedule is next due. TBool aPersists Boolean to indicate whether the schedule is persistent or not. if a schedule is persistent, its lifetime is not limited to the lifetime of the tasks associated with it. If a schedule is transient, it is created together with a new scheduled task, and is destroyed when the task is destroyed TBool aEnabled Boolean to indicate whether the shedule is enabled or not.

IMPORT_C const TName &Name() const;

Description

Return value

const TName & The name of the schedule

IMPORT_C void SetName(const TName &aName);

Description

Sets the name of the schedule

Parameters

const TName &aName The name of the schedule

IMPORT_C const TTsTime &DueTime() const;

Description

Returns the time when the schedule is next due.

Return value

const TTsTime & The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.

See also:

• TTsTime

IMPORT_C void SetDueTime(const TTsTime &aDueTime);

Description

Sets the time when the schedule is next due.

Parameters

const TTsTime &aDueTime The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.

See also:

• TTsTime

IMPORT_C TBool Persists() const;

Description

Returns a boolean whether this schedule perists or not.

Return value

TBool Etrue if this schedule persists, EFalse if this schedule doen't persist.

IMPORT_C void SetPersists(TBool aPersists);

Description

Sets a boolean whether this schedule perists or not.

Parameters

TBool aPersists Etrue if this schedule persits, EFalse if this schedule doen't persist.

IMPORT_C TBool Enabled() const;

Description

Returns information on whether this schedule is enabled or not.

Return value

TBool Etrue if the schedule is enabled, EFalse id the schedule is not enabled.

IMPORT_C void SetEnabled(TBool aEnabled);

Description

Sets information on whether this schedule is enabled or not.

Parameters

TBool aEnabled

IMPORT_C TScheduleState2 &operator=(const TScheduleState2 &aScheduleState);

Description

Assigns a TScheduleState2 to this object.

Parameters

const TScheduleState2 &aScheduleState

Return value

TScheduleState2 &