com.businessobjects.rebean.wi
Class OpenDocumentParameters

java.lang.Object
  com.businessobjects.rebean.wi.OpenDocumentParameters

public final class OpenDocumentParameters
extends java.lang.Object

The OpenDocumentParameters object stores the parameters required to open a document.

Since:

12.0

See Also:

ReportEngine.openDocument(int, OpenDocumentParameters), TrackData

Constructor Summary

OpenDocumentParameters()
Default constructor.

OpenDocumentParameters(int tdcReferenceDocId, boolean ignoreRefreshOnOpen, boolean forScheduling)
Constructor.

Method Summary

MultilingualOptions	getMultilingualOptions() Provides access to the multilingual options.
java.util.Properties	getProperties() Provides access to the additional properties.
int	getTrackDataReferenceDocId() Retrieves the identifier of the document used as the new reference for Track Data Changes.
boolean	isForScheduling() Returns true, if the document must be opened using its scheduling server group, if any.
boolean	isIgnoreRefreshOnOpen() Returns true, if required to skip data refresh when opening a "refresh on open" document, otherwise false.
void	setForScheduling(boolean forScheduling) Sets whether opening the document using it's scheduling server group.
void	setIgnoreRefreshOnOpen(boolean ignoreRefreshOnOpen) Sets whether skipping data refresh when opening a "refresh on open" document
void	setTrackDataReferenceDocId(int tdcReferenceDocId) Sets the identifier of the document containing the reference to compare data with using the Track Data Changes feature.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenDocumentParameters

public OpenDocumentParameters()

Default constructor.

OpenDocumentParameters

public OpenDocumentParameters(int tdcReferenceDocId,
                              boolean ignoreRefreshOnOpen,
                              boolean forScheduling)

Constructor.

Parameters:

tdcReferenceDocId - The identifier of the document used as the new reference for Track Data Changes.

ignoreRefreshOnOpen - true to skip refresh for "refresh on open" documents.

forScheduling - If true, the document is opened for scheduling using ist scheduling server group, if any.

Method Detail

getTrackDataReferenceDocId

public int getTrackDataReferenceDocId()

Retrieves the identifier of the document used as the new reference for Track Data Changes.

Returns:

the document identifier.

setTrackDataReferenceDocId

public void setTrackDataReferenceDocId(int tdcReferenceDocId)

Sets the identifier of the document containing the reference to compare data with using the Track Data Changes feature. Only has an effect if ReportEngine.getCanTrackData() returns true.

Parameters:

tdcReferenceDocId - The identifier of the document, should be greater than 0.

isIgnoreRefreshOnOpen

public boolean isIgnoreRefreshOnOpen()

Returns true, if required to skip data refresh when opening a "refresh on open" document, otherwise false.

Returns:

true, if required to skip data refresh when opening a "refresh on open" document, otherwise false.

setIgnoreRefreshOnOpen

public void setIgnoreRefreshOnOpen(boolean ignoreRefreshOnOpen)

Sets whether skipping data refresh when opening a "refresh on open" document

Parameters:

ignoreRefreshOnOpen - true to skip data refresh.

isForScheduling

public boolean isForScheduling()

Returns true, if the document must be opened using its scheduling server group, if any.

Returns:

true, if the document must be opened using its scheduling server group, if any.

setForScheduling

public void setForScheduling(boolean forScheduling)

Sets whether opening the document using it's scheduling server group.

Parameters:

forScheduling - true to use the scheduling server group.

getMultilingualOptions

public MultilingualOptions getMultilingualOptions()

Provides access to the multilingual options.

Returns:

a MultilingualOptions instance.

See Also:

MultilingualOptions

getProperties

public java.util.Properties getProperties()

Provides access to the additional properties.

Returns:

a Properties instance.

Since:

12.1.0