Package org.pentaho.di.job.entry

Interface JobEntryHelperInterface

All Known Implementing Classes:

BaseJobEntryHelper, JobEntryJobHelper, JobEntryTransHelper, JobEntryZipFileHelper

public interface JobEntryHelperInterface

Defines helper methods for executing "job entry actions" used by a job entry user interface (UI).

Job entry actions are job entry-specific, non-runtime operations invoked from a job entry dialog (e.g. fetching metadata, testing connections) whose results are displayed in the dialog.

They are not part of job or job entry execution logic.

This interface declares common response field constants and a default implementation that returns a "method not found" status when no action is implemented.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_STATUS
static final String	FAILURE_METHOD_NOT_FOUND_RESPONSE
static final String	FAILURE_RESPONSE
static final int	FAILURE_STATUS
static final int	NOT_EXECUTED_STATUS
static final String	STATUS
static final String	SUCCESS_RESPONSE
static final int	SUCCESS_STATUS

Method Summary

Modifier and Type	Method	Description
default org.json.simple.JSONObject	jobEntryAction(String method, JobMeta jobMeta, Map<String,String> queryParams)	Default implementation for performing a job entry action.

Field Details

STATUS

static final String STATUS

See Also:

• Constant Field Values

ACTION_STATUS

static final String ACTION_STATUS

See Also:

• Constant Field Values

SUCCESS_RESPONSE

static final String SUCCESS_RESPONSE

See Also:

• Constant Field Values

FAILURE_RESPONSE

static final String FAILURE_RESPONSE

See Also:

• Constant Field Values

FAILURE_METHOD_NOT_FOUND_RESPONSE

static final String FAILURE_METHOD_NOT_FOUND_RESPONSE

See Also:

• Constant Field Values

SUCCESS_STATUS

static final int SUCCESS_STATUS

See Also:

• Constant Field Values

FAILURE_STATUS

static final int FAILURE_STATUS

See Also:

• Constant Field Values

NOT_EXECUTED_STATUS

static final int NOT_EXECUTED_STATUS

See Also:

• Constant Field Values

Method Details

jobEntryAction

default org.json.simple.JSONObject jobEntryAction(String method,
 JobMeta jobMeta,
 Map<String,String> queryParams)

Default implementation for performing a job entry action.

Parameters:

method - The name of the method to execute.

jobMeta - The job metadata associated with the job entry.

queryParams - A map of query parameters for the action.

Returns:

A JSON object containing the action status, defaulting to a failure response if the method is not found.