com.businessobjects.dsws.reportengine
Class DocumentInformation

java.lang.Object
  com.businessobjects.dsws.reportengine.DocumentInformation

All Implemented Interfaces:

java.io.Serializable

public class DocumentInformation

extends java.lang.Object

implements java.io.Serializable

The DocumentInformation object contains all information relevant to a document stored on a BusinessObjects server.
Members of the DocumentInformation class 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

Example: Retrieve a document's contents in binary PDF format in chunks of 10 kilobytes

ViewSupport pdfViewSupport = new ViewSupport();
pdfViewSupport.setOutputFormat(OutputFormatType.PDF);
pdfViewSupport.setViewType(ViewType.BINARY);
pdfViewSupport.setViewMode(ViewModeType.DOCUMENT);

RetrieveBinaryView retBinView = new RetrieveBinaryView();
retBinView.setViewSupport(pdfViewSupport);
retBinView.setChunkSize(10);

RetrieveData retBOData = new RetrieveData();
retBOData.setRetrieveView(retBinView);

DocumentInformation docInfo = boReportEngine.getDocumentInformation(struid, null, null, null, retBOData);
BinaryView myBOView = (BinaryView) boDocInfo.getView();
byte[] docChunk = myBOView.getContent();
int iTotalSize = myBOView.getContentLength();
struid = docInfo.getDocumentReference();

while (true)
{


if (myBOView.isLastChunk())
break;

docInfo = boReportEngine.getDocumentInformation(struid, null, null, null, retBOData);
myBOView = (BinaryView) boDocInfo.getView();
docChunk = myBOView.getContent();
}


See Also:

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

Constructor Summary

DocumentInformation()
Instantiate a new blank DocumentInformation object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
java.lang.String	getAuthor() Return the name of the document author.
java.util.Calendar	getCreationDate() Return the date the document was created.
ReportState	getCurrentReportState() Return the current state of the document instance.
DataProviderInfo[]	getDataProviderInfo() Retrieve information about the source(s) used to provide data for this document.
DataProviderInfo	getDataProviderInfo(int i) Retrieve information about a single source used to provide data for this document.
DBLogonInfo[]	getDBLogonInfos() Retrieve a list of DBLogonInfo containing information about databases needing login information for the query to run correctly.
DBLogonInfo	getDBLogonInfos(int i) Retrieve a single of DBLogonInfo containing information about a database needing login information for the query to run correctly.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.String	getDocumentReference() Return a reference allowing the user to navigate through different states of this document.
DrillInfo	getDrillInfo() Return information about a document with the Drill activated.
java.lang.String	getFileType() Return the type of the document.
java.lang.String	getMimeType() Return the document Mime type.
java.lang.String	getName() Return the name of the document.
NavigationNode[]	getNavigationMap() Return an array containing the structure of the document.
NavigationNode	getNavigationMap(int i) Return a NavigationNode associated to single section or sub section of the document structure.
PromptInfo[]	getPromptInfo() Return a list of prompts to be filled when the document is opened.
PromptInfo	getPromptInfo(int i) Return a single prompt from the list of prompts to be filled when the document is opened.
QueryContext[]	getQueryContexts() Return a list of QueryContexts to be resolved when the document is opened.
QueryContext	getQueryContexts(int i) Return a single QueryContext to be resolved when the document is opened.
Report[]	getReports() Return the Reports contained in this document.
Report	getReports(int i) Return a single Report from this document.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
View	getView() Return a formatted view containing the information stored in the document.
ViewSupport[]	getViewSupports() Return an array of the different formats in which it is possible to view this document.
ViewSupport	getViewSupports(int i) Return a single view format supported by this document.
int	hashCode() Internal Use Only.
boolean	isDrillable() Return true if the document is drillable.
boolean	isMustFillDBLogons() 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	isMustFillPassword() Returns true if the current user has to fill in passwords to open this document.
boolean	isMustFillPrompts() Returns true if the current user has to fill in prompts to open this document.
boolean	isMustFillQueryContexts() Returns true if the current user has to fill QueryContexts to open this document.
boolean	isRefreshable() Return true if the current user has the right to refresh this document.
boolean	isRefreshOnOpen() Returns true if this Document object is refreshed when it is opened.
boolean	isViewChunkable() Return true if the web service is able to send the document's view data in separate blocks (or chunks).
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	setDataProviderInfo(DataProviderInfo[] dataProviderInfo) Internal Use Only.
void	setDataProviderInfo(int i, DataProviderInfo value) Internal Use Only.
void	setDBLogonInfos(DBLogonInfo[] DBLogonInfos) Internal Use Only.
void	setDBLogonInfos(int i, DBLogonInfo value) 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	setNavigationMap(int i, NavigationNode value) Internal Use Only.
void	setNavigationMap(NavigationNode[] navigationMap) Internal Use Only.
void	setPromptInfo(int i, PromptInfo value) Internal Use Only.
void	setPromptInfo(PromptInfo[] promptInfo) Internal Use Only.
void	setQueryContexts(int i, QueryContext value) Internal Use Only.
void	setQueryContexts(QueryContext[] queryContexts) Internal Use Only.
void	setRefreshable(boolean refreshable) Internal Use Only.
void	setRefreshOnOpen(boolean refreshOnOpen) Internal Use Only.
void	setReports(int i, Report value) Internal Use Only.
void	setReports(Report[] reports) Internal Use Only.
void	setView(View view) Internal Use Only.
void	setViewChunkable(boolean viewChunkable) Internal Use Only.
void	setViewSupports(int i, ViewSupport value) Internal Use Only.
void	setViewSupports(ViewSupport[] viewSupports) Internal Use Only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentInformation

public DocumentInformation()

Instantiate a new blank DocumentInformation object.

Method Detail

getCurrentReportState

public ReportState getCurrentReportState()

Return 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.

setCurrentReportState

public void setCurrentReportState(ReportState currentReportState)

Internal Use Only.

getReports

public Report[] getReports()

Return the Reports contained in this document.

Returns:

an array of Reports contained in the document.

setReports

public void setReports(Report[] reports)

Internal Use Only.

getReports

public Report getReports(int i)

Return a single Report from this document.

Parameters:

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

Returns:

a single report

setReports

public void setReports(int i,
                       Report value)

Internal Use Only.

getView

public View getView()

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

Example: Retrieve a documents contents in character HTML format

RetrieveData retBOData = new RetrieveData();
RetrieveView retBOView = new RetrieveView();
retBOData.setRetrieveView(retBOView);
DocumentInformation boDocInfo = boRepEng.getDocumentInformation(strBODocuid, null, null, null, retBOData);
CharacterView myBOView = (CharacterView)boDocInfo.getView();
String[] docContents = myBOView.getContent();


Returns:

a view containing the information stored in the document.

See Also:

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

setView

public void setView(View view)

Internal Use Only.

getDrillInfo

public DrillInfo getDrillInfo()

Return 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

setDrillInfo

public void setDrillInfo(DrillInfo drillInfo)

Internal Use Only.

getDataProviderInfo

public DataProviderInfo[] getDataProviderInfo()

Retrieve information about the source(s) used to provide data for this document.

Example: Retrieve a documents DataProviders.

RetrieveData retBOData = new RetrieveData();
RetrieveView retBOView = new RetrieveView();
RetrieveDataProvidersInfo retBoDP = new RetrieveDataProvidersInfo();
retBOData.setRetrieveView(retBOView);
retBOData.setRetrieveDataProvidersInfo(retBoDP);
DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strBODocuid, null, null, null, retBOData);
DataProviderInfo[] docDataProviders = boDocInfo.getDataProviderInfo();


Returns:

an array of the DataProviders used by this document.

See Also:

RetrieveView, RetrieveData, RetrieveDataProvidersInfo, ReportEngine, DataProviderInfo

setDataProviderInfo

public void setDataProviderInfo(DataProviderInfo[] dataProviderInfo)

Internal Use Only.

getDataProviderInfo

public DataProviderInfo getDataProviderInfo(int i)

Retrieve 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:

getDataProviderInfo()

setDataProviderInfo

public void setDataProviderInfo(int i,
                                DataProviderInfo value)

Internal Use Only.

getNavigationMap

public NavigationNode[] getNavigationMap()

Return 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.

setNavigationMap

public void setNavigationMap(NavigationNode[] navigationMap)

Internal Use Only.

getNavigationMap

public NavigationNode getNavigationMap(int i)

Return 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.

setNavigationMap

public void setNavigationMap(int i,
                             NavigationNode value)

Internal Use Only.

getViewSupports

public ViewSupport[] getViewSupports()

Return 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

setViewSupports

public void setViewSupports(ViewSupport[] viewSupports)

Internal Use Only.

getViewSupports

public ViewSupport getViewSupports(int i)

Return 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.

setViewSupports

public void setViewSupports(int i,
                            ViewSupport value)

Internal Use Only.

getPromptInfo

public PromptInfo[] getPromptInfo()

Return 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( strBODocuid, null, null, nPage, retBOData);
if (docInfo.isMustFillPrompts()==false)
{
//No prompts in document.
}
PromptInfo[] boDocInfo.getPromptInfo();


Returns:

a list of prompts to be filled.

See Also:

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

setPromptInfo

public void setPromptInfo(PromptInfo[] promptInfo)

Internal Use Only.

getPromptInfo

public PromptInfo getPromptInfo(int i)

Return 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.

setPromptInfo

public void setPromptInfo(int i,
                          PromptInfo value)

Internal Use Only.

getQueryContexts

public QueryContext[] getQueryContexts()

Return 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.

setQueryContexts

public void setQueryContexts(QueryContext[] queryContexts)

Internal Use Only.

getQueryContexts

public QueryContext getQueryContexts(int i)

Return 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.

setQueryContexts

public void setQueryContexts(int i,
                             QueryContext value)

Internal Use Only.

getDBLogonInfos

public DBLogonInfo[] getDBLogonInfos()

Retrieve 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

setDBLogonInfos

public void setDBLogonInfos(DBLogonInfo[] DBLogonInfos)

Internal Use Only.

getDBLogonInfos

public DBLogonInfo getDBLogonInfos(int i)

Retrieve 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

setDBLogonInfos

public void setDBLogonInfos(int i,
                            DBLogonInfo value)

Internal Use Only.

getDocumentReference

public java.lang.String getDocumentReference()

Return 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.

setDocumentReference

public void setDocumentReference(java.lang.String documentReference)

Internal Use Only.

getName

public java.lang.String getName()

Return the name of the document.

Returns:

the document name.

setName

public void setName(java.lang.String name)

Internal Use Only.

getFileType

public java.lang.String getFileType()

Return the type of the document.

Returns:

the type of the document.

setFileType

public void setFileType(java.lang.String fileType)

Internal Use Only.

getMimeType

public java.lang.String getMimeType()

Return the document Mime type.

For a list of possible mime types, see getMimeType.

Returns:

the document mime type.

setMimeType

public void setMimeType(java.lang.String mimeType)

Internal Use Only.

isMustFillPassword

public boolean isMustFillPassword()

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.

setMustFillPassword

public void setMustFillPassword(boolean mustFillPassword)

Internal Use Only.

isMustFillPrompts

public boolean isMustFillPrompts()

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

setMustFillPrompts

public void setMustFillPrompts(boolean mustFillPrompts)

Internal Use Only.

isMustFillQueryContexts

public boolean isMustFillQueryContexts()

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

setMustFillQueryContexts

public void setMustFillQueryContexts(boolean mustFillQueryContexts)

Internal Use Only.

isMustFillDBLogons

public boolean isMustFillDBLogons()

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

setMustFillDBLogons

public void setMustFillDBLogons(boolean mustFillDBLogons)

Internal Use Only.

isRefreshOnOpen

public boolean isRefreshOnOpen()

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

Returns:

true if this Document object is refreshed when opened.

setRefreshOnOpen

public void setRefreshOnOpen(boolean refreshOnOpen)

Internal Use Only.

getAuthor

public java.lang.String getAuthor()

Return the name of the document author.

Returns:

the name of the document author.

setAuthor

public void setAuthor(java.lang.String author)

Internal Use Only.

getCreationDate

public java.util.Calendar getCreationDate()

Return the date the document was created.

Returns:

the date the document was created.

setCreationDate

public void setCreationDate(java.util.Calendar creationDate)

Internal Use Only.

isRefreshable

public boolean isRefreshable()

Return 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.

setRefreshable

public void setRefreshable(boolean refreshable)

Internal Use Only.

isViewChunkable

public boolean isViewChunkable()

Return 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.

setViewChunkable

public void setViewChunkable(boolean viewChunkable)

Internal Use Only.

isDrillable

public boolean isDrillable()

Return true if the document is drillable.

Returns:

true if the document is drillable.

setDrillable

public void setDrillable(boolean drillable)

Internal Use Only.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

Internal Use Only.

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.