Collapse all Symbian^3 Product Developer Library

CCseScheduledProgram Class Reference

class CCseScheduledProgram : public CBase

Scheduled program data.

Inherits from

CCseScheduledProgram
- CBase

Public Member Functions
	~CCseScheduledProgram()
IMPORT_C TInt32	AppUid()
IMPORT_C TPtrC8	ApplicationData()
IMPORT_C TUint32	DbIdentifier()
IMPORT_C void	DebugDump()
IMPORT_C TTime &	EndTime()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	ExternalizeLength()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TPtrC8	Name()
IMPORT_C CCseScheduledProgram *	NewL()
IMPORT_C CCseScheduledProgram *	NewL(CCseScheduledProgram &)
IMPORT_C TInt32	PluginType()
IMPORT_C TInt32	PluginUid()
IMPORT_C TInt32	ScheduleType()
IMPORT_C void	SetAppUid(const TInt32)
IMPORT_C void	SetApplicationDataL(const TDesC8 &)
IMPORT_C void	SetDbIdentifier(const TUint32)
IMPORT_C void	SetEndTime(const TTime &)
IMPORT_C void	SetName(const TDesC8 &)
IMPORT_C void	SetPluginType(TInt32)
IMPORT_C void	SetPluginUid(const TInt32)
IMPORT_C void	SetScheduleType(const TInt32)
IMPORT_C void	SetStartTime(const TTime &)
IMPORT_C TTime &	StartTime()

Protected Member Functions
	CCseScheduledProgram()
void	ConstructL()

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 Member Enumerations
enum	TCsePluginType { ECseUniPlugin = 1, ECseMultiPlugin }
enum	TCseScheduleType { ECseReminder = 0, ECseRecording, ECseProgramGuideUpdate, ECseScheduleDownload, ECseOther }

Protected Attributes
HBufC8 *	iAppData
TInt32	iAppUid
TUint32	iDbIdentifier
TTime	iEndTime
TBuf8< KCseNameMaxLength >	iName
TInt32	iPluginType
TInt32	iPluginUid
TInt32	iScheduleType
TTime	iStartTime

Constructor & Destructor Documentation

CCseScheduledProgram()

EXPORT_C

CCseScheduledProgram

(

)

[protected]

Default constructor

~CCseScheduledProgram()

IMPORT_C

~CCseScheduledProgram

(

)

[virtual]

Destructor.

Member Functions Documentation

AppUid()

IMPORT_C TInt32

AppUid

(

)

const

Gets the application uid of the schedule

ApplicationData()

IMPORT_C TPtrC8

ApplicationData

(

)

Gets the application data of the schedule.

ConstructL()

void

ConstructL

(

)

[protected]

Symbian 2nd phase constructor can leave.

DbIdentifier()

IMPORT_C TUint32

DbIdentifier

(

)

const

Gets the database identifier of the schedule.

DebugDump()

IMPORT_C void

DebugDump

(

)

const

Dumps content of schedule to debug trace

EndTime()

IMPORT_C TTime &

EndTime

(

)

Gets the end time of the schedule.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

Externalizes class content to stream.

Parameters

RWriteStream & aStream

Writestream where to write content

ExternalizeLength()

IMPORT_C TInt

ExternalizeLength

(

)

Calculates externalization length.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes class content from stream.

Parameters

RReadStream & aStream

Readstream from where to read content

Name()

IMPORT_C TPtrC8

Name

(

)

const

Get the name of the schedule.

NewL()

IMPORT_C CCseScheduledProgram *

NewL

(

)

[static]

Two-phased constructor.

NewL(CCseScheduledProgram &)

IMPORT_C CCseScheduledProgram *

NewL

(

CCseScheduledProgram &

aProg

)

[static]

Two-phased copy constructor.

Parameters

CCseScheduledProgram & aProg

PluginType()

IMPORT_C TInt32

PluginType

(

)

const

Get the type of scheduler plugin EUniPlugin for plugins that can have only one running at a given time. EMultiPlugin for plugins that can have several running at a given time

PluginUid()

IMPORT_C TInt32

PluginUid

(

)

const

Gets the plugin uid of the schedule.

ScheduleType()

IMPORT_C TInt32

ScheduleType

(

)

const

Gets the schedule type of the schedule.

SetAppUid(const TInt32)

IMPORT_C void

SetAppUid

(

const TInt32

aAppUid

)

Sets new application uid for schedule.

Parameters

const TInt32 aAppUid

New application uid of the schedule

SetApplicationDataL(const TDesC8 &)

IMPORT_C void

SetApplicationDataL

(

const TDesC8 &

aAppData

)

Sets new application data for schedule

Parameters

const TDesC8 & aAppData

New application data of the schedule

SetDbIdentifier(const TUint32)

IMPORT_C void

SetDbIdentifier

(

const TUint32

aDbIdentifier

)

Sets new database identifier for the schedule. Note that this should only be set by Common Scheduling Engine, not the application using it.

Parameters

const TUint32 aDbIdentifier

New database identifier of the schedule

SetEndTime(const TTime &)

IMPORT_C void

SetEndTime

(

const TTime &

aEndTime

)

Sets new schedule end time.

Parameters

const TTime & aEndTime

New end time of the schedule

SetName(const TDesC8 &)

IMPORT_C void

SetName

(

const TDesC8 &

aName

)

Sets new schedule name.

Parameters

const TDesC8 & aName

New name of the schedule

SetPluginType(TInt32)

IMPORT_C void

SetPluginType

(

TInt32

aPluginType

)

Sets new plugin type for schedule. EUniPlugin for plugins that can have only one running at a given time. EMultiPlugin for plugins that can have several running at a given time

Parameters

TInt32 aPluginType

New plugin type

SetPluginUid(const TInt32)

IMPORT_C void

SetPluginUid

(

const TInt32

aPluginUid

)

Sets new plugin uid for schedule

Parameters

const TInt32 aPluginUid

New plugin uid of the schedule

SetScheduleType(const TInt32)

IMPORT_C void

SetScheduleType

(

const TInt32

aScheduleType

)

Sets new schedule for the schedule.

Parameters

const TInt32 aScheduleType

New schedule type of the schedule

SetStartTime(const TTime &)

IMPORT_C void

SetStartTime

(

const TTime &

aStartTime

)

Sets new schedule start time.

Parameters

const TTime & aStartTime

New start time of the schedule

StartTime()

IMPORT_C TTime &

StartTime

(

)

Gets the start time of the schedule.

Member Enumerations Documentation

Enum TCsePluginType

Enumerators

ECseUniPlugin = 1
ECseMultiPlugin

Enum TCseScheduleType

Enumerators

ECseReminder = 0
ECseRecording
ECseProgramGuideUpdate
ECseScheduleDownload
ECseOther

Member Data Documentation

HBufC8 * iAppData

HBufC8 *

iAppData

[protected]

Application Data Application specific data for the plugin. Common scheduling Engine has no knowledge what this data contains.

TInt32 iAppUid

TInt32

iAppUid

[protected]

Application UID This is the application uid of the program that has added this schedule. Can be used to retrieve all schedules of certain application.

TUint32 iDbIdentifier

TUint32

iDbIdentifier

[protected]

DB identifier Used to separate schedules from each other in database. Should be only added by Common scheduling engine, not by application using it.

TTime iEndTime

TTime

iEndTime

[protected]

End time End time for schedules that take longer time to complete, for example recording of the TV program. If schedule is "instant" (e.g. just notification to user) start time and end time should be the same.

TBuf8< KCseNameMaxLength > iName

TBuf8< KCseNameMaxLength >

iName

[protected]

Name Name of the scheduled program, e.g. name of the TV program.

TInt32 iPluginType

TInt32

iPluginType

[protected]

Schedule plugin type Type of the plugin where this schedule will be run

TInt32 iPluginUid

TInt32

iPluginUid

[protected]

Plugin UID UID of the plugin where this scheduled program is passed when the time is right.

TInt32 iScheduleType

TInt32

iScheduleType

[protected]

Schedule type Type of this schedule, e.g. reminder, recording...

TTime iStartTime

TTime

iStartTime

[protected]

Start time Start time when the scheduled program is run (passed to plugin which is defined here).