com.businessobjects.rebean.wi
Class OutputCacheEntry

java.lang.Object
  extended by com.businessobjects.rebean.wi.OutputCacheEntry

public class OutputCacheEntry
extends java.lang.Object

Warning: This class is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The OutputCacheEntry class is used for tailoring how a server should preload its output cache.

Since:
12.0
See Also:
ReportEngine.getCanPreloadOutputCache(), ReportEngine.preloadOutputCache(int, String, OutputCacheEntry[])

Constructor Summary
OutputCacheEntry(OutputFormatType outputFormat)
          Constructor.
OutputCacheEntry(OutputFormatType outputFormat, java.lang.String[] formattingLocales)
          Constructor.
 
Method Summary
 java.lang.String[] getFormattingLocales()
          Returns the list of formatting locales identifiers for which outputs should be cached by the server.
 OutputFormatType getOutputFormat()
          Returns the output format to be cached by the server.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputCacheEntry

public OutputCacheEntry(OutputFormatType outputFormat)
Constructor.

Parameters:
outputFormat - the output format to be cached by the server.

Using this constructor ends up in caching a single output, formatted using the document locale.

See Also:
DocumentInstance.getFormattingLocale()

OutputCacheEntry

public OutputCacheEntry(OutputFormatType outputFormat,
                        java.lang.String[] formattingLocales)
Constructor.

Parameters:
outputFormat - the output format to be cached by the server.
formattingLocales - the list of formatting locales identifiers for which outputs should be cached by the server.
Method Detail

getOutputFormat

public OutputFormatType getOutputFormat()
Returns the output format to be cached by the server.

Returns:
the output format to be cached by the server.

getFormattingLocales

public java.lang.String[] getFormattingLocales()
Returns the list of formatting locales identifiers for which outputs should be cached by the server.

Returns:
the list of formatting locales identifiers for which outputs should be cached by the server.