public class ComponentImplementationExample extends Object implements org.pentaho.platform.api.engine.IComponent
Modifier and Type | Field and Description |
---|---|
String |
EMPTYLOGID |
static String |
LOGID_MASK1 |
static String |
LOGID_MASK2 |
static String |
LOGID_SEPARATOR |
Constructor and Description |
---|
ComponentImplementationExample() |
Modifier and Type | Method and Description |
---|---|
void |
createFeedbackParameter(String fieldName,
String displayName,
String hint,
Object defaultValues,
List values,
Map dispNames,
String displayStyle) |
String |
createNewInstance(boolean persisted,
Map parameters,
boolean forceImmediateWrite) |
void |
debug(String message) |
void |
debug(String message,
Throwable error) |
void |
done() |
void |
error(String message) |
void |
error(String message,
Throwable error) |
int |
execute() |
void |
fatal(String message) |
void |
fatal(String message,
Throwable error) |
void |
genLogIdFromInfo(String sessId,
String procId,
String actName) |
void |
genLogIdFromInfo(String sessId,
String procId,
String actName,
String instId) |
void |
genLogIdFromSession(org.pentaho.platform.api.engine.IPentahoSession sess) |
org.pentaho.actionsequence.dom.IActionDefinition |
getActionDefinition() |
String |
getActionName() |
String |
getActionTitle() |
org.dom4j.Node |
getComponentDefinition() |
String |
getId() |
String |
getInitFailMessage() |
boolean |
getInitOk() |
String |
getInstanceId() |
org.apache.commons.logging.Log |
getLogger() |
int |
getLoggingLevel() |
String |
getLogId() |
List |
getMessages() |
String |
getObjectName() |
String |
getProcessId() |
String |
getResourceAsString(org.pentaho.platform.api.engine.IActionSequenceResource resource) |
org.pentaho.platform.api.engine.IRuntimeContext |
getRuntimeContext() |
org.pentaho.platform.api.engine.IPentahoSession |
getSession() |
static String |
getUserString(String type) |
void |
info(String message) |
void |
info(String message,
Throwable error) |
boolean |
init() |
void |
inputMissingError(String paramName) |
void |
outputMissingError(String paramName) |
void |
promptNeeded() |
void |
promptNow() |
void |
resourceComponentSettingError(String paramName) |
void |
resourceMissingError(String paramName) |
void |
setActionDefinition(org.pentaho.actionsequence.dom.IActionDefinition actionDefinition) |
void |
setActionName(String actionName) |
void |
setComponentDefinition(org.dom4j.Node componentDefinition) |
void |
setComponentDefinitionMap(Map<String,String> componentDefinitionMap) |
void |
setInstanceId(String instanceId) |
void |
setLoggingLevel(int logLevel) |
void |
setLogId(String lId) |
void |
setMessages(List messages) |
void |
setProcessId(String processId) |
void |
setRuntimeContext(org.pentaho.platform.api.engine.IRuntimeContext runtimeContext) |
void |
setSession(org.pentaho.platform.api.engine.IPentahoSession session) |
void |
trace(String message) |
void |
trace(String message,
Throwable error) |
int |
validate() |
boolean |
validateAction() |
void |
warn(String message) |
void |
warn(String message,
Throwable error) |
public static final String LOGID_MASK1
public static final String LOGID_MASK2
public static final String LOGID_SEPARATOR
public String EMPTYLOGID
public boolean validateAction()
public void done()
done
in interface org.pentaho.platform.api.engine.IComponent
public boolean init()
init
in interface org.pentaho.platform.api.engine.IComponent
public void setLogId(String lId)
public org.apache.commons.logging.Log getLogger()
public void genLogIdFromSession(org.pentaho.platform.api.engine.IPentahoSession sess)
public void genLogIdFromInfo(String sessId, String procId, String actName, String instId)
public String getObjectName()
getObjectName
in interface org.pentaho.platform.api.engine.IAuditable
public int getLoggingLevel()
getLoggingLevel
in interface org.pentaho.platform.api.engine.ILogger
public void setLoggingLevel(int logLevel)
setLoggingLevel
in interface org.pentaho.platform.api.engine.ILogger
public List getMessages()
getMessages
in interface org.pentaho.platform.api.engine.IComponent
public void setMessages(List messages)
setMessages
in interface org.pentaho.platform.api.engine.IComponent
public void trace(String message)
trace
in interface org.pentaho.platform.api.engine.ILogger
public void debug(String message)
debug
in interface org.pentaho.platform.api.engine.ILogger
public void info(String message)
info
in interface org.pentaho.platform.api.engine.ILogger
public void warn(String message)
warn
in interface org.pentaho.platform.api.engine.ILogger
public void error(String message)
error
in interface org.pentaho.platform.api.engine.ILogger
public void fatal(String message)
fatal
in interface org.pentaho.platform.api.engine.ILogger
public void trace(String message, Throwable error)
trace
in interface org.pentaho.platform.api.engine.ILogger
public void debug(String message, Throwable error)
debug
in interface org.pentaho.platform.api.engine.ILogger
public void info(String message, Throwable error)
info
in interface org.pentaho.platform.api.engine.ILogger
public void warn(String message, Throwable error)
warn
in interface org.pentaho.platform.api.engine.ILogger
public void error(String message, Throwable error)
error
in interface org.pentaho.platform.api.engine.ILogger
public void fatal(String message, Throwable error)
fatal
in interface org.pentaho.platform.api.engine.ILogger
public void setInstanceId(String instanceId)
setInstanceId
in interface org.pentaho.platform.api.engine.IComponent
public String getInstanceId()
getInstanceId
in interface org.pentaho.platform.api.engine.IComponent
public void setActionName(String actionName)
setActionName
in interface org.pentaho.platform.api.engine.IComponent
public String getActionName()
getActionName
in interface org.pentaho.platform.api.engine.IAuditable
getActionName
in interface org.pentaho.platform.api.engine.IComponent
public void setProcessId(String processId)
setProcessId
in interface org.pentaho.platform.api.engine.IComponent
public String getProcessId()
getProcessId
in interface org.pentaho.platform.api.engine.IAuditable
getProcessId
in interface org.pentaho.platform.api.engine.IComponent
public void setComponentDefinitionMap(Map<String,String> componentDefinitionMap)
setComponentDefinitionMap
in interface org.pentaho.platform.api.engine.IComponent
public void setComponentDefinition(org.dom4j.Node componentDefinition)
setComponentDefinition
in interface org.pentaho.platform.api.engine.IComponent
public org.dom4j.Node getComponentDefinition()
getComponentDefinition
in interface org.pentaho.platform.api.engine.IComponent
public void setRuntimeContext(org.pentaho.platform.api.engine.IRuntimeContext runtimeContext)
setRuntimeContext
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.platform.api.engine.IRuntimeContext getRuntimeContext()
getRuntimeContext
in interface org.pentaho.platform.api.engine.IComponent
public void setSession(org.pentaho.platform.api.engine.IPentahoSession session)
setSession
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.platform.api.engine.IPentahoSession getSession()
getSession
in interface org.pentaho.platform.api.engine.IComponent
public String getLogId()
public final int validate()
validate
in interface org.pentaho.platform.api.engine.IComponent
public boolean getInitOk()
public void promptNeeded()
public void promptNow()
public String getResourceAsString(org.pentaho.platform.api.engine.IActionSequenceResource resource)
public String getInitFailMessage()
public String createNewInstance(boolean persisted, Map parameters, boolean forceImmediateWrite)
public void inputMissingError(String paramName)
public void outputMissingError(String paramName)
public void resourceMissingError(String paramName)
public void resourceComponentSettingError(String paramName)
public int execute()
execute
in interface org.pentaho.platform.api.engine.IComponent
public String getId()
getId
in interface org.pentaho.platform.api.engine.IAuditable
public String getActionTitle()
public void createFeedbackParameter(String fieldName, String displayName, String hint, Object defaultValues, List values, Map dispNames, String displayStyle)
public void setActionDefinition(org.pentaho.actionsequence.dom.IActionDefinition actionDefinition)
setActionDefinition
in interface org.pentaho.platform.api.engine.IComponent
public org.pentaho.actionsequence.dom.IActionDefinition getActionDefinition()
getActionDefinition
in interface org.pentaho.platform.api.engine.IComponent