org.eclipse.hyades.execution.core
Interface IExecutionEnvironment

All Superinterfaces:
IExecutionComponent

public interface IExecutionEnvironment
extends IExecutionComponent

IExecutionEnvironment is a specialized IExecutionComponent that has knowledge about the environment that the IExecutionComponent's and its children reside within.

Version:
0.0.2

Method Summary
 void addEnv(IOrderedProperty env)
          Add a property from the currently set environment
 IExecutor createExecutor(String name)
          Creates an IExecutor object specific to this type of execution environment.
 IOrderedProperty[] getEnv()
          Get the entire environment as it is currently set.
 IOrderedProperty removeProperty(String name)
          Remove a property from the currently set environment
 void setEnv(IOrderedProperty[] env)
          Set the entire environment, overwriting an existing properties.
 
Methods inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
addChild, createChild, getChildById, getChildByName, getChildren, getChildren, getChildren, getId, getName, getNode, getParent, getType, getVersion, isDead, isInactive, isReady, isSuspended
 

Method Detail

getEnv

public IOrderedProperty[] getEnv()
                          throws ExecutionComponentStateException
Get the entire environment as it is currently set.
Returns:
an array of IOrderedProperty objects
Throws:
ExecutionComponentStateException -  

setEnv

public void setEnv(IOrderedProperty[] env)
            throws ExecutionComponentStateException
Set the entire environment, overwriting an existing properties.
Parameters:
env - An array of IOrderedProperty objects to set the environment
Throws:
ExecutionComponentStateException -  

addEnv

public void addEnv(IOrderedProperty env)
            throws ExecutionComponentStateException
Add a property from the currently set environment
Parameters:
env - The property to add
Throws:
ExecutionComponentStateException -  

removeProperty

public IOrderedProperty removeProperty(String name)
                                throws ExecutionComponentStateException
Remove a property from the currently set environment
Parameters:
name - The name of the property to remove
Throws:
ExecutionComponentStateException -  

createExecutor

public IExecutor createExecutor(String name)
                         throws ExecutionComponentStateException
Creates an IExecutor object specific to this type of execution environment. The IExecutor object can be used to execute something within this IExecutionEnvironment.
Parameters:
name - The name to be assigned to the IExecutor object.
Returns:
an IExecutor object
Throws:
ExecutionComponentStateException - If the IExecutionEnvironment is dead or inactive