Collapse all Symbian^3 Product Developer Library

RCseSchedulerService Class Reference

class RCseSchedulerService : public RCseSchedulerServiceBase

General client api that manages service functionality.

CseSchedulerClient.lib

Inherits from

RCseSchedulerService
- RCseSchedulerServiceBase
  - RSubSessionBase

Public Member Functions
	RCseSchedulerService()
	~RCseSchedulerService()
void	AddScheduleL(CCseScheduledProgram &)
void	GetOverlappingSchedulesL(CCseScheduledProgram &, RPointerArray< CCseScheduledProgram > &)
void	GetScheduleL(const TUint32, CCseScheduledProgram *)
void	GetSchedulesByPluginUidL(const TInt32, RPointerArray< CCseScheduledProgram > &)
void	GetSchedulesByTimeL(const TTime &, const TTime &, RPointerArray< CCseScheduledProgram > &)
void	GetSchedulesByTypeL(const TInt32, RPointerArray< CCseScheduledProgram > &)
void	GetSchedulesL(const TInt32, RPointerArray< CCseScheduledProgram > &)
void	RemoveScheduleL(const TUint32)

Inherited Functions
	RCseSchedulerServiceBase::Close()
	RCseSchedulerServiceBase::Open(RCseSchedulerClient &)
	RCseSchedulerServiceBase::PanicClient(TInt)const
	RCseSchedulerServiceBase::RCseSchedulerServiceBase()
	RCseSchedulerServiceBase::SessionHandle()const
	RCseSchedulerServiceBase::~RCseSchedulerServiceBase()
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Constructor & Destructor Documentation

RCseSchedulerService()

RCseSchedulerService

(

)

Constructor.

~RCseSchedulerService()

~RCseSchedulerService

(

)

[virtual]

Destructor.

Member Functions Documentation

AddScheduleL(CCseScheduledProgram &)

void

AddScheduleL

(

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.

GetOverlappingSchedulesL(CCseScheduledProgram &, RPointerArray< CCseScheduledProgram > &)

void	GetOverlappingSchedulesL	(	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.

GetScheduleL(const TUint32, CCseScheduledProgram *)

void	GetScheduleL	(	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.

GetSchedulesByPluginUidL(const TInt32, RPointerArray< CCseScheduledProgram > &)

void	GetSchedulesByPluginUidL	(	const TInt32	aPluginUid,
			RPointerArray< CCseScheduledProgram > &	aArray
		)	const

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

Parameters

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

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

void	GetSchedulesByTimeL	(	const TTime &	aBegining,
			const TTime &	aEnd,
			RPointerArray< CCseScheduledProgram > &	aArray
		)	const

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

Parameters

const TTime & aBegining
const TTime & aEnd	End of the timeframe.
RPointerArray< CCseScheduledProgram > & aArray	On return contains items from the database.

GetSchedulesByTypeL(const TInt32, RPointerArray< CCseScheduledProgram > &)

void	GetSchedulesByTypeL	(	const TInt32	aType,
			RPointerArray< CCseScheduledProgram > &	aArray
		)	const

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

Parameters

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

GetSchedulesL(const TInt32, RPointerArray< CCseScheduledProgram > &)

void	GetSchedulesL	(	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.

RemoveScheduleL(const TUint32)

void

RemoveScheduleL

(

const TUint32

aDbIdentifier

)

const

Removes schedule from database.

Parameters

const TUint32 aDbIdentifier

Database identifier of the schedule to be removed.