Collapse all Symbian^3 Application Developer Library

CCseSchedulerApi Class Reference

class CCseSchedulerApi : public CBase

General client api that manages service functionality.

CseSchedulerClient.lib

Inherits from

CCseSchedulerApi
- CBase

Public Member Functions
	~CCseSchedulerApi ()
IMPORT_C TInt	AddSchedule ( CCseScheduledProgram &)
IMPORT_C TInt	GetOverlappingSchedules ( CCseScheduledProgram &, RPointerArray < CCseScheduledProgram > &)
IMPORT_C TInt	GetSchedule (const TUint32 , CCseScheduledProgram *)
IMPORT_C TInt	GetSchedulesByAppUid (const TInt32 , RPointerArray < CCseScheduledProgram > &)
IMPORT_C TInt	GetSchedulesByPluginUid (const TInt32 , RPointerArray < CCseScheduledProgram > &)
IMPORT_C TInt	GetSchedulesByTime (const TTime &, const TTime &, RPointerArray < CCseScheduledProgram > &)
IMPORT_C TInt	GetSchedulesByType (const TInt32 , RPointerArray < CCseScheduledProgram > &)
IMPORT_C CCseSchedulerApi *	NewL ()
IMPORT_C TInt	RemoveSchedule (const TUint32 )

Private Member Functions
	CCseSchedulerApi ()
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()

Private Attributes
RCseSchedulerClient	iClient
RCseSchedulerService	iService

Constructor & Destructor Documentation

CCseSchedulerApi()

CCseSchedulerApi

(

)

[private]

C++ default constructor.

~CCseSchedulerApi()

IMPORT_C

~CCseSchedulerApi

(

)

[virtual]

Destructor.

Member Functions Documentation

AddSchedule(CCseScheduledProgram &)

IMPORT_C TInt

AddSchedule

(

CCseScheduledProgram &

aData

)

const

Adds given schedule to Common Scheduling Engine database. After the call is completed, the parameter contains the DB identifier of the schedule.

Parameters

CCseScheduledProgram & aData

Schedule to be added to database.

ConstructL()

void

ConstructL

(

)

[private]

Symbian 2nd phase constructor can leave.

GetOverlappingSchedules(CCseScheduledProgram &, RPointerArray< CCseScheduledProgram > &)

IMPORT_C TInt	GetOverlappingSchedules	(	CCseScheduledProgram &	aProgram,
			RPointerArray < CCseScheduledProgram > &	aResultArray
		)

Get overlapping schedule (if any) from the scheduling engine. Uses schedule type, start and end times to find overalapping schedules from the Commone Scheduling Engine database.

Parameters

CCseScheduledProgram & aProgram	Schedule to used for finding overlapping schedules.
RPointerArray < CCseScheduledProgram > & aResultArray	On return, contains array of overlapping schedules, empty if none found.

GetSchedule(const TUint32, CCseScheduledProgram *)

IMPORT_C TInt	GetSchedule	(	const TUint32	aDbIdentifier,
			CCseScheduledProgram *	aProg
		)	const

Gets schedule from database.

Parameters

const TUint32 aDbIdentifier	Database identifier of the schedule that is wanted from the database
CCseScheduledProgram * aProg	Pointer where this scheduled program is get.

GetSchedulesByAppUid(const TInt32, RPointerArray< CCseScheduledProgram > &)

IMPORT_C TInt	GetSchedulesByAppUid	(	const TInt32	aAppUid,
			RPointerArray < CCseScheduledProgram > &	aArray
		)	const

Get list of scheduled events from the scheduling engine based on given UID.

Parameters

const TInt32 aAppUid	Application UID.
RPointerArray < CCseScheduledProgram > & aArray	On return contains items from the database.

GetSchedulesByPluginUid(const TInt32, RPointerArray< CCseScheduledProgram > &)

IMPORT_C TInt	GetSchedulesByPluginUid	(	const TInt32	aPluginUid,
			RPointerArray < CCseScheduledProgram > &	aArray
		)	const

Get list of scheduled events from the scheduling engine based on given UID.

Parameters

const TInt32 aPluginUid	Plugin UID.
RPointerArray < CCseScheduledProgram > & aArray	On return contains items from the database.

GetSchedulesByTime(const TTime &, const TTime &, RPointerArray< CCseScheduledProgram > &)

IMPORT_C TInt	GetSchedulesByTime	(	const TTime &	aBeginning,
			const TTime &	aEnd,
			RPointerArray < CCseScheduledProgram > &	aArray
		)	const

Get list of scheduled events from the scheduling engine between given timeframe.

Parameters

const TTime & aBeginning	Beginning of the time frame
const TTime & aEnd	End of the time frame
RPointerArray < CCseScheduledProgram > & aArray

GetSchedulesByType(const TInt32, RPointerArray< CCseScheduledProgram > &)

IMPORT_C TInt	GetSchedulesByType	(	const TInt32	aScheduleType,
			RPointerArray < CCseScheduledProgram > &	aArray
		)	const

Get list of scheduled events from the scheduling engine based on given schedule type.

Parameters

const TInt32 aScheduleType	Schedule type.
RPointerArray < CCseScheduledProgram > & aArray	On return contains items from the database.

NewL()

IMPORT_C CCseSchedulerApi *

NewL

(

)

[static]

Two-phased constructor.

RemoveSchedule(const TUint32)

IMPORT_C TInt

RemoveSchedule

(

const TUint32

aDbIdentifier

)

const

Removes schedule from database.

Parameters

const TUint32 aDbIdentifier

Database identifier of the schedule to be removed.

Member Data Documentation

RCseSchedulerClient iClient

RCseSchedulerClient

iClient

[private]

Scheduler engine - Client

RCseSchedulerService iService

RCseSchedulerService

iService

[private]

Scheduler engine - Service