Initializing help system before first use

ExecutionMode

An ExecutionMode represents the various ways of executing a model. Two modes, named LOAD and RUN, are defined for all apps, but others can be specified as part of the model. The name of an execution mode may optionally passed to ScenarioProperties#execute to specify how the execution is to take place.

Method summary

name description
clearsInputData Whether use of this execution mode will cause input data to be cleared. The LOAD execution mode has this property set.
getDescription Descriptive text about the execution mode.
getName Name of the execution mode.
getNumberOfThreads Returns either a number representing a positive integer (denoting the number of threads this execution mode is limited to), or undefined (denoting no limit at all). This representation means that the result of this method can be used in a conditional expression to test if there is a thread limit; and further, if there is no limit, use of it in an arithmetic expression will treat it as if it were NaN.
sendsProgress Check whether the execution mode sends progress updates. This is only supported in Insight 5, it will always return false when running in Insight 4.

Constructor

new ExecutionMode ( data )

Creates an Execution mode. The constructor should not be invoked directly, instances can be obtained via App#getExecutionModes.

Parameters:
Name Type Description
data Payload data for execution mode

Methods

clearsInputData ( ) → {boolean}

Whether use of this execution mode will cause input data to be cleared. The LOAD execution mode has this property set.

Returns:
Type Description
boolean
Back to Top
getDescription ( ) → {string}

Descriptive text about the execution mode.

Returns:
Type Description
string
Back to Top
getName ( ) → {string}

Name of the execution mode.

Returns:
Type Description
string
Back to Top
getNumberOfThreads ( ) → {number|undefined}

Returns either a number representing a positive integer (denoting the number of threads this execution mode is limited to), or undefined (denoting no limit at all).

This representation means that the result of this method can be used in a conditional expression to test if there is a thread limit; and further, if there is no limit, use of it in an arithmetic expression will treat it as if it were NaN.

Returns:
Type Description
number | undefined
Back to Top
sendsProgress ( ) → {boolean}

Check whether the execution mode sends progress updates. This is only supported in Insight 5, it will always return false when running in Insight 4.

Returns:
Type Description
boolean
Back to Top
Parent Topic Classes

© 2001-2024 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.