Package org.nuclos.api.provider

Class PrintoutProvider

java.lang.Object

org.nuclos.api.provider.PrintoutProvider

public class PrintoutProvider
extends Object

PrintoutProvider provides methods for executing printouts

This Class is usually used in Rule-classes and allows API access only

Author:

Matthias Reichart

Constructor Summary

Constructors

Constructor	Description
PrintoutProvider()

Method Summary

Modifier and Type	Method	Description
static NuclosFile	run(OutputFormat format, Long boId)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	run(OutputFormat format, Long boId, Map<String,Object> params)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	run(OutputFormat format, Long boId, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	run(OutputFormat format, Long boId, NuclosLocale locale)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
void	setPrintoutService(PrintoutService repService)

Methods inherited from class java.lang.Object

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

Constructor Details

PrintoutProvider

public PrintoutProvider()

Method Details

setPrintoutService

public void setPrintoutService(PrintoutService repService)

run

public static NuclosFile run(OutputFormat format,
 Long boId)
                      throws BusinessException

This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile

Parameters:

format - OutputFormat - OutputFormat stored in the generated printout class

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 Long boId,
 NuclosLocale locale)
                      throws BusinessException

This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language

Parameters:

format - OutputFormat - OutputFormat stored in the generated printout class

locale - NuclosLocale - Language in which the localized data is displayed

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 Long boId,
 Map<String,Object> params)
                      throws BusinessException

Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile

Parameters:

format - OutputFormat - OutputFormat stored in the generated printout class

boId -

params - Map - Parameters for the printout

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 Long boId,
 Map<String,Object> params,
 NuclosLocale locale)
                      throws BusinessException

Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language

Parameters:

format - OutputFormat - OutputFormat stored in the generated printout class

boId -

params - Map - Parameters for the printout

locale - NuclosLocale - Language in which the localized data is displayed

Returns:

NuclosFile

Throws:

BusinessException