com.businessobjects.dsws.reportengine
Interface RetrieveMustFillInfo

public interface RetrieveMustFillInfo

The RetrieveMustFillInfo interface controls information that has to be supplied to the document for it to Refresh correctly. This information includes DBLogonInfo, PromptInfo and QueryContext information.

See DBLogonInfo for an example of how to use this object.

See Also:

DBLogonInfo, RetrieveQueryContext, RetrievePromptsInfo, RetrieveDBLogonInfo, RetrieveView, RetrieveData, Action, Refresh, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

RetrieveDataSourceParameterValues	addNewRetrieveDataSourceParameterValues() Appends and returns a new empty RetrieveDataSourceParameterValues element
RetrieveDBLogonInfo	addNewRetrieveDBLogonInfo() Appends and returns a new empty RetrieveDBLogonInfo element.
RetrievePromptsInfo	addNewRetrievePromptsInfo() Appends and returns a new empty RetrievePromptsInfo element.
RetrieveQueryContext	addNewRetrieveQueryContext() Appends and returns a new empty RetrieveQueryContext element.
RetrieveTrackData	addNewRetrieveTrackData() Appends and returns a new empty RetrieveTrackData element
RetrieveDataSourceParameterValues	getRetrieveDataSourceParameterValues() Internal Use Only.
RetrieveDBLogonInfo	getRetrieveDBLogonInfo() Internal Use Only.
RetrievePromptsInfo	getRetrievePromptsInfo() Internal Use Only.
RetrieveQueryContext	getRetrieveQueryContext() Internal Use Only.
RetrieveTrackData	getRetrieveTrackData() Internal Use Only.
boolean	isNilRetrieveDataSourceParameterValues() Checks if the RetrieveDataSourceParameterValues element is nil.
boolean	isNilRetrieveDBLogonInfo() Checks if the RetrieveDBLogonInfo element is nil.
boolean	isNilRetrievePromptsInfo() Checks if the RetrievePromptsInfo element is nil.
boolean	isNilRetrieveQueryContext() Checks if the RetrieveQueryContext element is nil.
boolean	isNilRetrieveTrackData() Checks if the RetrieveTrackData element is nil.
boolean	isSetRetrieveDataSourceParameterValues() Checks if the RetrieveDataSourceParameterValues element is set.
boolean	isSetRetrieveDBLogonInfo() Checks if the RetrieveDBLogonInfo element is set.
boolean	isSetRetrievePromptsInfo() Checks if the RetrievePromptsInfo element is set.
boolean	isSetRetrieveQueryContext() Checks if the RetrieveQueryContext element is set.
boolean	isSetRetrieveTrackData() Checks if the RetrieveTrackData element is set.
void	setNilRetrieveDataSourceParameterValues() Sets the RetrieveDataSourceParameterValues element to nil.
void	setNilRetrieveDBLogonInfo() Sets the RetrieveDBLogonInfo element to nil.
void	setNilRetrievePromptsInfo() Sets if the RetrievePromptsInfo element is nil.
void	setNilRetrieveQueryContext() Sets the RetrieveQueryContext element to nil.
void	setNilRetrieveTrackData() Sets the RetrieveTrackData element to nil.
void	setRetrieveDataSourceParameterValues(RetrieveDataSourceParameterValues retrieveDataSourceParameterValues) Sets the RetrieveDataSourceParameterValues element.
void	setRetrieveDBLogonInfo(RetrieveDBLogonInfo retrieveDBLogonInfo) Retrieves DBLogonInfo necessary to refresh a document.
void	setRetrievePromptsInfo(RetrievePromptsInfo retrievePromptsInfo) Retrieves Prompts necessary to refresh a document.
void	setRetrieveQueryContext(RetrieveQueryContext retrieveQueryContext) Retrieves QueryContexts necessary to refresh a document.
void	setRetrieveTrackData(RetrieveTrackData retrieveTrackData) Sets the RetrieveTrackData element.
void	unsetRetrieveDataSourceParameterValues() Unsets the RetrieveDataSourceParameterValues element.
void	unsetRetrieveDBLogonInfo() Unsets the RetrieveDBLogonInfo element.
void	unsetRetrievePromptsInfo() Unsets the RetrievePromptsInfo element
void	unsetRetrieveQueryContext() Unsets the RetrieveQueryContext element.
void	unsetRetrieveTrackData() Unsets the RetrieveTrackData element

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getRetrieveQueryContext

RetrieveQueryContext getRetrieveQueryContext()

Internal Use Only.

isNilRetrieveQueryContext

boolean isNilRetrieveQueryContext()

Checks if the RetrieveQueryContext element is nil.

Returns:

true if the RetrieveQueryContext element is nil, otherwise false

isSetRetrieveQueryContext

boolean isSetRetrieveQueryContext()

Checks if the RetrieveQueryContext element is set.

Returns:

true if the RetrieveQueryContext element is set, otherwise false

setRetrieveQueryContext

void setRetrieveQueryContext(RetrieveQueryContext retrieveQueryContext)

Retrieves QueryContexts necessary to refresh a document. The QueryContexts objects are returned inside the DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call.
A Context is used to avoid ambiguity when defining a query.
See DBLogonInfo for an example of how to use a retrieve object.

Parameters:

retrieveQueryContext - a RetrieveQueryContext object.

See Also:

RetrieveQueryContext, RetrieveMustFillInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine, DocumentInformation

addNewRetrieveQueryContext

RetrieveQueryContext addNewRetrieveQueryContext()

Appends and returns a new empty RetrieveQueryContext element.

Returns:

a new empty RetrieveQueryContext element.

setNilRetrieveQueryContext

void setNilRetrieveQueryContext()

Sets the RetrieveQueryContext element to nil.

unsetRetrieveQueryContext

void unsetRetrieveQueryContext()

Unsets the RetrieveQueryContext element.

getRetrievePromptsInfo

RetrievePromptsInfo getRetrievePromptsInfo()

Internal Use Only.

isNilRetrievePromptsInfo

boolean isNilRetrievePromptsInfo()

Checks if the RetrievePromptsInfo element is nil.

Returns:

true if the RetrievePromptsInfo element is nil, otherwise false

isSetRetrievePromptsInfo

boolean isSetRetrievePromptsInfo()

Checks if the RetrievePromptsInfo element is set.

Returns:

true if the RetrievePromptsInfo element is set, otherwise false

setRetrievePromptsInfo

void setRetrievePromptsInfo(RetrievePromptsInfo retrievePromptsInfo)

Retrieves Prompts necessary to refresh a document. The PromptInfo objects are returned inside the DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call.
See DBLogonInfo for an example of how to use a retrieve object.

Parameters:

retrievePromptsInfo - a RetrievePromptsInfo object.

See Also:

PromptInfo, RetrievePromptsInfo, RetrieveMustFillInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine, DocumentInformation

addNewRetrievePromptsInfo

RetrievePromptsInfo addNewRetrievePromptsInfo()

Appends and returns a new empty RetrievePromptsInfo element.

Returns:

a new empty RetrievePromptsInfo element.

setNilRetrievePromptsInfo

void setNilRetrievePromptsInfo()

Sets if the RetrievePromptsInfo element is nil.

unsetRetrievePromptsInfo

void unsetRetrievePromptsInfo()

Unsets the RetrievePromptsInfo element

getRetrieveDBLogonInfo

RetrieveDBLogonInfo getRetrieveDBLogonInfo()

Internal Use Only.

isNilRetrieveDBLogonInfo

boolean isNilRetrieveDBLogonInfo()

Checks if the RetrieveDBLogonInfo element is nil.

Returns:

true if the RetrieveDBLogonInfo element is nil, otherwise false

isSetRetrieveDBLogonInfo

boolean isSetRetrieveDBLogonInfo()

Checks if the RetrieveDBLogonInfo element is set.

Returns:

true if the RetrieveDBLogonInfo element is set, otherwise false

setRetrieveDBLogonInfo

void setRetrieveDBLogonInfo(RetrieveDBLogonInfo retrieveDBLogonInfo)

Retrieves DBLogonInfo necessary to refresh a document. The DBLogonInfo objects are returned inside the DocumentInformation object retrieved by the ReportEngine.getDocumentInformation Web Service call.
DBLogonInfo is used to stock information used to connect to a database when a document is refreshed.
See DBLogonInfo for an example of how to use a retrieve object.

Parameters:

retrieveDBLogonInfo - a RetrieveDBLogonInfo object.

See Also:

DBLogonInfo, RetrieveDBLogonInfo, RetrieveMustFillInfo, RetrieveView, RetrieveData, Action, FillDBLogons, FillDBLogon, DataProviderInfo, RetrieveDataProvidersInfo, ReportEngine, DocumentInformation

addNewRetrieveDBLogonInfo

RetrieveDBLogonInfo addNewRetrieveDBLogonInfo()

Appends and returns a new empty RetrieveDBLogonInfo element.

Returns:

a new empty "RetrieveDBLogonInfo" element

setNilRetrieveDBLogonInfo

void setNilRetrieveDBLogonInfo()

Sets the RetrieveDBLogonInfo element to nil.

unsetRetrieveDBLogonInfo

void unsetRetrieveDBLogonInfo()

Unsets the RetrieveDBLogonInfo element.

getRetrieveTrackData

RetrieveTrackData getRetrieveTrackData()

Internal Use Only.

isNilRetrieveTrackData

boolean isNilRetrieveTrackData()

Checks if the RetrieveTrackData element is nil.

Returns:

true if the RetrieveTrackData element is nil, otherwise false

isSetRetrieveTrackData

boolean isSetRetrieveTrackData()

Checks if the RetrieveTrackData element is set.

Returns:

true if the RetrieveTrackData element is set, otherwise false

setRetrieveTrackData

void setRetrieveTrackData(RetrieveTrackData retrieveTrackData)

Sets the RetrieveTrackData element.

Parameters:

retrieveTrackData - - The RetrieveTrackData instance

addNewRetrieveTrackData

RetrieveTrackData addNewRetrieveTrackData()

Appends and returns a new empty RetrieveTrackData element

Returns:

a new empty "RetrieveTrackData" element

setNilRetrieveTrackData

void setNilRetrieveTrackData()

Sets the RetrieveTrackData element to nil.

unsetRetrieveTrackData

void unsetRetrieveTrackData()

Unsets the RetrieveTrackData element

getRetrieveDataSourceParameterValues

RetrieveDataSourceParameterValues getRetrieveDataSourceParameterValues()

Internal Use Only.

isNilRetrieveDataSourceParameterValues

boolean isNilRetrieveDataSourceParameterValues()

Checks if the RetrieveDataSourceParameterValues element is nil.

Returns:

true if the RetrieveDataSourceParameterValues element is nil, otherwise false

isSetRetrieveDataSourceParameterValues

boolean isSetRetrieveDataSourceParameterValues()

Checks if the RetrieveDataSourceParameterValues element is set.

Returns:

true if the RetrieveDataSourceParameterValues element is set, otherwise false

setRetrieveDataSourceParameterValues

void setRetrieveDataSourceParameterValues(RetrieveDataSourceParameterValues retrieveDataSourceParameterValues)

Sets the RetrieveDataSourceParameterValues element.

Parameters:

retrieveDataSourceParameterValues - - the RetrieveDataSourceParameterValues instance

addNewRetrieveDataSourceParameterValues

RetrieveDataSourceParameterValues addNewRetrieveDataSourceParameterValues()

Appends and returns a new empty RetrieveDataSourceParameterValues element

Returns:

a new empty RetrieveDataSourceParameterValues element

setNilRetrieveDataSourceParameterValues

void setNilRetrieveDataSourceParameterValues()

Sets the RetrieveDataSourceParameterValues element to nil.

unsetRetrieveDataSourceParameterValues

void unsetRetrieveDataSourceParameterValues()

Unsets the RetrieveDataSourceParameterValues element.