com.businessobjects.rebean.wi
Interface DocumentInstance

public interface DocumentInstance

The DocumentInstance interface represents a document.

Example: Opening a Web Intelligence document

  String strDocId = request.getParameter("docId");
  DocumentInstance wiDoc = null;
  ReportEngine repEng = (ReportEngine) session.getAttribute("ReportEngine");
  wiDoc = repEng.openDocument(Integer.parseInt(strDocId));
  String storageToken = wiDoc.getStorageToken();
  //Perform actions on the document to change document state.
  ...
  //Retrieve the document in its original, then save it.
  DocumentInstance wiDocPreviousState =
        repEng.getDocumentFromStorageToken(storageToken);
 wiDocPreviousState.save();
 

See Also:

ReportEngine

Method Summary

void	applyFormat() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
void	cancelQueries() Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.
void	closeDocument() Closes the current document.
ReportContainer	createReport(java.lang.String name) Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
int	getAutoSaveDocumentID() Returns the CMS identifier of the auto-save document.
DataProvider[]	getAvailableDps() Returns the array of available data providers in a document that have either been run or saved.
Contexts	getContextPrompts() Returns the document contexts raised when refreshing the document.
DataProviders	getDataProviders() Returns the collection of the document's data providers.
FormatNumber	getDefaultFormatNumber(FormatNumberType type) Returns the default FormatNumber for a specific type of values.
ReportDictionary	getDictionary() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DocumentLocaleType	getFormattingLocale() Returns the DocumentLocaleType in which DocumentInstance data will be presented.
Image	getImage(java.lang.String imageName) Gets the Image class providing access to image binary content.
ImageOption	getImageOption() Gets the ImageOption class which provides image options for the document.
Lov	getLOV(java.lang.String objID) Deprecated. should use DocumentInstance.getLOV(String, LovType) instead
Lov	getLOV(java.lang.String objID, LovType type) Deprecated. should use DocumentInstance.getLOV(String, LovType, DataProvider) or DocumentInstance.getLOV(String, LovType, DataSourceParameterValues) instead
Lov	getLOV(java.lang.String objectID, LovType type, DataProvider dataProvider) Retrieves a List of Values of the specified type for a given object, using data source parameter values coming from the specified DataProvider.
Lov	getLOV(java.lang.String objectID, LovType type, DataSourceParameterValues values) Retrieves a List of Values of the specified type for a given object, using specified data source parameter values.
int	getMediaDPI() Deprecated. As of version 11.7, replaced by OutputPropertiesType.DPI_FACTOR
boolean	getMustFillContexts() Tests if any universe contexts must be filled.
boolean	getMustFillPassword() Tests if a password must be filled.
boolean	getMustFillPrompts() Determine if prompts must be filled.
OpenDocumentInfo	getOpenDocumentInfo() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
Prompts	getPrompts() Returns the prompts for the document.
java.util.Properties	getProperties() Returns the properties of the document.
java.lang.String	getReadPassword() Deprecated. Document passwords are no longer supported.
ReportMap	getReportMap() Returns the report map for the document.
ReportParts	getReportParts(java.lang.String[] references, OutputFormatType formatType) Retrieves the report parts by specifying the report part references and OutputFormatType.
ReportParts	getReportParts(java.lang.String[] references, OutputFormatType formatType, java.util.Properties properties) Retrieves the report parts by specifying the report part references, OutputFormatType, and Properties.
Reports	getReports() Returns the collection of reports in the document.
ResourceManager	getResourceManager() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
int	getSelectedReport() Returns the specified report the client has selected.
java.lang.String	getServerInstance() Gets the name of the server.
java.lang.String	getStorageToken() Returns the current storage token for the document.
ReportStructure	getStructure() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
java.lang.String[]	getSupportedFormats() Returns the list of output formats supported by the report engine.
SupportedViews	getSupportedViews() Returns a SupportedViews object listing the ways it is possible to view data in the current DocumentInstance object.
TrackData	getTrackData() Returns the Track Data interface which gives access to the Track Data Feature.
java.lang.Object	getView(OutputFormatType outputFormat) Gets the whole document in the specified output format.
java.lang.Object	getView(OutputFormatType outputFormat, java.util.Properties properties) Gets the whole document in the specified output format.
ReportParts	getXmlReportParts(java.lang.String[] references, int filter) Retrieves the report parts specified through references in XML format, tailored using filter.
ReportParts	getXmlReportParts(java.lang.String[] references, int filter, java.util.Properties properties) Retrieves the report parts specified through references in XML format, tailored using filter.
boolean	keepAlive() Checks if the document instance is alive.
void	refresh() Refreshes the document.
void	refresh(boolean refreshAllDPWithRights) Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.
void	save() Saves updates to the DocumentInstance.
void	saveAs(java.lang.String title, int parent, java.util.List categories, java.util.List personalCategories) Saves the current DocumentInstance with the name title in a specific folder parent.
void	saveAs(java.lang.String title, int parent, java.util.List categories, java.util.List personalCategories, boolean overwrite) Saves the current DocumentInstance with the name title in a specific folder parent.
void	setContexts() Assigns the contexts values to the document.
void	setFormattingLocale(DocumentLocaleType type) Defines the locale in which DocumentInstance data will be formatted when the document is opened.
void	setMediaDPI(int dpi) Deprecated. As of version 11.7, replaced by OutputPropertiesType.DPI_FACTOR
Report	setPath(java.lang.String path) Sets the current report using a path from a report map node.
void	setPrompts() Assigns the prompts values to the document.
void	setProperties(java.util.Properties props) Sets the properties of the document.
void	setReadPassword(java.lang.String pwd) Deprecated. Document passwords are no longer supported.
ReportPart	setReportPart(java.lang.String reference) Navigate to the report page containing the report part specified through reference.
void	setSelectedReport(int reportIndex) Select the specified Report.

Method Detail

getProperties

java.util.Properties getProperties()

Returns the properties of the document.

Note: a call is made to the Web Intelligence Server each time this method is called.

Returns:

A Properties collection containing the document's properties

See Also:

"java.util.Properties", DocumentInstance.setProperties(java.util.Properties), PropertiesType

setProperties

void setProperties(java.util.Properties props)

Sets the properties of the document.

You can add new, persistent properties to the document. The values of properties must be contained in Strings. To delete a property, set its value to "".

Note: the java.util.Properties fails when it contains more than 100 000 characters.

It is not possible to set custom properties for a document if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See PropertiesType for a list of public properties.

Parameters:

props - A Properties instance.

See Also:

"java.util.Properties", DocumentInstance.getProperties()

getLOV

@Deprecated
Lov getLOV(java.lang.String objID)

Deprecated. should use DocumentInstance.getLOV(String, LovType) instead

Returns a List Of Values for a universe object.

Note: if there is a filter set on the report, section, or block, the List Of Values returned is filtered accordingly.

Parameters:

objID - The ID of the List Of Values to be returned.

Returns:

The List Of Values.

See Also:

Lov

getLOV

@Deprecated
Lov getLOV(java.lang.String objID,
                      LovType type)

Deprecated. should use DocumentInstance.getLOV(String, LovType, DataProvider) or DocumentInstance.getLOV(String, LovType, DataSourceParameterValues) instead

Returns a List Of Values for a any object. The List Of Values might be filtered depending to the type you specify.
LovType must be one of the following types.

Name	Description
CUBE	Will return a List Of Values in which the values are stored in a cube. These values can be restricted by a report, section or block filter.
DATA_SOURCE	Will return the List Of Values taken from the data source without filtering.
LOV_OBJECT	will return a List Of Values already calculated and cached by the server on a previous call

You can retrieve a Lov ID using the Lov.getID method. Note: retrieving LovType.LOV_DRILL with this method will cause an REException.

Parameters:

objID - The objID of the List Of Values.

type - The type of the List Of Values.

Returns:

The List Of Values for the object.

See Also:

Lov, DrillBarObject, LovType

closeDocument

void closeDocument()

Closes the current document.

All documents opened during a session are stored and available for the user. As a consequence, opening many documents will bloat the server's memory heap. To improve performance, close a document explicitly when it is no longer needed.

This method has no effect if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents.

getReportMap

ReportMap getReportMap()

Returns the report map for the document.

Returns:

The ReportMap for the document.

See Also:

ReportMap

setPath

Report setPath(java.lang.String path)

Sets the current report using a path from a report map node.

If the path contains a section indicator, the report returned is initialized to the page containing that section. If you view the HTML of this report with Report.getView the page containing the specified section.

Parameters:

path - The path (in the report map) to the report.

Returns:

The report to be displayed.

See Also:

Report, ReportMapNode

getReports

Reports getReports()

Returns the collection of reports in the document.

Returns:

The collection of reports in the document.

See Also:

Reports

getDataProviders

DataProviders getDataProviders()

Returns the collection of the document's data providers.

Returns:

The collection of the document's data providers.

See Also:

DataProviders

getSelectedReport

int getSelectedReport()

Returns the specified report the client has selected. This is a helper function and can be implemented by the client using the getProperties/setProperties methods.

Returns:

The index of the report the user has selected.

Since:

6.1

See Also:

DocumentInstance.setSelectedReport(int)

setSelectedReport

void setSelectedReport(int reportIndex)

Select the specified Report. This is a helper function and can be implemented by the client using the getProperties/setProperties methods.

Parameters:

reportIndex -

Since:

6.1

See Also:

DocumentInstance.getSelectedReport()

getReadPassword

@Deprecated
java.lang.String getReadPassword()

Deprecated. Document passwords are no longer supported.

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

Returns the read password assigned to the document.

Returns:

The read password.

setReadPassword

@Deprecated
void setReadPassword(java.lang.String pwd)

Deprecated. Document passwords are no longer supported.

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

Sets the read password for the document.

This method is used only in editing mode.

Parameters:

pwd - The new document's read password.

getMustFillPassword

boolean getMustFillPassword()

Tests if a password must be filled.

This method is used only in editing mode.

Returns:

Returns true if a password must be filled.

getMustFillContexts

boolean getMustFillContexts()

Tests if any universe contexts must be filled.

As you can get the contexts without refreshing the document, this method is only a flag for checking if a refresh has been called (or the document is refresh on open) and the context list is not empty.

This method always returns false if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance was opened to run Desktop Intelligence documents.

Returns:

Returns true if any universe contexts must be filled.

See Also:

Contexts

getMustFillPrompts

boolean getMustFillPrompts()

Determine if prompts must be filled.

As you can get the prompts without refreshing the document, this method is only a flag for checking if a refresh has been called (or the document is refresh on open) and the prompt list is not empty.

Returns:

Returns true if at least one prompt must be filled.

See Also:

Prompts

getPrompts

Prompts getPrompts()

Returns the prompts for the document.

You can call this method without refreshing the document at the same time. This gives you access to any prompt and any values.

Returns:

The collection of prompts for the document.

See Also:

DocumentInstance.setPrompts(), Prompts

getContextPrompts

Contexts getContextPrompts()

Returns the document contexts raised when refreshing the document.

Returns:

The collection of document contexts.

See Also:

DocumentInstance.setContexts(), Contexts

setContexts

void setContexts()

Assigns the contexts values to the document. Once all contexts have been filled, use this method to set them. Do not call this method if the document has no context prompts.

See Also:

DocumentInstance.getContextPrompts(), DocumentInstance.getMustFillContexts(), Contexts

setPrompts

void setPrompts()

Assigns the prompts values to the document.

If no optional prompts have been filled, use this method to set them. Do not call this method if the document has no prompts.

Caution, setPrompts must be called just after Prompt.enterValues have been called. Other calls may make your setPrompts failed, even if no exception

If all prompts are optional, Prompt.enterValues call is optional but setPrompts must be called in any case.

 doc.getDataProviders().runQueries();
 if (doc.getMustFillPrompts()) {
     boolean hasAnyNoOptionalPrompts = false;
     Prompts prompts = doc.getPrompts();
     for (int i = 0; i < prompts.getCount(); i++) {
         Prompt promptAnswer = prompts.getItem(i);
         hasAnyNoOptionalPrompts = !(promptAnswer.isOptional());
         if (hasAnyNoOptionalPrompts)
             break;
     }
     // All prompts are optional, we could all setPrompts without enterValues
     if (!hasAnyNoOptionalPrompts) {
         doc.setPrompts();
         boolean promptsToBeFilled = doc.getMustFillPrompts(); // should be false
     }
 }
 

See Also:

DocumentInstance.getMustFillPrompts(), DocumentInstance.getPrompts(), Prompts

getSupportedFormats

java.lang.String[] getSupportedFormats()

Returns the list of output formats supported by the report engine.

Returns:

the collection of supported output formats

refresh

void refresh()

Refreshes the document.

During a refresh all the data providers are refreshed, this mean that the query is executed and data is fetched from the micro cube. During the query execution, any prompts and contexts in the document are raised.

See Also:

DocumentInstance.getMustFillContexts(), DocumentInstance.getMustFillPrompts()

refresh

void refresh(boolean refreshAllDPWithRights)

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

Refreshes the document.

During the refresh, all the data providers are refreshed. But this overloaded method will refresh only the data provider which have the rights which means that the query is executed and data fetched in the micro cube. During the query execution, any prompts and contexts in the document are raised.

Parameters:

refreshAllDPWithRights -

true - On true, it will allow to refresh the document with only allowed MDP.

false - On false, it will not perform any action, in case if it is accessed from SDK as false, it will try to refresh only the one which are allowed.

Throws:

REException - is a general exception which will be thrown at any failure in refresh action.

See Also:

DocumentInstance.refresh(), DocumentInstance.getMustFillContexts(), DocumentInstance.getMustFillPrompts()

cancelQueries

void cancelQueries()

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

Cancels all running refresh operations in the document.

This method is asynchronous: It cancels the refresh in all DataProviders.

This method has no effect if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents.

See Also:

DocumentInstance.refresh()

getStorageToken

java.lang.String getStorageToken()

Returns the current storage token for the document.

The document storage token reveals a document's state. The document storage token contains all the classes of this object model and when you call this method, the entire object model is serialized.

Returns:

The current document storage token.

getImageOption

ImageOption getImageOption()

Gets the ImageOption class which provides image options for the document. The ImageOption class stores information about the JSP page called to retrieve images stored in the document.

Returns:

The jsp page called to retrieve images stored in the document.

getImage

Image getImage(java.lang.String imageName)

Gets the Image class providing access to image binary content.

Parameters:

imageName - The name of the image.

Returns:

The specified Image.

See Also:

Image

getStructure

ReportStructure getStructure()

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

Gets the top level container of the document structure.

You use the object returned by this method to edit the format and structure of a report.

Returns:

The top level document container.

Throws:

NotImplementedException - if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See ReportEngines#getService(int type) for more information.

See Also:

ReportStructure

getDictionary

ReportDictionary getDictionary()

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

Gets the variable and objects dictionary.

This dictionary is populated after calling DataProvider.runQuery() or DataProvider.generateQuery().

Returns:

The report dictionary.

Throws:

NotImplementedException - if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See ReportEngines#getService(int type) for more information.

See Also:

ReportDictionary

getView

java.lang.Object getView(OutputFormatType outputFormat)

Gets the whole document in the specified output format.

You can only get listing views using this method, that is, PDF (Portable Document Format)and XLS (Native MS Excel). To get a page view (HTML) use the Report interface.

Parameters:

outputFormat - The output format.

Returns:

The output format view (cf BinaryView).

See Also:

Report.getView(com.businessobjects.rebean.wi.OutputFormatType), OutputFormatType

getView

java.lang.Object getView(OutputFormatType outputFormat,
                         java.util.Properties properties)
                         throws REException

Gets the whole document in the specified output format.

You can only get listing views using this method, that is, PDF (Portable Document Format)and XLS (Native MS Excel). To get a page view (HTML) use the Report interface.

Media are the parameters that are used to format the document.

You can set the default media properties according to your preferences. You must specify the Media Types as a combination of Name and Value.

Parameters:

outputFormat - the output format.

properties - a set of properties used to customize the output. Use property names from OutputPropertiesType.

Returns:

The output format view (cf BinaryView).

Throws:

REException

Since:

11.7

See Also:

Report.getView(com.businessobjects.rebean.wi.OutputFormatType), OutputFormatType, OutputPropertiesType

createReport

ReportContainer createReport(java.lang.String name)

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

Creates a new report.

Parameters:

name - The name of the new report.

Returns:

A ReportContainer object for the new report.

Throws:

NotImplementedException - if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See ReportEngines#getService(int type) for more information.

getMediaDPI

@Deprecated
int getMediaDPI()

Deprecated. As of version 11.7, replaced by OutputPropertiesType.DPI_FACTOR

Gets the resolution in DPI (dots per inch) for any media files retrieved using Web Intelligence Report Engine SDK.

A media file can be an image, PDF view, or any blob. The default resolution is 96 DPI.

Returns:

The current resolution of media files.

setMediaDPI

@Deprecated
void setMediaDPI(int dpi)

Deprecated. As of version 11.7, replaced by OutputPropertiesType.DPI_FACTOR

Sets the resolution in DPI (dots per inch) of media files set by the SDK.

A media file can be an image, PDF view, or any blob. The default resolution is 96 DPI.

Parameters:

dpi - The new resolution in DPI.

Throws:

NotImplementedException - if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See ReportEngines#getService(int type) for more information.

applyFormat

void applyFormat()

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

Applies modifications made to the formatting of a report.

Call this method to recompute the report after operations such as adding a section, or changing the background color.

Throws:

NotImplementedException - if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance used to open this DocumentInstance was opened to run Desktop Intelligence documents. See ReportEngines#getService(int type) for more information.

getOpenDocumentInfo

OpenDocumentInfo getOpenDocumentInfo()

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

Returns critical information upon opening this document. If this document contains a warning here, the document can still be edited (DocumentInstance.getStructure(), DocumentInstance.getDataProviders()) but no further viewing operations are expected to work.

Currently, this occurs in one situation: upon opening a document with refresh on open, that uses at least one universe object that has been deleted since the document was last saved.

Returns:

Extra information on the status after opening this document, or null when there were no problems.

Since:

11.5

getFormattingLocale

DocumentLocaleType getFormattingLocale()

Returns the DocumentLocaleType in which DocumentInstance data will be presented.

If DocumentInstance.getFormattingLocale() == DocumentLocaleType.Locale, document data will be formatted with the end-user's document locale.

If DocumentInstance.getFormattingLocale() == DocumentLocaleType.BaseLocale, document data will be formatted using the document author's locale.

Note: this can be changed using the Web Intelligence Document Preferences tab in the InfoView personalization page.

Returns:

Since:

11.5

See Also:

DocumentInstance.setFormattingLocale(DocumentLocaleType)

setFormattingLocale

void setFormattingLocale(DocumentLocaleType type)

Defines the locale in which DocumentInstance data will be formatted when the document is opened.

If DocumentInstance.getFormattingLocale() == DocumentLocaleType.LOCALE, document data will be formatted with the end-user's document locale.

If DocumentInstance.getFormattingLocale() == DocumentLocaleType.BASELOCALE, document data will be formatted using the document author's locale.

Note: this can be changed using the Web Intelligence Document Preferences tab in the InfoView personalization page.

Parameters:

type - The new document locale type.

Throws:

java.lang.NullPointerException - Thrown when type == null.

Since:

11.5

See Also:

DocumentInstance.getFormattingLocale()

getSupportedViews

SupportedViews getSupportedViews()

Returns a SupportedViews object listing the ways it is possible to view data in the current DocumentInstance object.

Desktop Intelligence and Web Intelligence documents do not support the same OutputFormatType and ViewModeType combinations. The SupportedViews interface is used to present a Web Intelligence with the range of views in which it is possible to see a specific document.

Returns:

Since:

11.5

saveAs

void saveAs(java.lang.String title,
            int parent,
            java.util.List categories,
            java.util.List personalCategories)

Saves the current DocumentInstance with the name title in a specific folder parent.

Note: validate that the current user has access right to the directory with parent id parent before trying to save the document.

Parameters:

title - The document name.

parent - The ID of the parent folder in which the document will be saved.

categories - A list of java.lang.Integer containing the IDs of the public categories in which the document will be saved.

personalCategories - A list of java.lang.Integer containing the IDs of the personal categories in which the document will be saved.

Since:

11.0

saveAs

void saveAs(java.lang.String title,
            int parent,
            java.util.List categories,
            java.util.List personalCategories,
            boolean overwrite)

Saves the current DocumentInstance with the name title in a specific folder parent. If the document already exists, the overwrite boolean will be used to prevent the document to be overwritten or not.

Note: validate that the current user has access right to the directory with parent id parent before trying to save the document.

Parameters:

title - The document name.

parent - The ID of the parent folder in which the document will be saved.

categories - A list of java.lang.Integer containing the IDs of the public categories in which the document will be saved.

personalCategories - A list of java.lang.Integer containing the IDs of the personal categories in which the document will be saved.

overwrite - If the document already exists : true will overwrite the document, false will throw an exception.

Since:

11.0

save

void save()

Saves updates to the DocumentInstance.

Before calling this function the document must have already been saved once using DocumentInstance.saveAs(String, int, List, List).

Since:

11.0

getServerInstance

java.lang.String getServerInstance()

Gets the name of the server.

Returns:

the name of the server.

getReportParts

ReportParts getReportParts(java.lang.String[] references,
                           OutputFormatType formatType)

Retrieves the report parts by specifying the report part references and OutputFormatType. You can obtain the report part references by viewing document in the XMLView.

Remarks: ReportParts.getCount may be less than references.length if one or more references are invalid.

Parameters:

references - an array of String elements, each containing a report part reference, either temporary or unique.

formatType - the requested output format for these report parts.

Returns:

the report parts.

Throws:

java.lang.IllegalArgumentException -
1. if all of the supplied references are invalid
2. if the OutputFormatType is of type HTML, CSV or XML.
3. if the OutputFormatType is of type DHTML and try to retrieve multiple references.

Since:

11.7

getReportParts

ReportParts getReportParts(java.lang.String[] references,
                           OutputFormatType formatType,
                           java.util.Properties properties)

Retrieves the report parts by specifying the report part references, OutputFormatType, and Properties. You can obtain the report part references by viewing document in the XMLView.

Remarks: ReportParts.getCount may be less than references.length if one or more references are invalid.

Media are the parameters that are used to format the document.

You can set the default media properties according to your preferences. You must specify the Media Types as a combination of Name and Value.

Parameters:

references - an array of String elements, each containing a report part reference, either temporary or unique.

formatType - the requested output format for these report parts.

properties - a set of properties used to customize the output. Use property names from OutputPropertiesType.

Returns:

The report parts

Throws:

java.lang.IllegalArgumentException -
1. if all of the supplied references are invalid
2. if the OutputFormatType is of type HTML, CSV or XML.
3. if the OutputFormatType is of type DHTML and try to retrieve multiple references.

Since:

11.7

See Also:

OutputPropertiesType

getXmlReportParts

ReportParts getXmlReportParts(java.lang.String[] references,
                              int filter)

Retrieves the report parts specified through references in XML format, tailored using filter.
Note: If the passed filter value id illegal, than the system will consider the value as XMLView.ALL

Remarks: ReportParts.getCount may be less than references.length if one or more references are invalid.

Parameters:

references - an array of String elements, each containing a report part reference, either temporary or unique.

filter - a bitfield allowing Xml output customization. See XMLView.

Returns:

the report parts.

Throws:

java.lang.IllegalArgumentException - if all of the supplied references are invalid.

Since:

11.7

getXmlReportParts

ReportParts getXmlReportParts(java.lang.String[] references,
                              int filter,
                              java.util.Properties properties)

Retrieves the report parts specified through references in XML format, tailored using filter. Note: If the passed filter value is illegal, than the system will consider the value as XMLView.ALL

Remarks: ReportParts.getCount may be less than references.length if one or more references are invalid.

Media are the parameters that are used to format the document.

You can set the default media properties according to your preferences. You must specify the Media Types as a combination of Name and Value.

Parameters:

references - an array of String elements, each containing a report part reference, either temporary or unique.

filter - a bitfield allowing Xml output customization. See XMLView.

properties - a set of properties used to customize the output. Use property names from OutputPropertiesType.

Returns:

the report parts.

Throws:

java.lang.IllegalArgumentException - if all of the supplied references are invalid.

Since:

11.7

See Also:

OutputPropertiesType

setReportPart

ReportPart setReportPart(java.lang.String reference)

Navigate to the report page containing the report part specified through reference.

Use ReportPart.getReport() to obtain the corresponding report page.

Parameters:

reference - a String containing a report part reference, either temporary or unique.

Returns:

the report part.

Throws:

java.lang.IllegalArgumentException - if all of the supplied reference is invalid.

Since:

11.7

getTrackData

TrackData getTrackData()

Returns the Track Data interface which gives access to the Track Data Feature.

Returns:

the Track Data Feature interface or null, if it is not supported.

Since:

12.0

getResourceManager

ResourceManager getResourceManager()

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

Retrieves the ResourceManager to upload embedded resources into the document.

An embedded resource can be an image, supported image format are : png, jpeg, gif, bmp.

Returns:

The Resource manager interface or null if it is not supported.

Since:

12.0

See Also:

ResourceManager

getLOV

Lov getLOV(java.lang.String objectID,
           LovType type,
           DataProvider dataProvider)

Retrieves a List of Values of the specified type for a given object, using data source parameter values coming from the specified DataProvider.

Parameters:

objectID - the object identifier.

type - a value from the LovType enumeration.

dataProvider - the DataProvider instance holding the DataSourceParameterValues to use.

Returns:

a Lov instance.

Since:

12.0

See Also:

DocumentInstance.getLOV(String, LovType, DataSourceParameterValues)

getLOV

Lov getLOV(java.lang.String objectID,
           LovType type,
           DataSourceParameterValues values)

Retrieves a List of Values of the specified type for a given object, using specified data source parameter values.

Parameters:

objectID - the object identifier.

type - a value from the LovType enumeration.

values - the data source parameter values.

Returns:

a Lov instance.

Since:

12.0

See Also:

DataSourceParameters.createValues()

getDefaultFormatNumber

FormatNumber getDefaultFormatNumber(FormatNumberType type)

Returns the default FormatNumber for a specific type of values. This can be used, for example, to determine the date format when entering a date for a prompt. Modifying the object returned has no effect.

When type == FormatNumberType.DATE_TIME, one may cast the returned FormatNumber into a specialized DefaultDateTimeFormatNumber in order to gain access to date and time specific formats.

Note: This function only returns a object after a document has been opened by the ReportEngine.

Parameters:

type - the value type

Returns:

the default format, or null when type == FormatNumberType.CUSTOM

Throws:

java.lang.NullPointerException - when type == null

See Also:

DefaultDateTimeFormatNumber

keepAlive

boolean keepAlive()

Checks if the document instance is alive.

Returns:

true if the document instance is alive, otherwise false.

getAutoSaveDocumentID

int getAutoSaveDocumentID()

Returns the CMS identifier of the auto-save document.

Returns:

the CMS identifier of the auto-save document, if any. Otherwise returns -1

getAvailableDps

DataProvider[] getAvailableDps()

Returns the array of available data providers in a document that have either been run or saved.

Returns:

the array of available data providers in a document that have either been run or saved.

Since:

12.2.0

See Also:

DataProviders