Summer.Batch.Core.Converter.IJobParametersConverter Interface Reference

A factory for JobParameters instances. A job can be executed with many possible runtime parameters, which identify the instance of the job. This converter allows job parameters to be converted to and from Properties. More...

Inheritance diagram for Summer.Batch.Core.Converter.IJobParametersConverter:
Summer.Batch.Core.Converter.DefaultJobParametersConverter

Public Member Functions

JobParameters GetJobParameters (NameValueCollection properties)
 Get a new JobParameters instance. If given null, or an empty properties, an empty JobParameters will be returned. More...
 
NameValueCollection GetProperties (JobParameters parms)
 The inverse operation: get a Properties instance. If given null or empty JobParameters, an empty Properties should be returned. More...
 

Detailed Description

A factory for JobParameters instances. A job can be executed with many possible runtime parameters, which identify the instance of the job. This converter allows job parameters to be converted to and from Properties.

Member Function Documentation

JobParameters Summer.Batch.Core.Converter.IJobParametersConverter.GetJobParameters ( NameValueCollection  properties)

Get a new JobParameters instance. If given null, or an empty properties, an empty JobParameters will be returned.

Parameters
propertiesthe runtime parameters in the form of String literals.
Returns
a JobParameters properties converted to the correct types.

Implemented in Summer.Batch.Core.Converter.DefaultJobParametersConverter.

NameValueCollection Summer.Batch.Core.Converter.IJobParametersConverter.GetProperties ( JobParameters  parms)

The inverse operation: get a Properties instance. If given null or empty JobParameters, an empty Properties should be returned.

Parameters
parms
Returns
a representation of the parameters as properties

Implemented in Summer.Batch.Core.Converter.DefaultJobParametersConverter.


The documentation for this interface was generated from the following file:
  • Summer.Batch.Core/Core/Converter/IJobParametersConverter.cs