org.pentaho.platform.plugin.action.builtin
Class PrintComponent

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.PentahoMessenger
          org.pentaho.platform.engine.services.solution.ComponentBase
              org.pentaho.platform.plugin.action.builtin.PrintComponent

All Implemented Interfaces:

Serializable, IAuditable, IComponent, ILogger, IParameterResolver

public class PrintComponent
extends ComponentBase

Implements a PrintComponent class that will send a attached print file to a specified printer.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

COMPONENT_EXECUTE_FAIL, MISSING_SESSION

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, 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

PrintComponent()

Method Summary

void	done() Allows the component to perform any cleanup after the execution of the action.
static PrintService	getDefaultPrinter()
org.apache.commons.logging.Log	getLogger()
static PrintService	getPrinter(String printerName) Takes a printer name and find the associated PrintService.
PrintService	getPrinterInternal(String printerName, String lastPrinterName) Takes a printer name and find the associated PrintService.
boolean	init() Initialize the Component.

Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getId, getInitFailMessage, getInitOk, getInstanceId, getLogId, getObjectName, getProcessId, getResourceAsString, getRuntimeContext, getSession, inputMissingError, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setProcessId, setRuntimeContext, setSession, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.IComponent

getMessages, setMessages

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

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Constructor Detail

PrintComponent

public PrintComponent()

Method Detail

getLogger

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

Specified by:

getLogger in class PentahoBase

init

public boolean init()

Description copied from interface: IComponent

Initialize the Component. This method is typically called on construction.

Specified by:

init in interface IComponent

Specified by:

init in class ComponentBase

Returns:

returns true if the Component initialized successfully, otherwise returns false

done

public void done()

Description copied from interface: IComponent

Allows the component to perform any cleanup after the execution of the action.

Specified by:

done in interface IComponent

Specified by:

done in class ComponentBase

getPrinterInternal

public PrintService getPrinterInternal(String printerName,
                                       String lastPrinterName)

Takes a printer name and find the associated PrintService. If no match can be made it randomly picks the first printer listed from the call to lookupPrintServices.

Parameters:

printerName -

Returns:

PrintService referenced by the printerName

getPrinter

public static PrintService getPrinter(String printerName)

Takes a printer name and find the associated PrintService. If no match can be made it randomly picks the first printer listed from the call to lookupPrintServices.

Parameters:

printerName -

Returns:

PrintService referenced by the printerName

getDefaultPrinter

public static PrintService getDefaultPrinter()