Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

ExecutionSessionContext Class Reference

This class is used to give context to all the command being executed within the context of an ExecutionSession. More...

List of all members.


Public Methods

 ExecutionSessionContext ()
 Constructor for the Execution Session Context object.

virtual ~ExecutionSessionContext ()
 Destructor for the Execution Session Context object.

void setEnvironment (const char *name, const char *value) throw (SoamException)
 Sets an environment variable (i.e a name/value string pair) within the context of a session.

void setPreCommand (const char *command) throw (SoamException)
 Sets the command string to be pre-executed at the session level.

void setPostCommand (const char *command) throw (SoamException)
 Sets the command string to be post-executed at the session level.

void setSessionType (const char *type) throw (SoamException)
 Sets the execution session type The session type argument tells Symphony which type of session to create.


Detailed Description

This class is used to give context to all the command being executed within the context of an ExecutionSession.

This class may be used in one of the more advanced forms of the ExecutionSession(...) constructor.

See also:
ExecutionSession


Constructor & Destructor Documentation

ExecutionSessionContext  
 

Constructor for the Execution Session Context object.

virtual ~ExecutionSessionContext   [virtual]
 

Destructor for the Execution Session Context object.


Member Function Documentation

void setEnvironment const char *    name,
const char *    value
throw (SoamException)
 

Sets an environment variable (i.e a name/value string pair) within the context of a session.

Parameters:
name  The name of the environment variable being set.
value  The value to be assigned to this environment variable.
Exceptions:
SoamException 

void setPreCommand const char *    command throw (SoamException)
 

Sets the command string to be pre-executed at the session level.

Parameters:
command  The command string to be executed at the session level when the session is being bound. A null value will be treated as an empty string.
Exceptions:
SoamException 

void setPostCommand const char *    command throw (SoamException)
 

Sets the command string to be post-executed at the session level.

Parameters:
command  The command string to be executed at the session level when the session is being un-bound. A null value will be treated as an empty string.
Exceptions:
SoamException 

void setSessionType const char *    type throw (SoamException)
 

Sets the execution session type The session type argument tells Symphony which type of session to create.

In the application profile, you can define different types of sessions with different attributes. For this argument, specify the name of the session type you would like to use.

Parameters:
type  The type of execution session set before creating a session.
Exceptions:
SoamException 


     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2008 Platform Computing Corporation. All rights reserved.