StartProcessTimedConfig
Configuration object for timed process executions.
Methods
getIdentifier
getIdentifier():
string
Returns the identifier of the process.
Returns
stringthe identifier as String
getInterval
getInterval():
number
Returns the interval in which the process is to be executed.
Returns
numberthe internal as long in milliseconds
getIntervalUnit
getIntervalUnit():
number
Returns the unit of the interval of the process.
Returns
numberthe unit as int (see INTERVAL_UNIT_*)
getLocalVariables
getLocalVariables():
any
Returns the set local variables for the process execution.
Returns
anya map with variables (key, value only string) or null if not set.
getName
getName():
string
Returns the set name of the process to be executed.
Returns
stringthe name of the process
getProcessDescription
getProcessDescription():
string
Returns the process description.
Returns
stringthe process description as String
getServersToExcecuteOn
getServersToExcecuteOn():
string[]
Contains all user-defined servers on which the process is to be executed. If no explicit server list has been specified, the server ID of this server is always added automatically.
Returns
string[]list of servers the process will be executed on.
getShouldKeepJdito
getShouldKeepJdito():
boolean
Returns if the JDito instance should be reused.
Returns
booleantrue if the JDito instance should be reused.
getShouldRunImmediately
getShouldRunImmediately():
boolean
Returns if the process should be run immediately.
Returns
booleantrue if the process should be run immediately.
getShouldShowErrorDialog
getShouldShowErrorDialog():
boolean
Return the flag if an error dialog is to be shown.
Returns
booleantrue if the dialog is to be shown
getStartDate
getStartDate():
Date
Returns the start date of the first planned process execution.
Returns
Datethe date
getThreadPriority
getThreadPriority():
number
Returns the thread priority.
Returns
numberthe thread priority as int
getTimerType
getTimerType():
number
Returns the timer type of the process.
Returns
numberthe timer type as int (see process.TIMERTYPE_*)
getTimezone
getTimezone():
string
Returns the Timezone of the first planned process execution.
Returns
stringthe Timezone
getUser
getUser():
string
Returns the title of the user under whom the process is executed.
Returns
stringthe user title
setIdentifier
setIdentifier(
pIdentifier):StartProcessTimedConfig
Sets the unique id of the timer.
Parameters
string | number | booleanthe id
Returns
StartProcessTimedConfigsetInterval
setInterval(
pInterval):StartProcessTimedConfig
The interval, in milliseconds, in which the process is to be executed.
Parameters
numberReturns
StartProcessTimedConfigStartProcessTimedConfig
setIntervalUnit
setIntervalUnit(
pTimeIntervalUnit):StartProcessTimedConfig
Sets the unit for the interval of the process.
Parameters
numberthe unit of the process interval (see INTERVAL_UNIT_*)
Returns
StartProcessTimedConfigStartProcessTimedConfig
setKeepJdito
setKeepJdito(
pKeepJDito):StartProcessTimedConfig
Sets if the JDito instance should be reused. 'true' will create a JDito instance only once and then re-use it again and again (for server processes).
Parameters
booleanReturns
StartProcessTimedConfigStartProcessTimedConfig
setLocalVariables
setLocalVariables(
pLocalVariables):StartProcessTimedConfig
Sets the local variables that are passed to the process during execution.
Parameters
anyA map with variables (key, value only string) that are passed to the process as $local variables. The name of the corresponding variable in the process is then $local.[key]. null if you do not want to pass variables.
Returns
StartProcessTimedConfigStartProcessTimedConfig
setName
setName(
pProcessName):StartProcessTimedConfig
Sets the name of the process to be executed.
Parameters
string | number | booleanthe process name
Returns
StartProcessTimedConfigStartProcessTimedConfig
setProcessDescription
setProcessDescription(
pProcessDescription):StartProcessTimedConfig
Sets the process description.
Parameters
string | number | booleanthe process description as String
Returns
StartProcessTimedConfigStartProcessTimedConfig
setRunImmediately
setRunImmediately(
pShouldRunImmediately):StartProcessTimedConfig
Sets if the process should be run immediately. If 'true', the process will be run once immediately after starting the timer.
Parameters
booleanReturns
StartProcessTimedConfigStartProcessTimedConfig
setServersToExcecuteOn
setServersToExcecuteOn(
pServerList):StartProcessTimedConfig
Sets the servers on which the process is to be executed. If no explicit server list has been specified, the server ID of this server is always added automatically.
Parameters
string[]list of servers the process will be executed on.
Returns
StartProcessTimedConfigStartProcessTimedConfig
setShowErrorDialog
setShowErrorDialog(
pShowErrorDialog):StartProcessTimedConfig
Sets the flag if an error dialog is to be shown. "true" shows an error message if an error occurs (if possible, only if TIMERTYPE_CLIENT_RUN).
Parameters
booleantrue if an error dialog is to be shown in case of an error
Returns
StartProcessTimedConfigStartProcessTimedConfig
setStartDate
setStartDate(
pStartDate):StartProcessTimedConfig
Sets the start date of the first planned process execution.
Parameters
Datethe date
Returns
StartProcessTimedConfigStartProcessTimedConfig
setThreadPriority
setThreadPriority(
pThreadPriority):StartProcessTimedConfig
Sets the priority of the thread: process.THREADPRIORITY_*.
Parameters
numberReturns
StartProcessTimedConfigsetTimerType
setTimerType(
pTimerType):StartProcessTimedConfig
Sets the timer type, see process.TIMERTYPE_*.
Parameters
numberReturns
StartProcessTimedConfigStartProcessTimedConfig
setTimezone
setTimezone(
pTimezone):StartProcessTimedConfig
Sets the Timezone of the first planned process execution.
Parameters
string | number | booleanthe Timezone
Returns
StartProcessTimedConfigStartProcessTimedConfig
setUser
setUser(
pUser):StartProcessTimedConfig
Sets the user title of the user under whom the process will be executed. 'Null' for anonymous. Not for TIMERTYPE_CLIENT_RUN.
Parameters
string | number | booleanReturns
StartProcessTimedConfig