com.veeva.vault.sdk.api.job

Interface JobParameters

public interface JobParameters

Provides methods to set values for job parameters.

Method Summary

Modifier and Type	Method and Description
String	getJobName() Gets the name of the job specified in a JobParameters object.
void	setJobRunTime(ZonedDateTime startTime) Sets the job start time.
void	setValue(String name, Object value) Sets the value of a job parameter.

Method Detail

setValue

void setValue(String name,
              Object value)

Sets the value of a job parameter. When this method is called, certain jobs specified in the name parameter may require the value parameter to be a specific data type.

Parameters:

name - name of the job parameter

value - new value to set on the job parameter

getJobName

String getJobName()

Gets the name of the job specified in a JobParameters object. The job name is set by JobService.newJobParameters(String).

Returns:

name of the job specified in a JobParameters object

setJobRunTime

void setJobRunTime(ZonedDateTime startTime)

Sets the job start time. If unspecified or less than 60 seconds, the job will run immediately.

Parameters:

startTime - specifies the job start time