Initializing help system before first use

# ScenarioSummaryData

### Method summary

name | description
--- | ---
getExecutionDuration | The time taken to last execute or load this scenario.
getExecutionFinishedDate | The finished date and time of the latest scenario execution.
getExecutionMode | Get the execution mode for the latest scenario execution. This property is only available on Insight 5, it will always return undefined in Insight 4.
getExecutionStartedDate | The started date and time of the latest scenario execution. This property is only available on Insight 5, it will always return undefined in Insight 4.
getExecutionUserId | Get the id of the user that submitted the latest scenario execution. You can use this id to look-up the user record from the App object. This property is only available on Insight 5, it will always return undefined in Insight 4.
getGap | The Gap value for this scenario.
getModelStatus | The status of the Insight model.
getNumberOfSolutions | The number of solutions found while executing this scenario.
getObjective | The Objective value for this scenario.
getProblemStatus | The Problem Status of this scenario.
getState | The state of the scenario data.
hasResultData | Indicates whether this scenario has result data. State of the scenario data is also available on ScenarioSummaryData#getState.
isDirty | Indicates whether the result data is dirty. State of the scenario data is also available on ScenarioSummaryData#getState.
isLoaded | Indicates whether this scenario is loaded with input data. State of the scenario data is also available on ScenarioSummaryData#getState.
isReservedForJob | Check whether this scenario is reserved for execution. Either queued, executing or completing. This property is only available on Insight 5, it will always return undefined in Insight 4.

### Methods

getExecutionDuration ( ) → {number}

  The time taken to last execute or load this scenario.

  Returns:

  Type | Description
  --- | ---
  number | The time taken to last execute or load this scenario, or undefined if the scenario has not been loaded or executed

  Back to Top
getExecutionFinishedDate ( ) → {Date|undefined}

  The finished date and time of the latest scenario execution.

  Returns:

  Type | Description
  --- | ---
  Date | undefined | The finished date, or undefined if it has not been loaded or executed

  Back to Top
getExecutionMode ( ) → {ExecutionMode|undefined}

  Get the execution mode for the latest scenario execution. This property is only available on Insight 5, it will always return undefined in Insight 4.

  Returns:

  Type | Description
  --- | ---
  ExecutionMode | undefined | The execution mode object, or undefined if it has not been loaded or executed

  Back to Top
getExecutionStartedDate ( ) → {Date|undefined}

  The started date and time of the latest scenario execution. This property is only available on Insight 5, it will always return undefined in Insight 4.

  Returns:

  Type | Description
  --- | ---
  Date | undefined | The started date, or undefined if it has not been loaded or executed

  Back to Top
getExecutionUserId ( ) → {string|undefined}

  Get the id of the user that submitted the latest scenario execution. You can use this id to look-up the user record from the App object. This property is only available on Insight 5, it will always return undefined in Insight 4.

  Returns:

  Type | Description
  --- | ---
  string | undefined | The id of the user who submitted the scenario execution, or undefined if it has not been loaded or executed

  Back to Top
getGap ( ) → {number}

  The Gap value for this scenario.

  Returns:

  Type | Description
  --- | ---
  number | The Gap value for this scenario, or undefined if the scenario has no results data

  Back to Top
getModelStatus ( ) → {insight.enums.ModelStatus}

  The status of the Insight model.

  Returns:

  Type | Description
  --- | ---
  insight.enums.ModelStatus | The status of the Insight model

  Back to Top
getNumberOfSolutions ( ) → {number}

  The number of solutions found while executing this scenario.

  Returns:

  Type | Description
  --- | ---
  number | The number of solutions found while executing this scenario, or undefined if the scenario has no results data

  Back to Top
getObjective ( ) → {number}

  The Objective value for this scenario.

  Returns:

  Type | Description
  --- | ---
  number | The Objective value for this scenario, or undefined if the scenario has no results data

  Back to Top
getProblemStatus ( ) → {insight.enums.ProblemStatus}

  The Problem Status of this scenario.

  N.B. This returns the enumerated value for problem status (e.g. OPT). This should be translated to a human readable form.

  Returns:

  Type | Description
  --- | ---
  insight.enums.ProblemStatus | The Problem Status of this scenario, or undefined if the scenario has no results data

  Back to Top
getState ( ) → {insight.enums.ScenarioDataStatus}

  The state of the scenario data.

  Returns:

  Type | Description
  --- | ---
  insight.enums.ScenarioDataStatus | The state of the scenario data.

  Back to Top
hasResultData ( ) → {boolean}

  Indicates whether this scenario has result data. State of the scenario data is also available on ScenarioSummaryData#getState.

  Returns:

  Type | Description
  --- | ---
  boolean | True if this scenario has result data, otherwise false

  Back to Top
isDirty ( ) → {boolean}

  Indicates whether the result data is dirty, i.e. the input data has been modified since the scenario was last executed and the scenario is configured not to remove the result data when the input data is modified. State of the scenario data is also available on ScenarioSummaryData#getState.

  Returns:

  Type | Description
  --- | ---
  boolean | True if the result data is dirty, otherwise false

  Back to Top
isLoaded ( ) → {boolean}

  Indicates whether this scenario is loaded with input data. State of the scenario data is also available on ScenarioSummaryData#getState.

  Returns:

  Type | Description
  --- | ---
  boolean | True if this scenario is loaded with input data, otherwise false.

  Back to Top
isReservedForJob ( ) → {boolean|undefined}

  Check whether this scenario is reserved for execution. Either queued, executing or completing. This property is only available on Insight 5, it will always return undefined in Insight 4.

  Returns:

  Type | Description
  --- | ---
  boolean | undefined | Whether the scenario is reserved for execution, or undefined if running on Insight 4

  Back to Top

Parent Topic Classes

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.