Package com.businessobjects.dsws.reportengine

The com.businessobjects.dsws.reportengine package is a collection of classes and methods that allow you to consume the ReportEngine service provided by a Business Objects web services provider.

See:
Description

Interface Summary

Action	The Action interface is the base interface for possible actions that can be performed on the document.
BinaryView	BinaryView is a interface used to obtain document output in binary format.
CallbackOption	The CallbackOption is the parent interface for all callback mechanisms.
CharacterView	The CharacterView is a interface for the character document output.
Close	The Close action is used to close a document and all the resources related to document.
DataProviderInfo	The DataProviderInfo contains information about the query(s) used to build the report.A WebIntelligence report may have more than one data provider.
DBLogonInfo	DBLogonInfo is used to provide information, which is used to connect to the database when a document is refreshed.
DiscretePromptValue	The DiscretePromptValue holds a single value to be used as a condition when running a BusinessObjects query.
DocumentInformation	The DocumentInformation object contains all information relevant to a document stored on a BusinessObjects server.
Drill	The Drill interface is used to set and execute a drill operation in an open document.
DrillBar	Represents a collection of drill bar objects.
DrillBarObject	DrillBarObject defines the drillable datasource object.
DrillDetail	The DrillDetail interface provides the properties and functionality of BusinessObjects Universe detail.
DrillDimension	The DrillDimension interface provides access to the properties and functionality of a BusinessObjects Universe dimension.
DrillHierarchy	The DrillHierarchy interface provides access to the properties and functionalities of a Business Objects Universe hierarchy.
DrillInfo	DrillInfo contains the necessary information to perform a drill in a document with the drill activated.
DrillLOVRetrievalMode	This interface is used to select the way to retrieve the List Of Values of a Dimension (LOV) or the List Of Values of a Detail (LOV).
DrillOperationType	This interface is used to control the Drill operation.
DrillOption	The DrillOption interface passes necessary information to the callback scripts.
DrillPath	You can use the DrillPath interface to perform the different drill operations such as drillup, drilldown, drillslice, and drillby.
EmbeddedAction	EmbeddedAction is used to provide a callback Action to document.
EmbeddedCallbackOption	A EmbeddedCallbackOption sets a script that is to be called each time EmbeddedAction is retrieved with a document view.
FillDataSourceParameterValues	FillDataSourceParameterValues interface fills the DataSourceParameterValues.
FillDBLogon	The FillDBLogon interface is used to provide the user, password, and connection information used to connect to the database when a document is refreshed.
FillDBLogons	FillDBLogons stores FillDBLogon objects used to connect to a database when a document is refreshed.
FillPassword	The FillPassword object is used to provide password information necessary to open Business Objects documents.
FillPrompt	A FillPrompt holds an array of PromptValues to be used as a condition when running a BusinessObjects query.
FillPrompts	FillPrompts holds an array of FillPrompt objects used as a condition when running a BusinessObjects query.
FillQueryContext	A QueryContext is used to resolve context prompting that may appear during document refresh.
FillQueryContexts	FillQueryContexts holds an array of FillQueryContext objects used to resolve context prompting that may appear during document refresh.
Image	The Image interface is used to return an image.
ImageManagement	The ImageManagement interface is used to set a callback script used to view images embedded in a document.
LOV	List Of Values objects are associated either with universe objects created using BusinessObjects Designer or a Crystal Report parameter.
LOVBatch	The LOVBatch objects are associated with RetrieveDrillInfo and RetrievePromptsInfo object.
LovDisplayType	The LovDisplayType interface allows you to select the way you want the LOVs to be displayed.
LOVSearch	The LOVSearch objects are associated with RetrieveDrillInfo and RetrievePromptsInfo object.
LOVSort	The LOVSort objects are associated with RetrieveDrillInfo and RetrievePromptsInfo object Using a LOV Sort, values of the LOV can be sorted based on the SortType selected.
ModifyDrillBar	ModifyDrillBar interface is used to modify existing drill bar objects.
Navigate	Navigate interface is used to navigate with in the document.
NavigateToDataProvider	The NavigateToDataProvider interface is used to navigate from one data provider (query) to another data provider (query).
NavigateToFirstPage	NavigateToFirstPage is used to set the current page of a document to the first page.
NavigateToLastPage	NavigateToLastPage is used to set the current page of a document to the last page.
NavigateToPage	The NavigateToPage interface is used to set the current page of a document to a specific page.
NavigateToPath	The NavigateToPath interface is used to set the current page of a document to a specific path.
NavigateToReportPart	The NavigateToReportPart interface is used to navigate to a particular part (For example, section, cell, table) of the report.
NavigationNode	The NavigationNode interface exposes the document structure.
ObjectQualification	ObjectQualification interface represents all BusinessObjects Universe object types.
OutputFormatType	OutputFormatType is used to control the format in which a document is viewed.
PromptInfo	The PromptInfo interface is used to resolve the prompting that appears during query refresh.
PromptLOVRetrievalMode	PromptLOVRetrievalMode controls the way the List Of Values for a Prompt is retrieved.
PromptType	PromptType defines the type of information that may be contained in a prompt.
PromptValue	PromptValue is parent interface used to hold a prompt values.
QueryContext	A QueryContext is used to resolve context prompting that may appear during document refresh.
RangePromptValue	A RangePromptValue holds a range of values to be used as a condition when running a BusinessObjects query.
Refresh	The refresh action is used to refresh data in a document.
Report	The Report object holds information about a report contained in a document.
ReportPart	ReportPart interface is used to access a part in a particular report (for example, section or table or column)
ReportState	ReportState holds information about the condition of the report currently selected by the user.
RetrieveBinaryView	RetrieveBinaryView is used to retrieve document data in binary format inside a DocumentInformation object.
RetrieveCharacterView	RetrieveCharacterView is used to retrieve document data in text format inside a DocumentInformation object.
RetrieveCurrentReportState	RetrieveCurrentReportState is used to retrieve the state of the report currently open inside a DocumentInformation object.
RetrieveData	The RetrieveData interface is used to select the information stored in the DocumentInformation object returned by the ReportEngine.getDocumentInformation Web Service call.
RetrieveDataProvidersInfo	RetrieveDataProvidersInfo is used to retrieve information about a document's DataProvider(s) inside a DocumentInformation object.
RetrieveDataSourceParameterValues	The RetrieveDataSourceParameterValues interface is to obtain the data source parameter values.
RetrieveDBLogonInfo	RetrieveDBLogonInfo is used to retrieve an array of DBLogonInfo inside the DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call.
RetrieveDrillInfo	RetrieveDrillInfo is used to retrieve information about the possible Drill Actions that can be performed on a document.
RetrieveMustFillInfo	The RetrieveMustFillInfo interface controls information that has to be supplied to the document for it to Refresh correctly.
RetrieveNavigationMap	RetrieveNavigationMap is used to retrieve information about the structure of a document.
RetrievePromptsInfo	RetrievePromptsInfo interface is used to retrieve the PromptsInfo objects necessary for a successful document refresh.
RetrieveQueryContext	RetrieveQueryContext is used to retrieve QueryContexts information necessary to refresh a document.
RetrieveReportList	RetrieveReportList is used to retrieve a list of reports contained in a document.
RetrieveTrackData	RetrieveTrackData interface is used to retrieve the TrackDatainformation.
RetrieveView	RetrieveView is used to set the format in which a document is retrieved from the Web Services provider.
RetrieveViewSupport	RetrieveViewSupport is used to retrieve the list of ViewSupport in which it is possible to display the document.
RetrieveXMLView	RetrieveXMLView is used to retrieve document data in XML format inside a DocumentInformation object.
SortType	The SortType object defines the different sorts that have been defined on a List Of Values(LOV).
TrackData	TrackData interface is used to track the data changes in the document.
TrackDataViewMode	TrackDataViewMode interface defines the different view mode types.
TransportType	TransportType is used to set the type of data passed inside a SOAP message.
UpdateTrackData	UpdateTrackData interface updates the track data options set by user.
Value	The Value interface is a row in a List Of Values (LOV) Lists Of Values are associated with Universes created using BusinessObjects Designer.
View	The View interface is the parent interface for all possible data formats returned by the DocumentInformation object.
ViewModeType	The ViewModeType interface is used to control the way in which you view a document.
ViewSupport	ViewSupport objects are used to control the format in which a document is retrieved from the Web Services Server.
ViewType	ViewType is used to control the way in which a document is retrieved.
XMLView	XMLView interface is used to output the report's view in XML format.

Class Summary

Action.Factory	A class with methods for creating instances of the Action type.
BinaryView.Factory	A class with methods for creating instances of the BinaryView type.
CallbackOption.Factory	A class with methods for creating instances of the CallbackOption type.
CharacterView.Factory	A class with methods for creating instances of the CharacterView type.
Close.Factory	A class with methods for creating instances of the Close type.
DataProviderInfo.Factory	A class with methods for creating instances of the DataProviderInfo type.
DBLogonInfo.Factory	A class with methods for creating instances of the DBLogonInfo type.
DiscretePromptValue.Factory	A class with methods for creating instances of the DiscretePromptValue type.
DocumentInformation.Factory	A class with methods for creating instances of the Documentinformation type
Drill.Factory	A class with methods for creating instances of the Drill type.
DrillBar.Factory	A class with methods for creating instances of the DrillBar type.
DrillBarObject.Factory	A class with methods for creating instances of the DrillBarObject type.
DrillDetail.Factory	A class with methods for creating instances of the DrillDetail type.
DrillDimension.Factory	A class with methods for creating instances of the DrillDimension type.
DrillHierarchy.Factory	A class with methods for creating instances of the DrillHierarchy type.
DrillInfo.Factory	A class with methods for creating instances of the DrillInfo type.
DrillLOVRetrievalMode.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.DrillLOVRetrievalMode.
DrillLOVRetrievalMode.Factory	A class with methods for creating instances of the DrillLOVRetrievalMode type.
DrillOperationType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.DrillOperationType.
DrillOperationType.Factory	A class with methods for creating instances of the DrillOperationType type.
DrillOption.Factory	A class with methods for creating instances of the DrillOption type.
DrillPath.Factory	A factory class with static methods for creating instances of this type.
EmbeddedAction.Factory	A class with methods for creating instances of the EmbeddedAction type.
EmbeddedCallbackOption.Factory	A class with methods for creating instances of the EmbeddedCallbackOption type.
FillDataSourceParameterValues.Factory	A class with methods for creating instances of the FillDataSourceParameterValues type.
FillDBLogon.Factory	A class with methods for creating instances of the FillDBLogon type.
FillDBLogons.Factory	A class with methods for creating instances of the FillDBLogons type.
FillPassword.Factory	A class with methods for creating instances of the FillPassword type.
FillPrompt.Factory	A class with methods for creating instances of the FillPrompt type.
FillPrompts.Factory	A class with methods for creating instances of the FillPrompts type.
FillQueryContext.Factory	A class with methods for creating instances of the FillQueryContext type.
FillQueryContexts.Factory	A class with methods for creating instances of the FillQueryContexts type.
Image.Factory	A class with methods for creating instances of the Image type.
ImageManagement.Factory	A class with methods for creating instances of the ImageManagement type.
LOV.Factory	A class with methods for creating instances of the LOV type.
LOVBatch.Factory	A class with methods for creating instances of the LOVBatch type.
LovDisplayType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.LovDisplayType.
LovDisplayType.Factory	A class with methods for creating instances of the LovDisplayType type.
LOVSearch.Factory	A class with methods for creating instances of the LOVSearch type.
LOVSort.Factory	A class with methods for creating instances of the LOVSort type.
ModifyDrillBar.Factory	A class with methods for creating instances of the ModifyDrillBar type.
Navigate.Factory	A class with methods for creating instances of the Navigate type.
NavigateToDataProvider.Factory	A class with methods for creating instances of the NavigateToDataProvider type.
NavigateToFirstPage.Factory	A class with methods for creating instances of the NavigateToFirstPage type.
NavigateToLastPage.Factory	A class with methods for creating instances of the NavigateToLastPage type.
NavigateToPage.Factory	A class with methods for creating instances of the NavigateToPage type.
NavigateToPath.Factory	A class with methods for creating instances of the NavigateToPath type.
NavigateToReportPart.Factory	A class with methods for creating instances of the NavigateToReportPart type.
NavigationNode.Factory	A class with methods for creating instances of the NavigationNode type.
ObjectQualification.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.ObjectQualification.
ObjectQualification.Factory	A class with methods for creating instances of the ObjectQualification type.
OutputFormatType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.OutputFormatType.
OutputFormatType.Factory	A class with methods for creating instances of the OutputFormatType type.
PromptInfo.Factory	A class with methods for creating instances of the PromptInfo type.
PromptLOVRetrievalMode.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.PromptLOVRetrievalMode.
PromptLOVRetrievalMode.Factory	A class with methods for creating instances of the PromptLOVRetrievalMode type.
PromptType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.PromptType.
PromptType.Factory	A class with methods for creating instances of the PromptType type.
PromptValue.Factory	A class with methods for creating instances of the PromptValue type.
QueryContext.Factory	A class with methods for creating instances of the QueryContext type.
RangePromptValue.Factory	A class with methods for creating instances of the RangePromptValue type.
Refresh.Factory	A class with methods for creating instances of the Refresh type.
Report.Factory	A class with methods for creating instances of the Report type.
ReportEngine	ReportEngine class is a proxy that can consume the ReportEngine Web Service and that is mapped on its WSDL.
ReportPart.Factory	A class with methods for creating instances of the ReportPart type.
ReportState.Factory	A class with methods for creating instances of the ReportState type.
RetrieveBinaryView.Factory	A class with methods for creating instances of the RetrieveBinaryView type.
RetrieveCharacterView.Factory	A class with methods for creating instances of the RetrieveCharacterView type.
RetrieveCurrentReportState.Factory	A class with methods for creating instances of the RetrieveCurrentReportState type.
RetrieveData.Factory	A class with methods for creating instances of the RetrieveData type.
RetrieveDataProvidersInfo.Factory	A class with methods for creating instances of the RetrieveDataProvidersInfo type.
RetrieveDataSourceParameterValues.Factory	A class with methods for creating instances of the RetrieveDataSourceParameterValues type.
RetrieveDBLogonInfo.Factory	A class with methods for creating instances of the RetrieveDBLogonInfo type.
RetrieveDrillInfo.Factory	A class with methods for creating instances of the RetrieveDrillInfo type.
RetrieveMustFillInfo.Factory	A class with methods for creating instances of the RetrieveMustFillInfo type.
RetrieveNavigationMap.Factory	A class with methods for creating instances of the RetrieveNavigationMap type.
RetrievePromptsInfo.Factory	A class with methods for creating instances of the RetrievePromptsInfo type.
RetrieveQueryContext.Factory	A class with methods for creating instances of the RetrieveQueryContext type.
RetrieveReportList.Factory	A class with methods for creating instances of the RetrieveReportList type.
RetrieveTrackData.Factory	A class with methods for creating instances of the RetrieveTrackData type.
RetrieveView.Factory	A class with methods for creating instances of the RetrieveView type.
RetrieveViewSupport.Factory	A class with methods for creating instances of the RetrieveViewSupport type.
RetrieveXMLView.Factory	A class with methods for creating instances of the RetrieveXMLView type.
SortType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.SortType.
SortType.Factory	A class with methods for creating instances of the SortType type.
TrackData.Factory	A class with methods for creating instances of the TrackData type.
TrackDataViewMode.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.TrackDataViewMode.
TrackDataViewMode.Factory	A class with methods for creating instances of the TrackDataViewMode type.
TransportType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.TransportType.
TransportType.Factory	A class with methods for creating instances of the TransportType type.
UpdateTrackData.Factory	A class with methods for creating instances of the UpdateTrackData type.
Value.Factory	A class with methods for creating instances of the Value type.
View.Factory	A class with methods for creating instances of the View type.
ViewModeType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.ViewModeType.
ViewModeType.Factory	A class with methods for creating instances of the ViewModeType type.
ViewSupport.Factory	A class with methods for creating instances of the ViewSupport type.
ViewType.Enum	Enumeration value class for com.businessobjects.dsws.reportengine.ViewType.
ViewType.Factory	A class with methods for creating instances of the ViewType type.
XMLView.Factory	A class with methods for creating instances of the XMLView type.

Package com.businessobjects.dsws.reportengine Description

The com.businessobjects.dsws.reportengine package is a collection of classes and methods that allow you to consume the ReportEngine service provided by a Business Objects web services provider.