com.businessobjects.dsws.reportengine
Interface DocumentInformation

public interface DocumentInformation

The DocumentInformation object contains all information relevant to a document stored on a BusinessObjects server.
Members of the DocumentInformation interface can be divided in 2 categories:

1. Members that are always included with this object:
   • DocumentReference
   • Name
   • FileType
   • MimeType
   • MustFillPassword
   • MustFillPrompts
   • MustFillQueryContexts
   • MustFillDBLogons
   • Author
   • CreationDate
   • Refreshable
   • RefreshOnOpen
   • ViewChunkable
   • Drillable
2. Members that must be requested explicitly:
   • CurrentReportState
   • Reports
   • View
   • DrillInfo
   • DataProviderInfo
   • NavigationMap
   • ViewSupports
   • PromptInfo
   • QueryContexts
   • DBLogonInfos
   • TrackData

See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation

Nested Class Summary

static class

DocumentInformation.Factory A class with methods for creating instances of the Documentinformation type

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

ReportState	addNewCurrentReportState() Internal Use Only.
DataProviderInfo	addNewDataProviderInfo() Internal Use Only.
DataSourceParameterValue	addNewDataSourceParameterValues() Internal Use Only.
DBLogonInfo	addNewDBLogonInfos() Internal Use Only.
DrillInfo	addNewDrillInfo() Internal Use Only.
NavigationNode	addNewNavigationMap() Internal Use Only.
PromptInfo	addNewPromptInfo() Internal Use Only.
QueryContext	addNewQueryContexts() Internal Use Only.
Report	addNewReports() Internal Use Only.
TrackData	addNewTrackData() Internal Use Only.
View	addNewView() Internal Use Only.
ViewSupport	addNewViewSupports() Internal Use Only.
java.lang.String	getAuthor() Returns the name of the document author.
java.util.Calendar	getCreationDate() Returns the date the document was created.
ReportState	getCurrentReportState() Returns the current state of the document instance.
DataProviderInfo[]	getDataProviderInfoArray() Retrieves information about the source (query) used to provide data for this document.
DataProviderInfo	getDataProviderInfoArray(int i) Retrieves information about a single source used to provide data for this document.
DataSourceParameterValue[]	getDataSourceParameterValuesArray() Gets an array of all DataSourceParameterValues elements.
DataSourceParameterValue	getDataSourceParameterValuesArray(int i) Gets the ith DataSourceParameterValues element.
boolean	getDataSourceParameterValuesRequired() Gets the DataSourceParameterValuesRequired attribute.
DBLogonInfo[]	getDBLogonInfosArray() Retrieves a list of DBLogonInfo containing information about databases needing login information for the query to run correctly.
DBLogonInfo	getDBLogonInfosArray(int i) Retrieves a single of DBLogonInfo containing information about a database needing login information for the query to run correctly.
java.lang.String	getDocumentReference() Returns a reference allowing the user to navigate through different states of this document.
boolean	getDrillable() Returns true if the document is drillable.
DrillInfo	getDrillInfo() Returns information about a document with the Drill activated.
java.lang.String	getFileType() Returns the type of the document.
java.lang.String	getMimeType() Returns the document Mime type.
boolean	getMustFillDBLogons() Returns true if the current user has to log in to a database when this document is opened for the query to run correctly.
boolean	getMustFillPassword() Returns true if the current user has to fill in passwords to open this document.
boolean	getMustFillPrompts() Returns true if the current user has to fill in prompts to open this document.
boolean	getMustFillQueryContexts() Returns true if the current user has to fill QueryContexts to open this document.
java.lang.String	getName() Returns the name of the document.
NavigationNode[]	getNavigationMapArray() Returns an array containing the structure of the document.
NavigationNode	getNavigationMapArray(int i) Returns a NavigationNode associated to single section or sub section of the document structure.
PromptInfo[]	getPromptInfoArray() Returns a list of prompts to be filled when the document is opened.
PromptInfo	getPromptInfoArray(int i) Returns a single prompt from the list of prompts to be filled when the document is opened.
QueryContext[]	getQueryContextsArray() Returns a list of QueryContexts to be resolved when the document is opened.
QueryContext	getQueryContextsArray(int i) Returns a single QueryContext to be resolved when the document is opened.
boolean	getRefreshable() Returns true if the current user has the right to refresh this document.
boolean	getRefreshOnOpen() Returns true if this Document object is refreshed when it is opened.
Report[]	getReportsArray() Returns the Reports contained in this document.
Report	getReportsArray(int i) Returns a single Report from this document.
TrackData	getTrackData() Gets the TrackData element.
View	getView() Returns a formatted view containing the information stored in the document.
boolean	getViewChunkable() Returns true if the web service is able to send the document's view data in separate blocks (or chunks).
ViewSupport[]	getViewSupportsArray() Returns an array of the different formats in which it is possible to view this document.
ViewSupport	getViewSupportsArray(int i) Returns a single view format supported by this document.
DataProviderInfo	insertNewDataProviderInfo(int i) Internal Use Only.
DataSourceParameterValue	insertNewDataSourceParameterValues(int i) Internal Use Only.
DBLogonInfo	insertNewDBLogonInfos(int i) Internal Use Only.
NavigationNode	insertNewNavigationMap(int i) Internal Use Only.
PromptInfo	insertNewPromptInfo(int i) Internal Use Only.
QueryContext	insertNewQueryContexts(int i) Internal Use Only.
Report	insertNewReports(int i) Internal Use Only.
ViewSupport	insertNewViewSupports(int i) Internal Use Only.
boolean	isNilCurrentReportState() Checks if the CurrentReportState element is nil.
boolean	isNilDataProviderInfoArray(int i) Checks if the ith DataProviderInfo element is nil.
boolean	isNilDataSourceParameterValuesArray(int i) Checks if the ith DataSourceParameterValues element is nil.
boolean	isNilDBLogonInfosArray(int i) Checks if the ith DBLogonInfos element is nil.
boolean	isNilDrillInfo() Checks if the DrillInfo element is nil.
boolean	isNilNavigationMapArray(int i) Checks if the ith NavigationMap element.
boolean	isNilPromptInfoArray(int i) Checks if the ith PromptInfo element is nil.
boolean	isNilQueryContextsArray(int i) Checks if the ith QueryContexts element is nil.
boolean	isNilReportsArray(int i) Checks if the ith Reports element is nil.
boolean	isNilTrackData() Checks if the TrackData element is nil.
boolean	isNilView() Checks if the View element is nil.
boolean	isNilViewSupportsArray(int i) Checks if the ith ViewSupports element is nil.
boolean	isSetCurrentReportState() Checks if the CurrentReportState element is set.
boolean	isSetDocumentReference() Checks if the DocumentReference attribute is set.
boolean	isSetDrillable() Checks if the Drillable attribute is set.
boolean	isSetDrillInfo() Checks if the DrillInfo element is set.
boolean	isSetFileType() Checks if the FileType attribute is set.
boolean	isSetMimeType() Checks if the MimeType attribute is set.
boolean	isSetName() Checks if the Name attribute is set.
boolean	isSetRefreshOnOpen() Checks if the RefreshOnOpen attribute is set.
boolean	isSetTrackData() Checks if the TrackData element is set.
boolean	isSetView() Checks if the View element is set.
boolean	isSetViewChunkable() Checks if the ViewChunkable attribute is set.
void	removeDataProviderInfo(int i) Internal Use Only.
void	removeDataSourceParameterValues(int i) Internal Use Only.
void	removeDBLogonInfos(int i) Removes the ith DBLogonInfos element.
void	removeNavigationMap(int i) Internal Use Only.
void	removePromptInfo(int i) Internal Use Only.
void	removeQueryContexts(int i) Internal Use Only.
void	removeReports(int i) Internal Use Only.
void	removeViewSupports(int i) Internal Use Only.
void	setAuthor(java.lang.String author) Internal Use Only.
void	setCreationDate(java.util.Calendar creationDate) Internal Use Only.
void	setCurrentReportState(ReportState currentReportState) Internal Use Only.
void	setDataProviderInfoArray(DataProviderInfo[] dataProviderInfoArray) Internal Use Only.
void	setDataProviderInfoArray(int i, DataProviderInfo dataProviderInfo) Internal Use Only.
void	setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray) Internal Use Only.
void	setDataSourceParameterValuesArray(int i, DataSourceParameterValue dataSourceParameterValues) Internal Use Only.
void	setDataSourceParameterValuesRequired(boolean dataSourceParameterValuesRequired) Sets the DataSourceParameterValuesRequired attribute
void	setDBLogonInfosArray(DBLogonInfo[] dbLogonInfosArray) Internal Use Only.
void	setDBLogonInfosArray(int i, DBLogonInfo dbLogonInfos) Internal Use Only.
void	setDocumentReference(java.lang.String documentReference) Internal Use Only.
void	setDrillable(boolean drillable) Internal Use Only.
void	setDrillInfo(DrillInfo drillInfo) Internal Use Only.
void	setFileType(java.lang.String fileType) Internal Use Only.
void	setMimeType(java.lang.String mimeType) Internal Use Only.
void	setMustFillDBLogons(boolean mustFillDBLogons) Internal Use Only.
void	setMustFillPassword(boolean mustFillPassword) Internal Use Only.
void	setMustFillPrompts(boolean mustFillPrompts) Internal Use Only.
void	setMustFillQueryContexts(boolean mustFillQueryContexts) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNavigationMapArray(int i, NavigationNode navigationMap) Internal Use Only.
void	setNavigationMapArray(NavigationNode[] navigationMapArray) Internal Use Only.
void	setNilCurrentReportState() Internal Use Only.
void	setNilDataProviderInfoArray(int i) Internal Use Only.
void	setNilDataSourceParameterValuesArray(int i) Internal Use Only.
void	setNilDBLogonInfosArray(int i) Internal Use Only.
void	setNilDrillInfo() Internal Use Only.
void	setNilNavigationMapArray(int i) Internal Use Only.
void	setNilPromptInfoArray(int i) Internal Use Only.
void	setNilQueryContextsArray(int i) Internal Use Only.
void	setNilReportsArray(int i) Internal Use Only.
void	setNilTrackData() Internal Use Only.
void	setNilView() Internal Use Only.
void	setNilViewSupportsArray(int i) Internal Use Only.
void	setPromptInfoArray(int i, PromptInfo promptInfo) Internal Use Only.
void	setPromptInfoArray(PromptInfo[] promptInfoArray) Internal Use Only.
void	setQueryContextsArray(int i, QueryContext queryContexts) Internal Use Only.
void	setQueryContextsArray(QueryContext[] queryContextsArray) Internal Use Only.
void	setRefreshable(boolean refreshable) Internal Use Only.
void	setRefreshOnOpen(boolean refreshOnOpen) Internal Use Only.
void	setReportsArray(int i, Report reports) Internal Use Only.
void	setReportsArray(Report[] reportsArray) Internal Use Only.
void	setTrackData(TrackData trackData) Internal Use Only.
void	setView(View view) Internal Use Only.
void	setViewChunkable(boolean viewChunkable) Internal Use Only.
void	setViewSupportsArray(int i, ViewSupport viewSupports) Internal Use Only.
void	setViewSupportsArray(ViewSupport[] viewSupportsArray) Internal Use Only.
int	sizeOfDataProviderInfoArray() Returns the number of DataProviderInfo element
int	sizeOfDataSourceParameterValuesArray() Returns the number of DataSourceParameterValues element.
int	sizeOfDBLogonInfosArray() Returns the number of DBLogonInfos element.
int	sizeOfNavigationMapArray() Returns the number of "NavigationMap" element.
int	sizeOfPromptInfoArray() Returns the number of PromptInfo element
int	sizeOfQueryContextsArray() Returns the number of QueryContexts element.
int	sizeOfReportsArray() Returns the number of Reports element.
int	sizeOfViewSupportsArray() Returns the number of ViewSupports element.
void	unsetCurrentReportState() Internal Use Only.
void	unsetDocumentReference() Internal Use Only.
void	unsetDrillable() Internal Use Only.
void	unsetDrillInfo() Internal Use Only.
void	unsetFileType() Internal Use Only.
void	unsetMimeType() Internal Use Only.
void	unsetName() Internal Use Only.
void	unsetRefreshOnOpen() Internal Use Only.
void	unsetTrackData() Internal Use Only.
void	unsetView() Internal Use Only.
void	unsetViewChunkable() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetAuthor() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetCreationDate() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetDataSourceParameterValuesRequired() Internal use only
org.apache.xmlbeans.XmlString	xgetDocumentReference() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetDrillable() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFileType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetMustFillDBLogons() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetMustFillPassword() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetMustFillPrompts() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetMustFillQueryContexts() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshable() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshOnOpen() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetViewChunkable() Internal Use Only.
void	xsetAuthor(org.apache.xmlbeans.XmlString author) Internal Use Only.
void	xsetCreationDate(org.apache.xmlbeans.XmlDateTime creationDate) Internal Use Only.
void	xsetDataSourceParameterValuesRequired(org.apache.xmlbeans.XmlBoolean dataSourceParameterValuesRequired) Internal Use only
void	xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference) Internal Use Only.
void	xsetDrillable(org.apache.xmlbeans.XmlBoolean drillable) Internal Use Only.
void	xsetFileType(org.apache.xmlbeans.XmlString fileType) Internal Use Only.
void	xsetMimeType(org.apache.xmlbeans.XmlString mimeType) Internal Use Only.
void	xsetMustFillDBLogons(org.apache.xmlbeans.XmlBoolean mustFillDBLogons) Internal Use Only.
void	xsetMustFillPassword(org.apache.xmlbeans.XmlBoolean mustFillPassword) Internal Use Only.
void	xsetMustFillPrompts(org.apache.xmlbeans.XmlBoolean mustFillPrompts) Internal Use Only.
void	xsetMustFillQueryContexts(org.apache.xmlbeans.XmlBoolean mustFillQueryContexts) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetRefreshable(org.apache.xmlbeans.XmlBoolean refreshable) Internal Use Only.
void	xsetRefreshOnOpen(org.apache.xmlbeans.XmlBoolean refreshOnOpen) Internal Use Only.
void	xsetViewChunkable(org.apache.xmlbeans.XmlBoolean viewChunkable) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getCurrentReportState

ReportState getCurrentReportState()

Returns the current state of the document instance. ReportState contains the information about the current report including:

• Current active page.
• If the report drill is active.
• The path to the report.

Returns:

The state of the current report.

isNilCurrentReportState

boolean isNilCurrentReportState()

Checks if the CurrentReportState element is nil.

Returns:

true if the CurrentreportState element is nil, otherwise false.

isSetCurrentReportState

boolean isSetCurrentReportState()

Checks if the CurrentReportState element is set.

Returns:

true if the CurrentReportState element is set, otherwise false.

setCurrentReportState

void setCurrentReportState(ReportState currentReportState)

Internal Use Only.

addNewCurrentReportState

ReportState addNewCurrentReportState()

Internal Use Only.

setNilCurrentReportState

void setNilCurrentReportState()

Internal Use Only.

unsetCurrentReportState

void unsetCurrentReportState()

Internal Use Only.

getReportsArray

Report[] getReportsArray()

Returns the Reports contained in this document.

Returns:

an array of Reports contained in the document.

getReportsArray

Report getReportsArray(int i)

Returns a single Report from this document.

Parameters:

i - the index of the required report in the reports array.

Returns:

a single report.

isNilReportsArray

boolean isNilReportsArray(int i)

Checks if the ith Reports element is nil.

Parameters:

i - the index of the Report element.

Returns:

true if the Report element is nil, otherwise false.

sizeOfReportsArray

int sizeOfReportsArray()

Returns the number of Reports element.

Returns:

the size of the Report array

setReportsArray

void setReportsArray(Report[] reportsArray)

Internal Use Only.

setReportsArray

void setReportsArray(int i,
                     Report reports)

Internal Use Only.

setNilReportsArray

void setNilReportsArray(int i)

Internal Use Only.

insertNewReports

Report insertNewReports(int i)

Internal Use Only.

addNewReports

Report addNewReports()

Internal Use Only.

removeReports

void removeReports(int i)

Internal Use Only.

getView

View getView()

Returns a formatted view containing the information stored in the document.

Example: Retrieve a documents contents in character HTML format

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveView(RetrieveView.Factory.newInstance());
 DocumentInformation docInfo = objReportEngine.getDocumentInformation(docid,null,null,null,retBOData);

 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 out.print(docContents);
 

Returns:

a view containing the information stored in the document.

See Also:

ReportEngine, CharacterView, BinaryView, XMLView, ViewSupport, ViewModeType, RetrieveData, RetrieveView, OutputFormatType

isNilView

boolean isNilView()

Checks if the View element is nil.

Returns:

true if the view element is nil, otherwise false.

isSetView

boolean isSetView()

Checks if the View element is set.

Returns:

true if the view element is set, otherwise false.

setView

void setView(View view)

Internal Use Only.

addNewView

View addNewView()

Internal Use Only.

setNilView

void setNilView()

Internal Use Only.

unsetView

void unsetView()

Internal Use Only.

getDrillInfo

DrillInfo getDrillInfo()

Returns information about a document with the Drill activated. DrillInfo contains drill information including:

• Current active block.
• Drill hierarchies.
• Drill Details.
• Drill Dimensions.
• Drill scope information.

Returns:

information about the drill.

See Also:

Action, CallbackOption, EmbeddedCallbackOption, ImageManagement, RetrieveView, RetrieveData, ReportEngine, DocumentInformation

isNilDrillInfo

boolean isNilDrillInfo()

Checks if the DrillInfo element is nil.

Returns:

true if the DrillInfo element is nil, otherwise false.

isSetDrillInfo

boolean isSetDrillInfo()

Checks if the DrillInfo element is set.

Returns:

true if the DrillInfo element is set, otherwise false.

setDrillInfo

void setDrillInfo(DrillInfo drillInfo)

Internal Use Only.

addNewDrillInfo

DrillInfo addNewDrillInfo()

Internal Use Only.

setNilDrillInfo

void setNilDrillInfo()

Internal Use Only.

unsetDrillInfo

void unsetDrillInfo()

Internal Use Only.

getDataProviderInfoArray

DataProviderInfo[] getDataProviderInfoArray()

Retrieves information about the source (query) used to provide data for this document.

Example: Retrieve a documents DataProviders.

 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveDataProvidersInfo retBoDP = RetrieveDataProvidersInfo.Factory.newInstance();
 retBOData.setRetrieveDataProvidersInfo(retBoDP);
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(strBODocuid, null, null, null, retBOData);
 DataProviderInfo[] docDataProviders = boDocInfo.getDataProviderInfoArray();
 

Returns:

an array of the DataProviders used by this document.

See Also:

RetrieveView, RetrieveData, RetrieveDataProvidersInfo, ReportEngine, DataProviderInfo

getDataProviderInfoArray

DataProviderInfo getDataProviderInfoArray(int i)

Retrieves information about a single source used to provide data for this document.

Parameters:

i - index of the DataProviderInfo to be retrieved.

Returns:

a single DataProviderInfo.

See Also:

com.businessobjects.dsws.reportengine.DocumentInformation#getDataProviderInfo()

isNilDataProviderInfoArray

boolean isNilDataProviderInfoArray(int i)

Checks if the ith DataProviderInfo element is nil.

Returns:

true if the DataProviderInfo element is nil, otherwise false.

sizeOfDataProviderInfoArray

int sizeOfDataProviderInfoArray()

Returns the number of DataProviderInfo element

Returns:

the size of the DataProviderInfo array

setDataProviderInfoArray

void setDataProviderInfoArray(DataProviderInfo[] dataProviderInfoArray)

Internal Use Only.

setDataProviderInfoArray

void setDataProviderInfoArray(int i,
                              DataProviderInfo dataProviderInfo)

Internal Use Only.

setNilDataProviderInfoArray

void setNilDataProviderInfoArray(int i)

Internal Use Only.

insertNewDataProviderInfo

DataProviderInfo insertNewDataProviderInfo(int i)

Internal Use Only.

addNewDataProviderInfo

DataProviderInfo addNewDataProviderInfo()

Internal Use Only.

removeDataProviderInfo

void removeDataProviderInfo(int i)

Internal Use Only.

getNavigationMapArray

NavigationNode[] getNavigationMapArray()

Returns an array containing the structure of the document. The NavigationNode interface exposes the document structure. The root level contains the name of the reports, the leaves are associated to sections and sub sections. This model is exposed as a tree.

Returns:

an array of NavigationNodes.

getNavigationMapArray

NavigationNode getNavigationMapArray(int i)

Returns a NavigationNode associated to single section or sub section of the document structure.

Parameters:

i - index of the NavigationNode to be retrieved.

Returns:

a NavigationNode object.

isNilNavigationMapArray

boolean isNilNavigationMapArray(int i)

Checks if the ith NavigationMap element.

Parameters:

i - the index of the NavigationMap element.

Returns:

true if the NavigationMap element is nil, otherwise false.

sizeOfNavigationMapArray

int sizeOfNavigationMapArray()

Returns the number of "NavigationMap" element.

Returns:

the size of the NavigationMap array.

setNavigationMapArray

void setNavigationMapArray(NavigationNode[] navigationMapArray)

Internal Use Only.

setNavigationMapArray

void setNavigationMapArray(int i,
                           NavigationNode navigationMap)

Internal Use Only.

setNilNavigationMapArray

void setNilNavigationMapArray(int i)

Internal Use Only.

insertNewNavigationMap

NavigationNode insertNewNavigationMap(int i)

Internal Use Only.

addNewNavigationMap

NavigationNode addNewNavigationMap()

Internal Use Only.

removeNavigationMap

void removeNavigationMap(int i)

Internal Use Only.

getViewSupportsArray

ViewSupport[] getViewSupportsArray()

Returns an array of the different formats in which it is possible to view this document.

Returns:

An array of different view formats.

See Also:

BinaryView, CharacterView, XMLView, ViewModeType, ViewSupport, OutputFormatType

getViewSupportsArray

ViewSupport getViewSupportsArray(int i)

Returns a single view format supported by this document.

Parameters:

i - index of the ViewSupport to be retrieved.

Returns:

a view format supported by this document.

isNilViewSupportsArray

boolean isNilViewSupportsArray(int i)

Checks if the ith ViewSupports element is nil.

Parameters:

i - the index of the ViewSupport element.

Returns:

true if the ViewSupport element is nil, otherwise false.

sizeOfViewSupportsArray

int sizeOfViewSupportsArray()

Returns the number of ViewSupports element.

Returns:

the size of the ViewSupport array

setViewSupportsArray

void setViewSupportsArray(ViewSupport[] viewSupportsArray)

Internal Use Only.

setViewSupportsArray

void setViewSupportsArray(int i,
                          ViewSupport viewSupports)

Internal Use Only.

setNilViewSupportsArray

void setNilViewSupportsArray(int i)

Internal Use Only.

insertNewViewSupports

ViewSupport insertNewViewSupports(int i)

Internal Use Only.

addNewViewSupports

ViewSupport addNewViewSupports()

Internal Use Only.

removeViewSupports

void removeViewSupports(int i)

Internal Use Only.

getPromptInfoArray

PromptInfo[] getPromptInfoArray()

Returns a list of prompts to be filled when the document is opened.

Example: Return the list of prompts associated to a document.

 DocumentInformation boDocInfo = boRepEng.getDocumentInformation(docid,fillInfo,actions,null,null);
 if (boDocInfo.getMustFillPrompts())
 {
                PromptInfo[] boPromptInfo = boDocInfo.getPromptInfoArray();

 }
 

Returns:

a list of prompts to be filled.

See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine

getPromptInfoArray

PromptInfo getPromptInfoArray(int i)

Returns a single prompt from the list of prompts to be filled when the document is opened.

Parameters:

i - index of the PromptInfo to be retrieved.

Returns:

a single PromptInfo.

isNilPromptInfoArray

boolean isNilPromptInfoArray(int i)

Checks if the ith PromptInfo element is nil.

Parameters:

i - the index of the Promptinfo element.

Returns:

true if the PromptInfo element is nil, otherwise false.

sizeOfPromptInfoArray

int sizeOfPromptInfoArray()

Returns the number of PromptInfo element

Returns:

the size of the PromptInfo array

setPromptInfoArray

void setPromptInfoArray(PromptInfo[] promptInfoArray)

Internal Use Only.

setPromptInfoArray

void setPromptInfoArray(int i,
                        PromptInfo promptInfo)

Internal Use Only.

setNilPromptInfoArray

void setNilPromptInfoArray(int i)

Internal Use Only.

insertNewPromptInfo

PromptInfo insertNewPromptInfo(int i)

Internal Use Only.

addNewPromptInfo

PromptInfo addNewPromptInfo()

Internal Use Only.

removePromptInfo

void removePromptInfo(int i)

Internal Use Only.

getQueryContextsArray

QueryContext[] getQueryContextsArray()

Returns a list of QueryContexts to be resolved when the document is opened.
A Context is used to avoid ambiguity when defining a query.
QueryContext is used to resolve context prompting that may appear during document refresh.

Returns:

A list of QueryContexts.

getQueryContextsArray

QueryContext getQueryContextsArray(int i)

Returns a single QueryContext to be resolved when the document is opened.
A Context is used to avoid ambiguity when defining a query.
QueryContext is used to resolve context prompting that may appear during document refresh.

Parameters:

i - index of the QueryContext to be retrieved.

Returns:

A single QueryContext object.

isNilQueryContextsArray

boolean isNilQueryContextsArray(int i)

Checks if the ith QueryContexts element is nil.

Parameters:

i - the index of the QueryContext element.

Returns:

true if the QueryContext element is nil, otherwise false.

sizeOfQueryContextsArray

int sizeOfQueryContextsArray()

Returns the number of QueryContexts element.

Returns:

the size of the QueryContext array.

setQueryContextsArray

void setQueryContextsArray(QueryContext[] queryContextsArray)

Internal Use Only.

setQueryContextsArray

void setQueryContextsArray(int i,
                           QueryContext queryContexts)

Internal Use Only.

setNilQueryContextsArray

void setNilQueryContextsArray(int i)

Internal Use Only.

insertNewQueryContexts

QueryContext insertNewQueryContexts(int i)

Internal Use Only.

addNewQueryContexts

QueryContext addNewQueryContexts()

Internal Use Only.

removeQueryContexts

void removeQueryContexts(int i)

Internal Use Only.

getDBLogonInfosArray

DBLogonInfo[] getDBLogonInfosArray()

Retrieves a list of DBLogonInfo containing information about databases needing login information for the query to run correctly.
DBLogonInfo is used to store information used to connect to a database when a document is refreshed.

Returns:

a list of DBLogonInfo objects.

See Also:

DBLogonInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine

getDBLogonInfosArray

DBLogonInfo getDBLogonInfosArray(int i)

Retrieves a single of DBLogonInfo containing information about a database needing login information for the query to run correctly.

Parameters:

i - index of the DBLogonInfo to be retrieved.

Returns:

a single DBLogonInfo object.

See Also:

DBLogonInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine

isNilDBLogonInfosArray

boolean isNilDBLogonInfosArray(int i)

Checks if the ith DBLogonInfos element is nil.

Parameters:

i - the index of the DBLogonInfo element.

Returns:

true if the DBLogonInfo element is nil, otherwise false.

sizeOfDBLogonInfosArray

int sizeOfDBLogonInfosArray()

Returns the number of DBLogonInfos element.

Returns:

the size of the DBLogonInfo array.

setDBLogonInfosArray

void setDBLogonInfosArray(DBLogonInfo[] dbLogonInfosArray)

Internal Use Only.

setDBLogonInfosArray

void setDBLogonInfosArray(int i,
                          DBLogonInfo dbLogonInfos)

Internal Use Only.

setNilDBLogonInfosArray

void setNilDBLogonInfosArray(int i)

Internal Use Only.

insertNewDBLogonInfos

DBLogonInfo insertNewDBLogonInfos(int i)

Internal Use Only.

addNewDBLogonInfos

DBLogonInfo addNewDBLogonInfos()

Internal Use Only.

removeDBLogonInfos

void removeDBLogonInfos(int i)

Removes the ith DBLogonInfos element.

Parameters:

i - the index of the DBLogonInfo element.

getTrackData

TrackData getTrackData()

Gets the TrackData element.

Returns:

the TrackData instance

isNilTrackData

boolean isNilTrackData()

Checks if the TrackData element is nil.

Returns:

true if the TrackData element is nil, otherwise false.

isSetTrackData

boolean isSetTrackData()

Checks if the TrackData element is set.

Returns:

true if the TrackData element is set, otherwise false.

setTrackData

void setTrackData(TrackData trackData)

Internal Use Only.

addNewTrackData

TrackData addNewTrackData()

Internal Use Only.

setNilTrackData

void setNilTrackData()

Internal Use Only.

unsetTrackData

void unsetTrackData()

Internal Use Only.

getDataSourceParameterValuesArray

DataSourceParameterValue[] getDataSourceParameterValuesArray()

Gets an array of all DataSourceParameterValues elements.

Returns:

the array of DataSourceParameterValue elements.

getDataSourceParameterValuesArray

DataSourceParameterValue getDataSourceParameterValuesArray(int i)

Gets the ith DataSourceParameterValues element.

Parameters:

i - the index of the DataSourceParameterValue element.

Returns:

the DataSourceParameterValue instance.

isNilDataSourceParameterValuesArray

boolean isNilDataSourceParameterValuesArray(int i)

Checks if the ith DataSourceParameterValues element is nil.

Returns:

true if the DataSourceParameter element is nil, otherwise false.

sizeOfDataSourceParameterValuesArray

int sizeOfDataSourceParameterValuesArray()

Returns the number of DataSourceParameterValues element.

Returns:

the size of the DataSourceParameter element.

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(DataSourceParameterValue[] dataSourceParameterValuesArray)

Internal Use Only.

setDataSourceParameterValuesArray

void setDataSourceParameterValuesArray(int i,
                                       DataSourceParameterValue dataSourceParameterValues)

Internal Use Only.

setNilDataSourceParameterValuesArray

void setNilDataSourceParameterValuesArray(int i)

Internal Use Only.

insertNewDataSourceParameterValues

DataSourceParameterValue insertNewDataSourceParameterValues(int i)

Internal Use Only.

addNewDataSourceParameterValues

DataSourceParameterValue addNewDataSourceParameterValues()

Internal Use Only.

removeDataSourceParameterValues

void removeDataSourceParameterValues(int i)

Internal Use Only.

getDocumentReference

java.lang.String getDocumentReference()

Returns a reference allowing the user to navigate through different states of this document.
A document’s reference is used to retrieve the state of a document. When a user opens a document, the Web Service provider generates a reference. As the document changes, the reference changes to follow the document’s states. This allows users to navigate backward and forward through the document states. The reference lasts as long as the Web Service session.
Note: A document has to have been opened a first time using its UID for a document reference to be created.

Returns:

the document reference.

xgetDocumentReference

org.apache.xmlbeans.XmlString xgetDocumentReference()

Internal Use Only.

isSetDocumentReference

boolean isSetDocumentReference()

Checks if the DocumentReference attribute is set.

Returns:

true if the DocumentReference element is set, otherwise false.

setDocumentReference

void setDocumentReference(java.lang.String documentReference)

Internal Use Only.

xsetDocumentReference

void xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference)

Internal Use Only.

unsetDocumentReference

void unsetDocumentReference()

Internal Use Only.

getName

java.lang.String getName()

Returns the name of the document.

Returns:

the document name.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

isSetName

boolean isSetName()

Checks if the Name attribute is set.

Returns:

true if the name element is set, otherwise false.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

unsetName

void unsetName()

Internal Use Only.

getFileType

java.lang.String getFileType()

Returns the type of the document.

Returns:

the type of the document.

xgetFileType

org.apache.xmlbeans.XmlString xgetFileType()

Internal Use Only.

isSetFileType

boolean isSetFileType()

Checks if the FileType attribute is set.

Returns:

true if the FileType element is set, otherwise false.

setFileType

void setFileType(java.lang.String fileType)

Internal Use Only.

xsetFileType

void xsetFileType(org.apache.xmlbeans.XmlString fileType)

Internal Use Only.

unsetFileType

void unsetFileType()

Internal Use Only.

getMimeType

java.lang.String getMimeType()

Returns the document Mime type.

For a list of possible mime types, see getMimeType.

Returns:

the document mime type.

xgetMimeType

org.apache.xmlbeans.XmlString xgetMimeType()

Internal Use Only.

isSetMimeType

boolean isSetMimeType()

Checks if the MimeType attribute is set.

Returns:

true if the MimeType attribute is set, otherwise false.

setMimeType

void setMimeType(java.lang.String mimeType)

Internal Use Only.

xsetMimeType

void xsetMimeType(org.apache.xmlbeans.XmlString mimeType)

Internal Use Only.

unsetMimeType

void unsetMimeType()

Internal Use Only.

getMustFillPassword

boolean getMustFillPassword()

Returns true if the current user has to fill in passwords to open this document.

Returns:

true if their are passwords to be filled; otherwise returns false.

xgetMustFillPassword

org.apache.xmlbeans.XmlBoolean xgetMustFillPassword()

Internal Use Only.

setMustFillPassword

void setMustFillPassword(boolean mustFillPassword)

Internal Use Only.

xsetMustFillPassword

void xsetMustFillPassword(org.apache.xmlbeans.XmlBoolean mustFillPassword)

Internal Use Only.

getMustFillPrompts

boolean getMustFillPrompts()

Returns true if the current user has to fill in prompts to open this document.

Returns:

true if their are prompts to be filled; otherwise returns false.

See Also:

FillPrompt, FillPrompts, RetrieveView, RetrieveData, Action, DBLogonInfo, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine

xgetMustFillPrompts

org.apache.xmlbeans.XmlBoolean xgetMustFillPrompts()

Internal Use Only.

setMustFillPrompts

void setMustFillPrompts(boolean mustFillPrompts)

Internal Use Only.

xsetMustFillPrompts

void xsetMustFillPrompts(org.apache.xmlbeans.XmlBoolean mustFillPrompts)

Internal Use Only.

getMustFillQueryContexts

boolean getMustFillQueryContexts()

Returns true if the current user has to fill QueryContexts to open this document.

Returns:

true if their are QueryContexts to be filled; otherwise returns false.

See Also:

FillQueryContext, FillQueryContexts, RetrieveView, RetrieveData, Action, DBLogonInfo, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine

xgetMustFillQueryContexts

org.apache.xmlbeans.XmlBoolean xgetMustFillQueryContexts()

Internal Use Only.

setMustFillQueryContexts

void setMustFillQueryContexts(boolean mustFillQueryContexts)

Internal Use Only.

xsetMustFillQueryContexts

void xsetMustFillQueryContexts(org.apache.xmlbeans.XmlBoolean mustFillQueryContexts)

Internal Use Only.

getMustFillDBLogons

boolean getMustFillDBLogons()

Returns true if the current user has to log in to a database when this document is opened for the query to run correctly.

Returns:

true if the current user has to log in to a database; otherwise returns false.

See Also:

DBLogonInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine

xgetMustFillDBLogons

org.apache.xmlbeans.XmlBoolean xgetMustFillDBLogons()

Internal Use Only.

setMustFillDBLogons

void setMustFillDBLogons(boolean mustFillDBLogons)

Internal Use Only.

xsetMustFillDBLogons

void xsetMustFillDBLogons(org.apache.xmlbeans.XmlBoolean mustFillDBLogons)

Internal Use Only.

getRefreshOnOpen

boolean getRefreshOnOpen()

Returns true if this Document object is refreshed when it is opened.

Returns:

true if this Document object is refreshed when opened.

xgetRefreshOnOpen

org.apache.xmlbeans.XmlBoolean xgetRefreshOnOpen()

Internal Use Only.

isSetRefreshOnOpen

boolean isSetRefreshOnOpen()

Checks if the RefreshOnOpen attribute is set.

Returns:

true if the RefreshOnOpen attribute is set, otherwise false.

setRefreshOnOpen

void setRefreshOnOpen(boolean refreshOnOpen)

Internal Use Only.

xsetRefreshOnOpen

void xsetRefreshOnOpen(org.apache.xmlbeans.XmlBoolean refreshOnOpen)

Internal Use Only.

unsetRefreshOnOpen

void unsetRefreshOnOpen()

Internal Use Only.

getAuthor

java.lang.String getAuthor()

Returns the name of the document author.

Returns:

the name of the document author.

xgetAuthor

org.apache.xmlbeans.XmlString xgetAuthor()

Internal Use Only.

setAuthor

void setAuthor(java.lang.String author)

Internal Use Only.

xsetAuthor

void xsetAuthor(org.apache.xmlbeans.XmlString author)

Internal Use Only.

getCreationDate

java.util.Calendar getCreationDate()

Returns the date the document was created.

Returns:

the date the document was created.

xgetCreationDate

org.apache.xmlbeans.XmlDateTime xgetCreationDate()

Internal Use Only.

setCreationDate

void setCreationDate(java.util.Calendar creationDate)

Internal Use Only.

xsetCreationDate

void xsetCreationDate(org.apache.xmlbeans.XmlDateTime creationDate)

Internal Use Only.

getRefreshable

boolean getRefreshable()

Returns true if the current user has the right to refresh this document.

Returns:

true if the current user has the right to refresh this document.

xgetRefreshable

org.apache.xmlbeans.XmlBoolean xgetRefreshable()

Internal Use Only.

setRefreshable

void setRefreshable(boolean refreshable)

Internal Use Only.

xsetRefreshable

void xsetRefreshable(org.apache.xmlbeans.XmlBoolean refreshable)

Internal Use Only.

getViewChunkable

boolean getViewChunkable()

Returns true if the web service is able to send the document's view data in separate blocks (or chunks).

Returns:

true if the web service is able to send the document's view in chunks.

xgetViewChunkable

org.apache.xmlbeans.XmlBoolean xgetViewChunkable()

Internal Use Only.

isSetViewChunkable

boolean isSetViewChunkable()

Checks if the ViewChunkable attribute is set.

Returns:

true if the ViewChunkable attribute is set, otherwise false.

setViewChunkable

void setViewChunkable(boolean viewChunkable)

Internal Use Only.

xsetViewChunkable

void xsetViewChunkable(org.apache.xmlbeans.XmlBoolean viewChunkable)

Internal Use Only.

unsetViewChunkable

void unsetViewChunkable()

Internal Use Only.

getDrillable

boolean getDrillable()

Returns true if the document is drillable.

Returns:

true if the document is drillable.

xgetDrillable

org.apache.xmlbeans.XmlBoolean xgetDrillable()

Internal Use Only.

isSetDrillable

boolean isSetDrillable()

Checks if the Drillable attribute is set.

Returns:

true if the Drillable element is set, otherwise false.

setDrillable

void setDrillable(boolean drillable)

Internal Use Only.

xsetDrillable

void xsetDrillable(org.apache.xmlbeans.XmlBoolean drillable)

Internal Use Only.

unsetDrillable

void unsetDrillable()

Internal Use Only.

getDataSourceParameterValuesRequired

boolean getDataSourceParameterValuesRequired()

Gets the DataSourceParameterValuesRequired attribute.

Returns:

true if the DataSourceParameterValues element is required, otherwise false.

xgetDataSourceParameterValuesRequired

org.apache.xmlbeans.XmlBoolean xgetDataSourceParameterValuesRequired()

Internal use only

setDataSourceParameterValuesRequired

void setDataSourceParameterValuesRequired(boolean dataSourceParameterValuesRequired)

Sets the DataSourceParameterValuesRequired attribute

Parameters:

dataSourceParameterValuesRequired - The boolean value

xsetDataSourceParameterValuesRequired

void xsetDataSourceParameterValuesRequired(org.apache.xmlbeans.XmlBoolean dataSourceParameterValuesRequired)

Internal Use only