org.pentaho.platform.plugin.action.examples

Class ComponentImplementationExample

java.lang.Object

org.pentaho.platform.plugin.action.examples.ComponentImplementationExample

All Implemented Interfaces:

org.pentaho.platform.api.engine.IAuditable, org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.ILogger

public class ComponentImplementationExample
extends Object
implements org.pentaho.platform.api.engine.IComponent

Field Summary

Fields

Modifier and Type	Field and Description
String	EMPTYLOGID
static String	LOGID_MASK1
static String	LOGID_MASK2
static String	LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

Constructors

Constructor and Description
ComponentImplementationExample()

Method Summary

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)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGID_MASK1

public static final String LOGID_MASK1

See Also:

Constant Field Values

LOGID_MASK2

public static final String LOGID_MASK2

See Also:

Constant Field Values

LOGID_SEPARATOR

public static final String LOGID_SEPARATOR

See Also:

Constant Field Values

EMPTYLOGID

public String EMPTYLOGID

Constructor Detail

ComponentImplementationExample

public ComponentImplementationExample()

Method Detail

validateAction

public boolean validateAction()

done

public void done()

Specified by:

done in interface org.pentaho.platform.api.engine.IComponent

init

public boolean init()

Specified by:

init in interface org.pentaho.platform.api.engine.IComponent

setLogId

public void setLogId(String lId)

getLogger

public org.apache.commons.logging.Log getLogger()

genLogIdFromSession

public void genLogIdFromSession(org.pentaho.platform.api.engine.IPentahoSession sess)

genLogIdFromInfo

public void genLogIdFromInfo(String sessId,
                             String procId,
                             String actName)

genLogIdFromInfo

public void genLogIdFromInfo(String sessId,
                             String procId,
                             String actName,
                             String instId)

getObjectName

public String getObjectName()

Specified by:

getObjectName in interface org.pentaho.platform.api.engine.IAuditable

getLoggingLevel

public int getLoggingLevel()

Specified by:

getLoggingLevel in interface org.pentaho.platform.api.engine.ILogger

setLoggingLevel

public void setLoggingLevel(int logLevel)

Specified by:

setLoggingLevel in interface org.pentaho.platform.api.engine.ILogger

getMessages

public List getMessages()

Specified by:

getMessages in interface org.pentaho.platform.api.engine.IComponent

setMessages

public void setMessages(List messages)

Specified by:

setMessages in interface org.pentaho.platform.api.engine.IComponent

trace

public void trace(String message)

Specified by:

trace in interface org.pentaho.platform.api.engine.ILogger

debug

public void debug(String message)

Specified by:

debug in interface org.pentaho.platform.api.engine.ILogger

info

public void info(String message)

Specified by:

info in interface org.pentaho.platform.api.engine.ILogger

warn

public void warn(String message)

Specified by:

warn in interface org.pentaho.platform.api.engine.ILogger

error

public void error(String message)

Specified by:

error in interface org.pentaho.platform.api.engine.ILogger

fatal

public void fatal(String message)

Specified by:

fatal in interface org.pentaho.platform.api.engine.ILogger

trace

public void trace(String message,
                  Throwable error)

Specified by:

trace in interface org.pentaho.platform.api.engine.ILogger

debug

public void debug(String message,
                  Throwable error)

Specified by:

debug in interface org.pentaho.platform.api.engine.ILogger

info

public void info(String message,
                 Throwable error)

Specified by:

info in interface org.pentaho.platform.api.engine.ILogger

warn

public void warn(String message,
                 Throwable error)

Specified by:

warn in interface org.pentaho.platform.api.engine.ILogger

error

public void error(String message,
                  Throwable error)

Specified by:

error in interface org.pentaho.platform.api.engine.ILogger

fatal

public void fatal(String message,
                  Throwable error)

Specified by:

fatal in interface org.pentaho.platform.api.engine.ILogger

getUserString

public static String getUserString(String type)

setInstanceId

public void setInstanceId(String instanceId)

Specified by:

setInstanceId in interface org.pentaho.platform.api.engine.IComponent

getInstanceId

public String getInstanceId()

Specified by:

getInstanceId in interface org.pentaho.platform.api.engine.IComponent

setActionName

public void setActionName(String actionName)

Specified by:

setActionName in interface org.pentaho.platform.api.engine.IComponent

getActionName

public String getActionName()

Specified by:

getActionName in interface org.pentaho.platform.api.engine.IAuditable

Specified by:

getActionName in interface org.pentaho.platform.api.engine.IComponent

setProcessId

public void setProcessId(String processId)

Specified by:

setProcessId in interface org.pentaho.platform.api.engine.IComponent

getProcessId

public String getProcessId()

Specified by:

getProcessId in interface org.pentaho.platform.api.engine.IAuditable

Specified by:

getProcessId in interface org.pentaho.platform.api.engine.IComponent

setComponentDefinitionMap

public void setComponentDefinitionMap(Map<String,String> componentDefinitionMap)

Specified by:

setComponentDefinitionMap in interface org.pentaho.platform.api.engine.IComponent

setComponentDefinition

public void setComponentDefinition(org.dom4j.Node componentDefinition)

Specified by:

setComponentDefinition in interface org.pentaho.platform.api.engine.IComponent

getComponentDefinition

public org.dom4j.Node getComponentDefinition()

Specified by:

getComponentDefinition in interface org.pentaho.platform.api.engine.IComponent

setRuntimeContext

public void setRuntimeContext(org.pentaho.platform.api.engine.IRuntimeContext runtimeContext)

Specified by:

setRuntimeContext in interface org.pentaho.platform.api.engine.IComponent

getRuntimeContext

public org.pentaho.platform.api.engine.IRuntimeContext getRuntimeContext()

Specified by:

getRuntimeContext in interface org.pentaho.platform.api.engine.IComponent

setSession

public void setSession(org.pentaho.platform.api.engine.IPentahoSession session)

Specified by:

setSession in interface org.pentaho.platform.api.engine.IComponent

getSession

public org.pentaho.platform.api.engine.IPentahoSession getSession()

Specified by:

getSession in interface org.pentaho.platform.api.engine.IComponent

getLogId

public String getLogId()

validate

public final int validate()

Specified by:

validate in interface org.pentaho.platform.api.engine.IComponent

getInitOk

public boolean getInitOk()

promptNeeded

public void promptNeeded()

promptNow

public void promptNow()

getResourceAsString

public String getResourceAsString(org.pentaho.platform.api.engine.IActionSequenceResource resource)

getInitFailMessage

public String getInitFailMessage()

createNewInstance

public String createNewInstance(boolean persisted,
                                Map parameters,
                                boolean forceImmediateWrite)

inputMissingError

public void inputMissingError(String paramName)

outputMissingError

public void outputMissingError(String paramName)

resourceMissingError

public void resourceMissingError(String paramName)

resourceComponentSettingError

public void resourceComponentSettingError(String paramName)

execute

public int execute()

Specified by:

execute in interface org.pentaho.platform.api.engine.IComponent

getId

public String getId()

Specified by:

getId in interface org.pentaho.platform.api.engine.IAuditable

getActionTitle

public String getActionTitle()

createFeedbackParameter

public void createFeedbackParameter(String fieldName,
                                    String displayName,
                                    String hint,
                                    Object defaultValues,
                                    List values,
                                    Map dispNames,
                                    String displayStyle)

setActionDefinition

public void setActionDefinition(org.pentaho.actionsequence.dom.IActionDefinition actionDefinition)

Specified by:

setActionDefinition in interface org.pentaho.platform.api.engine.IComponent

getActionDefinition

public org.pentaho.actionsequence.dom.IActionDefinition getActionDefinition()

Specified by:

getActionDefinition in interface org.pentaho.platform.api.engine.IComponent