Summer.Batch.Core.JobParameter Class Reference

Domain representation of a parameter to a batch job. Only the following types can be parameters: String, Long, Date, and Double. The identifying flag is used to indicate if the parameter is to be used as part of the identification of a job instance. as org.springframework.batch.core.JobParameter More...

Public Types

enum  ParameterType { ParameterType.String, ParameterType.Date, ParameterType.Long, ParameterType.Double }
 Enumeration representing the type of a JobParameter. More...
 

Public Member Functions

 JobParameter (string parameter, bool identifying)
 Constructor using a parameter and flag to tell if the given parameter is identifying. More...
 
 JobParameter (long parameter, bool identifying)
 Alternative constructor for a long parameter. More...
 
 JobParameter (DateTime?parameter, bool identifying)
 Alternative constructor for a DateTime parameter. More...
 
 JobParameter (double parameter, bool identifying)
 Alternative constructor for a double parameter. More...
 
 JobParameter (String parameter)
 Constructor with a string parameter. More...
 
 JobParameter (long parameter)
 Alternative constructor with a long parameter. More...
 
 JobParameter (DateTime parameter)
 Alternative constructor with a DateTime parameter. More...
 
 JobParameter (double parameter)
 Alternative constructor with a double parameter. More...
 
override bool Equals (Object obj)
 Equals override. More...
 
override string ToString ()
 ToString override. More...
 
override int GetHashCode ()
 GetHashCode override. More...
 

Properties

object Value [get]
 Parameter value getter. More...
 
ParameterType Type [get]
 Parameter type getter. More...
 
bool Identifying [get]
 Identifying flag. More...
 

Detailed Description

Domain representation of a parameter to a batch job. Only the following types can be parameters: String, Long, Date, and Double. The identifying flag is used to indicate if the parameter is to be used as part of the identification of a job instance. as org.springframework.batch.core.JobParameter

Member Enumeration Documentation

Enumeration representing the type of a JobParameter.

Enumerator
String 

String enum litteral

Date 

Date enum litteral

Long 

Long enum litteral

Double 

Double enum litteral

Constructor & Destructor Documentation

Summer.Batch.Core.JobParameter.JobParameter ( string  parameter,
bool  identifying 
)

Constructor using a parameter and flag to tell if the given parameter is identifying.

Parameters
parameter
identifying
Summer.Batch.Core.JobParameter.JobParameter ( long  parameter,
bool  identifying 
)

Alternative constructor for a long parameter.

Parameters
parameter
identifying
Summer.Batch.Core.JobParameter.JobParameter ( DateTime?  parameter,
bool  identifying 
)

Alternative constructor for a DateTime parameter.

Parameters
parameter
identifying
Summer.Batch.Core.JobParameter.JobParameter ( double  parameter,
bool  identifying 
)

Alternative constructor for a double parameter.

Parameters
parameter
identifying
Summer.Batch.Core.JobParameter.JobParameter ( String  parameter)

Constructor with a string parameter.

Parameters
parameter
Summer.Batch.Core.JobParameter.JobParameter ( long  parameter)

Alternative constructor with a long parameter.

Parameters
parameter
Summer.Batch.Core.JobParameter.JobParameter ( DateTime  parameter)

Alternative constructor with a DateTime parameter.

Parameters
parameter
Summer.Batch.Core.JobParameter.JobParameter ( double  parameter)

Alternative constructor with a double parameter.

Parameters
parameter

Member Function Documentation

override bool Summer.Batch.Core.JobParameter.Equals ( Object  obj)

Equals override.

Parameters
obj
Returns
override int Summer.Batch.Core.JobParameter.GetHashCode ( )

GetHashCode override.

Returns
override string Summer.Batch.Core.JobParameter.ToString ( )

ToString override.

Returns

Property Documentation

bool Summer.Batch.Core.JobParameter.Identifying
get

Identifying flag.

ParameterType Summer.Batch.Core.JobParameter.Type
get

Parameter type getter.

object Summer.Batch.Core.JobParameter.Value
get

Parameter value getter.


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/JobParameter.cs