Execution (MINER Clientlib)

Object
- at.srfg.miner.clientlib.Execution

```
public class Execution
extends Object
```
A MINER Execution is created upon a request for execution and can then be used to control the running execution. It contains a start/stop date and a description. An Execution is created by scheduling a MINER Scenario using Scenario.schedule(java.util.Date) or Scenario.execute().
Example:
```
 Scenario scenario = new Scenario();
 // define all Scenario parameters
 // ...
 scenario.submit();
 Execution exec = scenario.run();
 
```

Method Summary

Methods
Modifier and Type	Method and Description
`List<Result>`	`allResults(ResultHandle handle)` Retrieves all result instances that are currently available for the given `handle`.
`Query`	`createQuery(ResultHandle handle)` Creates a new Query object.
`void`	`delete()` Deletes the execution and all its results at the MINER Core.
`String`	`getDescription()` Gets the description.
`int`	`getID()` Gets the ID that identifies the Execution at the MINER core.
`Executionlog`	`getLog()` Gets the execution log.
`int`	`getQueryLimit(ResultHandle handle)` Gets the query limit for a query of `handle`.
`Scenario`	`getScenario()` Gets the scenario of this execution.
`int`	`getScenarioId()` Gets the ID of the associated Scenario.
`Date`	`getStart()` Gets the start time.
`Date`	`getStop()` Gets the stop time.
`boolean`	`hasNextResults(ResultHandle handle)` Checks if there are results for `handle` that have not yet been retrieved.
`boolean`	`isFinished()` Checks if the execution has completely finished, i.e. at the MINER Core and all the involved ToolProxies.
`static Execution`	`load(int execId)` Loads an existing execution from the MINER core.
`List<Result>`	`nextResultBlock(ResultHandle handle)` Incrementally retrieves the next chunk of results for `handle` .
`List<Result>`	`nextResults(ResultHandle handle)` This is a convenience method that repeatedly invokes `nextResultBlock` as long as `hasNext` returns true.
`void`	`resetQuery(ResultHandle handle)` Resets the query for `handle` such that the internal result-pointer offset is set to 0.
`void`	`sendEvent(Event event)` Sends an event to the execution.
`void`	`setQueryLimit(ResultHandle handle, int limit)` Sets a limit for the maximum number of result instances that are retrieved per invocation of `nextResults` with this query.
`void`	`stop()` Stops the execution immediately.
`void`	`stop(int timeout)` Stops the execution immediately.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - load
```
public static Execution load(int execId)
                      throws at.srfg.miner.exception.MinerException
```
    Loads an existing execution from the MINER core.
    
    Parameters:
    execId - the execution identifier
    
    Returns:
    an Execution object or null of no such Execution exists
    
    Throws:
    
    at.srfg.miner.exception.MinerException
    Since:
    
    3.1.0
  - getScenario
```
public Scenario getScenario()
```
    Gets the scenario of this execution.
    
    Returns:
    the scenario
  - getID
```
public int getID()
```
    Gets the ID that identifies the Execution at the MINER core.
    
    Returns:
    the id
  - getScenarioId
```
public int getScenarioId()
```
    Gets the ID of the associated Scenario.
    
    Returns:
    the scenarioId
  - getDescription
```
public String getDescription()
```
    Gets the description.
    
    Returns:
    the description
  - getStart
```
public Date getStart()
```
    Gets the start time.
    
    Returns:
    the start time
  - getStop
```
public Date getStop()
```
    Gets the stop time.
    
    Returns:
    the stop time
  - stop
```
public void stop()
          throws at.srfg.miner.exception.MinerException
```
    Stops the execution immediately. The method blocks until the execution is completely finished at the MINER Core, i.e. until isFinished returns true.
    
    Throws:
    
    at.srfg.miner.exception.MinerException - If no connection to the webservice can be achieved or if the stop implementation at the MINER Core throws an exception.
  - stop
```
public void stop(int timeout)
          throws at.srfg.miner.exception.MinerException
```
    Stops the execution immediately. The method blocks until either the execution is completely finished at the MINER Core, i.e. until isFinished returns true or the timeout is reached.
    
    Parameters:
    timeout - the maximum number of seconds to wait for isFinished to become true. A value of 0 means that no wait is performed.
    
    Throws:
    
    at.srfg.miner.exception.MinerException - If no connection to the webservice can be achieved or if the stop implementation at the MINER Core throws an exception.
    Since:
    
    3.1.0
  - getLog
```
public Executionlog getLog()
                    throws at.srfg.miner.exception.MinerException
```
    Gets the execution log.
    
    Returns:
    The log entries that were recorded for the execution.
    
    Throws:
    
    at.srfg.miner.exception.MinerException
    Since:
    
    3.0.0
  - isFinished
```
public boolean isFinished()
                   throws at.srfg.miner.exception.MinerException
```
    Checks if the execution has completely finished, i.e. at the MINER Core and all the involved ToolProxies.
    
    Returns:
    true if completely finished, false otherwise.
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - delete
```
public void delete()
            throws at.srfg.miner.exception.MinerException
```
    Deletes the execution and all its results at the MINER Core.
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - createQuery
```
public Query createQuery(ResultHandle handle)
```
    Creates a new Query object. Use this method if you prefer to work with the Query object directly. Otherwise, use the various methods (like hasNextResults, nextResults, allNextResults etc.) of this execution to work with results.
    
    Parameters:
    handle - the result handle
    
    Returns:
    a new Query instance
  - resetQuery
```
public void resetQuery(ResultHandle handle)
```
    Resets the query for handle such that the internal result-pointer offset is set to 0. Thus, the next invocation of hasNextResults and nextResults will look at the very first result, not the next result since the last invocation of nextResults. The limit parameter of query is not affected.
    
    Parameters:
    handle - the result handle
  - setQueryLimit
```
public void setQueryLimit(ResultHandle handle,
                 int limit)
```
    Sets a limit for the maximum number of result instances that are retrieved per invocation of nextResults with this query.
    
    Parameters:
    handle - the result handle
    limit - the query limit
  - getQueryLimit
```
public int getQueryLimit(ResultHandle handle)
```
    Gets the query limit for a query of handle. Note that this does not get the limit which my be imposed by the server (and which overrides any query limit by a client).
    
    Parameters:
    handle - the result handle
    
    Returns:
    the limit of this query
  - hasNextResults
```
public boolean hasNextResults(ResultHandle handle)
                       throws at.srfg.miner.exception.MinerException
```
    Checks if there are results for handle that have not yet been retrieved.
    
    Returns:
    true if more results are available, false otherwise.
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - nextResultBlock
```
public List<Result> nextResultBlock(ResultHandle handle)
                             throws at.srfg.miner.exception.MinerException
```
    Incrementally retrieves the next chunk of results for handle . Note that there are possibly more results available than returned by the method. This can happen if the server imposed limit or the limit set by the user (see setLimit) is smaller than the number of results that became available since the last invocation of nextResults.
    
    Returns:
    An unsorted list of new results, possibly limited by a local or server imposed limit. If there aren't any, an empty list is returned (but never null).
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - nextResults
```
public List<Result> nextResults(ResultHandle handle)
                         throws at.srfg.miner.exception.MinerException
```
    This is a convenience method that repeatedly invokes nextResultBlock as long as hasNext returns true. It thus retrieves all results that became available since the last result query, even if the number is higher than a local or server imposed limit.
    WARNING: if there are many new results at the server, this call may lead to a heap space problem!
    
    Returns:
    An unsorted list of all new results. If there aren't any, an empty list is returned (but never null).
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - allResults
```
public List<Result> allResults(ResultHandle handle)
                        throws at.srfg.miner.exception.MinerException
```
    Retrieves all result instances that are currently available for the given handle. This query has no side-effect (in neither direction) on any (previous/parallel/subsequent) incremental result retrievals on handle (e.g. via nextResultBlock, nextResults, etc.).
    
    Parameters:
    handle - the result handle
    
    Returns:
    An unsorted list of all results. If there aren't any, an empty list is returned (but never null).
    
    Throws:
    
    at.srfg.miner.exception.MinerException
  - sendEvent
```
public void sendEvent(Event event)
               throws at.srfg.miner.exception.MinerException
```
    Sends an event to the execution.
    
    Parameters:
    event - the event
    
    Throws:
    
    at.srfg.miner.exception.MinerException
    Since:
    
    3.0.0

Class Execution

Method Summary

Methods inherited from class Object

Method Detail

load

getScenario

getID

getScenarioId

getDescription

getStart

getStop

stop

stop

getLog

isFinished

delete

createQuery

resetQuery

setQueryLimit

getQueryLimit

hasNextResults

nextResultBlock

nextResults

allResults

sendEvent