com.sas.hls.job
Class ScheduleJobInfo

java.lang.Object
  extended by com.sas.hls.job.ScheduleJobInfo
All Implemented Interfaces:
Schedulable, Serializable

public class ScheduleJobInfo
extends Object
implements Schedulable, Serializable

ScheduleJobInfo is used for scheduling jobs. This class contains the job descriptor and parameter information.

See Also:
Serialized Form

Constructor Summary
ScheduleJobInfo()
          Zero-arg ScheduleJobInfo constructor
ScheduleJobInfo(JobDescriptor job)
           
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 JobDescriptor getJob()
          Get the light-weight representation of the job to run
 String getLabel()
          Get label which describes the item being scheduled.
 Set<ParameterValue> getParamValues()
          Get the job parameterValues.
 int hashCode()
          Return a hash code value for the object.
 void setJob(JobDescriptor job)
          Set the light-weight representation of the job to run
 void setParamValues(Set<ParameterValue> paramValues)
          Sets the job parameterValues.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScheduleJobInfo

public ScheduleJobInfo()
Zero-arg ScheduleJobInfo constructor


ScheduleJobInfo

public ScheduleJobInfo(JobDescriptor job)
Parameters:
job -
Method Detail

getParamValues

public Set<ParameterValue> getParamValues()
Get the job parameterValues. The parameterValues will override the default value of the JobParameters defined within the job. For parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values of CHARACTER and NUMERIC parameters should be specified as Strings. Values of DATE parameter type should be specified as java.util.Date. If no parameter values are specified, the default values defined in the job will be used.

Returns:
Returns the paramValues.

setParamValues

public void setParamValues(Set<ParameterValue> paramValues)
Sets the job parameterValues. The parameterValues will override the default value of the JobParameters defined within the job. For parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values of CHARACTER and NUMERIC parameters should be specified as Strings. Values of DATE parameter type should be specified as java.util.Date. If no parameter values are specified, the default values defined in the job will be used.

Parameters:
paramValues - The paramValues to set.

getJob

public JobDescriptor getJob()
Get the light-weight representation of the job to run

Returns:
Returns the job.

setJob

public void setJob(JobDescriptor job)
Set the light-weight representation of the job to run

Parameters:
job - The job to set.

getLabel

public String getLabel()
Description copied from interface: Schedulable
Get label which describes the item being scheduled. To be used only for display purposes.

Specified by:
getLabel in interface Schedulable
Returns:
The label of the item being scheduled.

hashCode

public int hashCode()
Return a hash code value for the object.

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)


Copyright (c) 2012, SAS Institute Inc., Cary, NC, USA