org.pentaho.platform.api.util

Interface IPdiContentProvider

public interface IPdiContentProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTECTED_PARAMETER_PREFIX When a user creates a input parameter but does not want it to be written by others, it uses the syntax of an "_" (underscore) as prefix; so, if a user creates input parameter "_name", then the other users looking at it will know that they should not change it.

Method Summary

Modifier and Type	Method and Description
String[]	getUserParameters(String kettleFilePath) lists user input parameters for a given a ktr/kjb filePath
boolean	hasUserParameters(String kettleFilePath) given a ktr/kjb filePath, looks in its metadata for the existence of user input parameters, required to properly execute

Field Detail

PROTECTED_PARAMETER_PREFIX

static final String PROTECTED_PARAMETER_PREFIX

When a user creates a input parameter but does not want it to be written by others, it uses the syntax of an "_" (underscore) as prefix; so, if a user creates input parameter "_name", then the other users looking at it will know that they should not change it.

See Also:

Constant Field Values

Method Detail

hasUserParameters

boolean hasUserParameters(String kettleFilePath)

given a ktr/kjb filePath, looks in its metadata for the existence of user input parameters, required to properly execute

Parameters:

kettleFilePath - ktr/kjb filePath

Returns:

true if ktr/kjb required some user-input parameters to execute, false otherwise

getUserParameters

String[] getUserParameters(String kettleFilePath)

lists user input parameters for a given a ktr/kjb filePath

Parameters:

kettleFilePath - ktr/kjb filePath

Returns:

list of user input parameters' name