public interface JobContext
Parent of JobInitContext
, JobProcessContext
and JobCompleteContext
that can be passed to a
Job
.
Modifier and Type | Method and Description |
---|---|
String |
getJobId()
Retrieves the ID tracking this job.
|
<T extends JobValue> |
getJobInitParameter(String name,
Class<T> returnType)
Retrieves job parameters that are set on
Job.init(JobInitContext) . |
<T> T |
getJobInitParameter(String name,
JobValueType<T> valueType)
Retrieves job parameters set by
JobInitContext.setJobInitParameter(String, Object) . |
JobLogger |
getJobLogger()
Retrieves the job logger, used to log messages into the job log file.
|
<T extends JobParamValue> |
getJobParameter(String name,
Class<T> returnType)
Retrieves job parameters set on
JobParameters when invoking a job through
JobService . |
<T> T |
getJobParameter(String name,
JobParamValueType<T> valueType)
Retrieves job parameters set on
JobParameters when invoking a job through
JobService . |
String getJobId()
JobLogger getJobLogger()
<T> T getJobParameter(String name, JobParamValueType<T> valueType)
JobParameters
when invoking a job through
JobService
.T
- type of object requested. Cannot be null.name
- the parameter name used when setting a job parameter. Cannot be null.valueType
- The type of value returned from the job parameters. Cannot be null.<T extends JobParamValue> T getJobParameter(String name, Class<T> returnType)
JobParameters
when invoking a job through
JobService
.T
- type of object requested. Cannot be null.name
- the parameter name used when setting a job parameter. Cannot be null.returnType
- type of object requested. Cannot be null.<T> T getJobInitParameter(String name, JobValueType<T> valueType)
JobInitContext.setJobInitParameter(String, Object)
.T
- type of object requested. Cannot be null.name
- the parameter name used when setting the param in Job#init. Cannot be null.valueType
- the type of value returned from the job parameters. Cannot be null.<T extends JobValue> T getJobInitParameter(String name, Class<T> returnType)
Job.init(JobInitContext)
.T
- type of object requested. Cannot be null.name
- the parameter name used when setting the param in Job#init. Cannot be null.returnType
- type of object requested. Cannot be null.Copyright © Veeva Systems 2017–2021. All rights reserved.