com.norconex.jef
Interface IJobContext

All Superinterfaces:
Serializable
All Known Implementing Classes:
JobContext

public interface IJobContext
extends Serializable

Holds contextual information about a job. Some attributes are descriptive in nature while others defines boundaries to be used by the JEF framework. Concrete implementations should be considered immutable once instantiated.

Since:
2.0
Author:
Pascal Essiembre

Field Summary
static int PROGRESS_100
           
static int PROGRESS_ZERO
           
 
Method Summary
 String getDescription()
          Gets the job description.
 long getProgressMaximum()
          Gets the maximum execution progress value.
 long getProgressMinimum()
          Gets the minimum execution progress value.
 

Field Detail

PROGRESS_ZERO

static final int PROGRESS_ZERO
See Also:
Constant Field Values

PROGRESS_100

static final int PROGRESS_100
See Also:
Constant Field Values
Method Detail

getDescription

String getDescription()
Gets the job description.

Returns:
job description

getProgressMinimum

long getProgressMinimum()
Gets the minimum execution progress value.

Returns:
minimum progress value

getProgressMaximum

long getProgressMaximum()
Gets the maximum execution progress value.

Returns:
maximum progress value


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.