Collapse all Symbian^3 Application Developer Library

MCFOperationServices Class Reference

class MCFOperationServices

This is a service interface for Script Engine operations.

CFScriptEngine

Since: S60 v5.0

Public Member Functions
TInt	CheckContextReadSecurity (const TDesC &, const TDesC &)
TInt	CheckScriptOwnerAccess (const TSecurityPolicy &)
MCFContextInterface &	ContextInterface ()
void	Delete (const TDesC &)
void	FireActionL (CCFScriptEvent *)
void	FireActionL (const CCFContextSourceCommand &)
TInt	GetActionSecurityPolicy (const TDesC &, TSecurityPolicy &)
void	LaunchActivatedActions ()
CCFOperationNode *	ParseL ( CCFOperationNode *, CMDXMLNode &)
void	RemoveSubscription ( MCFScriptListener *)
void	RestoreL (const TDesC &, CCFOperationNode &)
TInt	ScriptId ()
void	StoreL (const TDesC &, CCFOperationNode &)
void	SubscribeContextL ( MCFScriptListener *)

Member Functions Documentation

CheckContextReadSecurity(const TDesC &, const TDesC &)

TInt	CheckContextReadSecurity	(	const TDesC &	aSource,
			const TDesC &	aType
		)	[pure virtual]

Checks a context read security.

Parameters

const TDesC & aSource	is the context source.
const TDesC & aType	is the context type.

CheckScriptOwnerAccess(const TSecurityPolicy &)

TInt

CheckScriptOwnerAccess

(

const TSecurityPolicy &

aPolicy

)

[pure virtual]

Checks a script owners capabilities against given security policy. This is typically called by the operation nodes when the CheckSecurity()-method for them is called.

Parameters

const TSecurityPolicy & aPolicy

is the security policy.

ContextInterface()

MCFContextInterface &

ContextInterface

(

)

const [pure virtual]

Gets context interface.

Delete(const TDesC &)

void

Delete

(

const TDesC &

aFile

)

[pure virtual]

Deletes the persistent file. Operation node must call this method for all persistent data files it owns when Cleanup() -method is called.

Parameters

const TDesC & aFile

file name of the persistent data file.

FireActionL(CCFScriptEvent *)

void

FireActionL

(

CCFScriptEvent *

aEvent

)

[pure virtual]

Fires an action.

Parameters

CCFScriptEvent * aEvent

is the script event defining the action. Ownership is transferred.

FireActionL(const CCFContextSourceCommand &)

void

FireActionL

(

const CCFContextSourceCommand &

aCommand

)

[pure virtual]

Fires a context source command action.

Parameters

const CCFContextSourceCommand & aCommand

is the context source command.

GetActionSecurityPolicy(const TDesC &, TSecurityPolicy &)

TInt	GetActionSecurityPolicy	(	const TDesC &	aActionId,
			TSecurityPolicy &	aPolicy
		)	[pure virtual]

Gets the security policy of a particular action.

Parameters

const TDesC & aActionId	is the identifier of the action.
TSecurityPolicy & aPolicy	is the security policy which will be set by this method.

LaunchActivatedActions()

void

LaunchActivatedActions

(

)

[pure virtual]

Check if there are actions to launch and launch them. Should be called after script has been evaluated based on something else than context indication, e.g. timer event. Note that calling this from normal evaluation during context indication results in executing script actions multiple times when script is true.

ParseL(CCFOperationNode *, CMDXMLNode &)

CCFOperationNode *	ParseL	(	CCFOperationNode *	aParent,
			CMDXMLNode &	aNode
		)	[pure virtual]

Parses a xml node and returns a pointer to CCFOperationNode instance.

Parameters

CCFOperationNode * aParent	is the parsed parent node for the aNode.
CMDXMLNode & aNode	is the node to be parsed.

RemoveSubscription(MCFScriptListener *)

void

RemoveSubscription

(

MCFScriptListener *

aListener

)

[pure virtual]

Removes subscription from Context Framework, cancels indications of context events.

Parameters

MCFScriptListener * aListener

is a pointer to listener interface whose context subscription is cancelled.

RestoreL(const TDesC &, CCFOperationNode &)

void	RestoreL	(	const TDesC &	aFile,
			CCFOperationNode &	aOperation
		)	[pure virtual]

Restores operation data from a persistent file. If the file exists InternalizeL is called for the operation.

Parameters

const TDesC & aFile	is the persistent file containing operation data.
CCFOperationNode & aOperation	is the operation to be restored.

ScriptId()

TInt

ScriptId

(

)

const [pure virtual]

Gets id of the script providing operation services.

StoreL(const TDesC &, CCFOperationNode &)

void	StoreL	(	const TDesC &	aFile,
			CCFOperationNode &	aOperation
		)	[pure virtual]

Stores operation data into a persistent file. If the file exists the old data is replaced by calling ExternalizeL for the operation.

Parameters

const TDesC & aFile	is the persistent file for operation data.
CCFOperationNode & aOperation	is the operation to be stored.

SubscribeContextL(MCFScriptListener *)

void

SubscribeContextL

(

MCFScriptListener *

aListener

)

[pure virtual]

Adds subscription to Context Framework to get indications of context events.

Parameters

MCFScriptListener * aListener

is a pointer to listener interface that will be notified of the specified context events.