SCHED_Base
Class · Group: Schedulables
Learn it: Fast Start - Scheduled Jobs and Async Processing guide
global abstract inherited sharing class SCHED_Base implements IF_SchedulableImplements: IF_Schedulable
Known Derived Types: SCHED_ChainWatchdog, SCHED_DeactivateUsers, SCHED_JobRunner, SCHED_OutboundRetryWatchdog, SCHED_PurgeRecords, IF_Schedulable.getParameterDefinitions(), IF_Schedulable.setParameterValues(DTO_NameValues)
Abstract base class for scheduled jobs that support configurable parameters. Implements IF_Schedulable, providing parameter storage, typed parameter resolution, and a default empty parameter definition list. You extend this class, override getParameterDefinitions() to declare your parameters, and implement execute(SchedulableContext) for job logic. When setParameterValues() is called by the framework, the base class resolves raw string values into typed values (String, Integer, Boolean) based on the DataType declared in getParameterDefinitions(), applying default values where configured. Subclasses read typed values via getTextParameter(), getNumericParameter(), and getBooleanParameter().
Example
global class SCHED_MyJob extends SCHED_Base
{
public override List<DTO_ScheduledParameterDefinition> getParameterDefinitions()
{
return new List<DTO_ScheduledParameterDefinition>
{
DTO_ScheduledParameterDefinition.of('objectName').required(),
DTO_ScheduledParameterDefinition.of('batchSize').asNumeric().withDefault('2000')
};
}
public void execute(SchedulableContext context)
{
String objectName = getTextParameter('objectName');
Integer batchSize = getNumericParameter('batchSize');
}
}See Also: DTO_NameValues, DTO_ScheduledParameterDefinition, IF_Schedulable
Methods
| Method | Description |
|---|---|
| global Boolean getBooleanParameter(String name) | Returns a FLAG (boolean) parameter value. |
| global Integer getNumericParameter(String name) | Reads a NUMERIC parameter declared in getParameterDefinitions, from the job's saved settings or from its default when the settings have no entry. |
| global virtual List<DTO_ScheduledParameterDefinition> getParameterDefinitions() | Returns the parameter definitions supported by this scheduled job. |
| global String getTextParameter(String name) | Reads a parameter declared in getParameterDefinitions, from the job's saved settings or from its default when the settings have no entry. |
| global void setParameterValues(DTO_NameValues parameterValues) | Stores the provided parameter values. |
getBooleanParameter
global Boolean getBooleanParameter(String name)Returns a FLAG (boolean) parameter value.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | String | The parameter name. |
Returns Boolean — The boolean value, defaulting to false if not set.
getNumericParameter
global Integer getNumericParameter(String name)Reads a NUMERIC parameter declared in getParameterDefinitions, from the job's saved settings or from its default when the settings have no entry. The saved text is turned into a whole number; text that is not made of digits only, such as a negative number or a decimal, gives null.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | String | The parameter name. |
Returns Integer — The integer value, or null if not set or not numeric.
getParameterDefinitions
global virtual List<DTO_ScheduledParameterDefinition> getParameterDefinitions()Returns the parameter definitions supported by this scheduled job. Override in subclasses to declare parameters for dynamic form rendering. Returns an empty list by default.
Returns DTO_ScheduledParameterDefinition — List of parameter definitions.
Example
public override List<DTO_ScheduledParameterDefinition> getParameterDefinitions()
{
return new List<DTO_ScheduledParameterDefinition>
{
DTO_ScheduledParameterDefinition.of('batchSize').asNumeric()
.withDefault('2000')
};
}getTextParameter
global String getTextParameter(String name)Reads a parameter declared in getParameterDefinitions, from the job's saved settings or from its default when the settings have no entry. Use it only for a TEXT parameter. A NUMERIC or FLAG parameter that has a value throws a TypeException here; read those with getNumericParameter and getBooleanParameter.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | String | The parameter name. |
Returns String — The string value, or null if not set.
setParameterValues
global void setParameterValues(DTO_NameValues parameterValues)Stores the provided parameter values. The property setter automatically resolves raw values into typed parameters.
Parameters
| Parameter | Type | Description |
|---|---|---|
parameterValues | DTO_NameValues | The name-value pairs containing the resolved parameter values. |