com.businessobjects.dsws.reportengine
Interface RetrieveDrillInfo

public interface RetrieveDrillInfo

RetrieveDrillInfo is used to retrieve information about the possible Drill Actions that can be performed on a document.
DrillInfo contains the information necessary to perform a drill in a document with the drill activated.
See DrillInfo for an example of how use the RetrieveDrillInfo object
See Drill for an example of how to activate the drill in a document.

See Also:

LOV, SortType, TransportType, BinaryView, RetrieveView, RetrieveData, DataProviderInfo, RetrieveBinaryView, RetrieveCharacterView, RetrieveCurrentReportState, RetrieveData, RetrieveDataProvidersInfo, RetrieveDrillInfo, RetrieveMustFillInfo, RetrieveNavigationMap, RetrievePromptsInfo, RetrieveQueryContext, RetrieveReportList, RetrieveView, RetrieveViewSupport, RetrieveXMLView, ReportEngine

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

LOVBatch	addNewLOVBatch() Appends and returns a new empty LOVBatch element.
LOVSearch	addNewLOVSearch() Appends and returns a new empty LOVSearch element.
LOVSort	addNewLOVSort() Appends and returns a new empty LOVSort element
org.apache.xmlbeans.XmlString	addNewSelectDrillLOVs() Appends and returns a new empty value as the last SelectDrillLOVs element
void	addSelectDrillLOVs(java.lang.String selectDrillLOVs) Appends the value as the last SelectDrillLOVs element.
java.lang.String	getAddToDrillBar() Gets the addToDrillBar attribute.
DrillLOVRetrievalMode.Enum	getDrillLOVRetrievalMode() Internal Use Only.
LOVBatch	getLOVBatch() Internal Use Only.
LOVSearch	getLOVSearch() Internal Use Only.
LOVSort	getLOVSort() Internal Use Only.
java.lang.String	getRemoveFromDrillBar() Gets the removeFromDrillBar attribute.
java.lang.String[]	getSelectDrillLOVsArray() Internal Use Only.
java.lang.String	getSelectDrillLOVsArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewSelectDrillLOVs(int i) Inserts and returns a new empty value as the ith SelectDrillLOVs element
void	insertSelectDrillLOVs(int i, java.lang.String selectDrillLOVs) Inserts the SelectDrillLOVs element at the specified index position.
boolean	isNilLOVBatch() Checks if the LOVBatch element is nil.
boolean	isNilLOVSearch() Checks if the LOVSearch element is nil.
boolean	isNilLOVSort() Checks if the LOVSort element is nil.
boolean	isNilSelectDrillLOVsArray(int i) Checks if the SelectDrillLOVs element is nil at the specified index position.
boolean	isSetAddToDrillBar() Checks if the addToDrillBar attribute is set.
boolean	isSetLOVBatch() Checks if the LOVBatch element is set.
boolean	isSetLOVSearch() Checks if the LOVSearch element is set.
boolean	isSetLOVSort() Checks if the LOVSort element is set.
boolean	isSetRemoveFromDrillBar() Checks if the removeFromDrillBar attribute is set.
void	removeSelectDrillLOVs(int i) Removes the SelectDrillLOVs element from the specifid index position.
void	setAddToDrillBar(java.lang.String addToDrillBar) Sets the addToDrillBar attribute
void	setDrillLOVRetrievalMode(DrillLOVRetrievalMode.Enum drillLOVRetrievalMode) Sets the mode to retrieve List Of Values(LOV).
void	setLOVBatch(LOVBatch lovBatch) Sets an LOVBatch object to specify which batch/chunk of the List Of Values(LOV) you want to retrieve.
void	setLOVSearch(LOVSearch lovSearch) Sets an LOVSearch object to specify how you want to filter List Of Values(LOV) you are going to retrieve.
void	setLOVSort(LOVSort lovSort) Sets an LOVSort object to specify how you want to sort List Of Values(LOV) you are going to retrieve.
void	setNilLOVBatch() Sets the LOVBatch element to nil.
void	setNilLOVSearch() Sets the LOVSearch element to nil.
void	setNilLOVSort() Sets the LOVSort element to nil.
void	setNilSelectDrillLOVsArray(int i) Sets the SelectDrillLOVs element to nil at the specified index position.
void	setRemoveFromDrillBar(java.lang.String removeFromDrillBar) Sets the removeFromDrillBar attribute.
void	setSelectDrillLOVsArray(int i, java.lang.String selectDrillLOVs) Sets an array of DrillDimension IDs whose List Of Values (LOV) you wish to retrieve Note: Before using this function, call setSelectDrillLOVs(java.lang.String[] selectDrillLOVs) to * initialize the array.
void	setSelectDrillLOVsArray(java.lang.String[] selectDrillLOVsArray) Sets an array of DrillDimension IDs whose List Of Values (LOV) you wish to retrieve.
int	sizeOfSelectDrillLOVsArray() Returns the size of the SelectDrillLOV array
void	unsetAddToDrillBar() Unsets the addToDrillBar attribute
void	unsetLOVBatch() Unsets the LOVBatch element.
void	unsetLOVSearch() Unsets the LOVSearch element.
void	unsetLOVSort() Unsets the LOVSort element.
void	unsetRemoveFromDrillBar() Unsets the removeFromDrillBar attribute
org.apache.xmlbeans.XmlString	xgetAddToDrillBar() Internal Use Only.
DrillLOVRetrievalMode	xgetDrillLOVRetrievalMode() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetRemoveFromDrillBar() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetSelectDrillLOVsArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetSelectDrillLOVsArray(int i) Internal Use Only.
void	xsetAddToDrillBar(org.apache.xmlbeans.XmlString addToDrillBar) Internal Use Only.
void	xsetDrillLOVRetrievalMode(DrillLOVRetrievalMode drillLOVRetrievalMode) Internal Use Only.
void	xsetRemoveFromDrillBar(org.apache.xmlbeans.XmlString removeFromDrillBar) Internal Use Only.
void	xsetSelectDrillLOVsArray(int i, org.apache.xmlbeans.XmlString selectDrillLOVs) Internal Use Only.
void	xsetSelectDrillLOVsArray(org.apache.xmlbeans.XmlString[] selectDrillLOVsArray) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getSelectDrillLOVsArray

java.lang.String[] getSelectDrillLOVsArray()

Internal Use Only.

getSelectDrillLOVsArray

java.lang.String getSelectDrillLOVsArray(int i)

Internal Use Only.

xgetSelectDrillLOVsArray

org.apache.xmlbeans.XmlString[] xgetSelectDrillLOVsArray()

Internal Use Only.

xgetSelectDrillLOVsArray

org.apache.xmlbeans.XmlString xgetSelectDrillLOVsArray(int i)

Internal Use Only.

isNilSelectDrillLOVsArray

boolean isNilSelectDrillLOVsArray(int i)

Checks if the SelectDrillLOVs element is nil at the specified index position.

Parameters:

i - the index of the SelectDrillLOV element

Returns:

true if the SelectDrillLOV element is nil, otherwise false

sizeOfSelectDrillLOVsArray

int sizeOfSelectDrillLOVsArray()

Returns the size of the SelectDrillLOV array

Returns:

the size of the SelectDrillLOV array

setSelectDrillLOVsArray

void setSelectDrillLOVsArray(java.lang.String[] selectDrillLOVsArray)

Sets an array of DrillDimension IDs whose List Of Values (LOV) you wish to retrieve.

Parameters:

selectDrillLOVsArray - - a array of string containing the selected List Of Values.

setSelectDrillLOVsArray

void setSelectDrillLOVsArray(int i,
                             java.lang.String selectDrillLOVs)

Sets an array of DrillDimension IDs whose List Of Values (LOV) you wish to retrieve Note: Before using this function, call setSelectDrillLOVs(java.lang.String[] selectDrillLOVs) to *
initialize the array.

Parameters:

i - - The index of the List Of Values(LOV) to be retrieved.

selectDrillLOVs - - a string containing a DrillDimension ID

xsetSelectDrillLOVsArray

void xsetSelectDrillLOVsArray(org.apache.xmlbeans.XmlString[] selectDrillLOVsArray)

Internal Use Only.

xsetSelectDrillLOVsArray

void xsetSelectDrillLOVsArray(int i,
                              org.apache.xmlbeans.XmlString selectDrillLOVs)

Internal Use Only.

setNilSelectDrillLOVsArray

void setNilSelectDrillLOVsArray(int i)

Sets the SelectDrillLOVs element to nil at the specified index position.

Parameters:

i - the index of the SelectDrillLOV element

insertSelectDrillLOVs

void insertSelectDrillLOVs(int i,
                           java.lang.String selectDrillLOVs)

Inserts the SelectDrillLOVs element at the specified index position.

Parameters:

i - the index of the SelectDrillLOV element

selectDrillLOVs - - The String value of SelectDrillLOV

addSelectDrillLOVs

void addSelectDrillLOVs(java.lang.String selectDrillLOVs)

Appends the value as the last SelectDrillLOVs element.

Parameters:

selectDrillLOVs - - The String value of SelectDrillLOV

insertNewSelectDrillLOVs

org.apache.xmlbeans.XmlString insertNewSelectDrillLOVs(int i)

Inserts and returns a new empty value as the ith SelectDrillLOVs element

Parameters:

i - the index of the SelectDrillLOV element

Returns:

a new empty value as the ith SelectDrillLOVs element

addNewSelectDrillLOVs

org.apache.xmlbeans.XmlString addNewSelectDrillLOVs()

Appends and returns a new empty value as the last SelectDrillLOVs element

Returns:

a new empty value as the last SelectDrillLOVs element

removeSelectDrillLOVs

void removeSelectDrillLOVs(int i)

Removes the SelectDrillLOVs element from the specifid index position.

Parameters:

i - the index of the SelectDrillLOV element

getLOVSearch

LOVSearch getLOVSearch()

Internal Use Only.

isNilLOVSearch

boolean isNilLOVSearch()

Checks if the LOVSearch element is nil.

Returns:

true if the LOVSearch element is nil, otherwise false

isSetLOVSearch

boolean isSetLOVSearch()

Checks if the LOVSearch element is set.

Returns:

true if the LOVSearch element is set, otherwise false

setLOVSearch

void setLOVSearch(LOVSearch lovSearch)

Sets an LOVSearch object to specify how you want to filter List Of Values(LOV) you are going to retrieve.
If null, the search will not be performed on the returned list of values.

Parameters:

lovSearch - - an object containing LOVSearch criteria.

See Also:

LOVSearch

addNewLOVSearch

LOVSearch addNewLOVSearch()

Appends and returns a new empty LOVSearch element.

Returns:

a new empty "LOVSearch" element

setNilLOVSearch

void setNilLOVSearch()

Sets the LOVSearch element to nil.

unsetLOVSearch

void unsetLOVSearch()

Unsets the LOVSearch element.

getLOVSort

LOVSort getLOVSort()

Internal Use Only.

isNilLOVSort

boolean isNilLOVSort()

Checks if the LOVSort element is nil.

Returns:

true if the LOVSort element is nil, otherwise false

isSetLOVSort

boolean isSetLOVSort()

Checks if the LOVSort element is set.

Returns:

true if the LOVSort element is set, otherwise false

setLOVSort

void setLOVSort(LOVSort lovSort)

Sets an LOVSort object to specify how you want to sort List Of Values(LOV) you are going to retrieve.
If null, the sort will not be performed on the returned list of values.

Parameters:

lovSort - - an object containing LOVSort parameters.

See Also:

LOVSort

addNewLOVSort

LOVSort addNewLOVSort()

Appends and returns a new empty LOVSort element

Returns:

a new empty LOVSort element

setNilLOVSort

void setNilLOVSort()

Sets the LOVSort element to nil.

unsetLOVSort

void unsetLOVSort()

Unsets the LOVSort element.

getLOVBatch

LOVBatch getLOVBatch()

Internal Use Only.

isNilLOVBatch

boolean isNilLOVBatch()

Checks if the LOVBatch element is nil.

Returns:

true if the LOVBatch element is nil, otherwise false

isSetLOVBatch

boolean isSetLOVBatch()

Checks if the LOVBatch element is set.

Returns:

true if the LOVBatch element is set, otherwise false

setLOVBatch

void setLOVBatch(LOVBatch lovBatch)

Sets an LOVBatch object to specify which batch/chunk of the List Of Values(LOV) you want to retrieve.
If null, the chunk/batch will not be performed on the returned lists of values.

Parameters:

lovBatch - - an object containing LOVBatch parameters.

See Also:

LOVBatch

addNewLOVBatch

LOVBatch addNewLOVBatch()

Appends and returns a new empty LOVBatch element.

Returns:

a new empty LOVBatch element.

setNilLOVBatch

void setNilLOVBatch()

Sets the LOVBatch element to nil.

unsetLOVBatch

void unsetLOVBatch()

Unsets the LOVBatch element.

getDrillLOVRetrievalMode

DrillLOVRetrievalMode.Enum getDrillLOVRetrievalMode()

Internal Use Only.

xgetDrillLOVRetrievalMode

DrillLOVRetrievalMode xgetDrillLOVRetrievalMode()

Internal Use Only.

setDrillLOVRetrievalMode

void setDrillLOVRetrievalMode(DrillLOVRetrievalMode.Enum drillLOVRetrievalMode)

Sets the mode to retrieve List Of Values(LOV).
Example: Set the LOV retrieval mode
RetrieveDrillInfo boDrillInfo = new RetrieveDrillInfo();
boDrillInfo.setDrillLOVRetrievalMode(DrillLOVRetrievalMode.ALL);
RetrieveData retBOData = new RetrieveData();
retBOData.setRetrieveDrillInfo(boDrillInfo);
DocumentInformation docInfo = boRepEng.getDocumentInformation
(struid,null,null,null,retBOData);


Parameters:

drillLOVRetrievalMode - - a DrillLOVRetrievalMode object

See Also:

DrillLOVRetrievalMode

xsetDrillLOVRetrievalMode

void xsetDrillLOVRetrievalMode(DrillLOVRetrievalMode drillLOVRetrievalMode)

Internal Use Only.

getAddToDrillBar

java.lang.String getAddToDrillBar()

Gets the addToDrillBar attribute.

Returns:

the addToDrillBar attribute.

xgetAddToDrillBar

org.apache.xmlbeans.XmlString xgetAddToDrillBar()

Internal Use Only.

isSetAddToDrillBar

boolean isSetAddToDrillBar()

Checks if the addToDrillBar attribute is set.

Returns:

true if the AddToDrillBar attribute is set, otherwise false

setAddToDrillBar

void setAddToDrillBar(java.lang.String addToDrillBar)

Sets the addToDrillBar attribute

Parameters:

addToDrillBar - the String value of addToDrillBar attribute

xsetAddToDrillBar

void xsetAddToDrillBar(org.apache.xmlbeans.XmlString addToDrillBar)

Internal Use Only.

unsetAddToDrillBar

void unsetAddToDrillBar()

Unsets the addToDrillBar attribute

getRemoveFromDrillBar

java.lang.String getRemoveFromDrillBar()

Gets the removeFromDrillBar attribute.

Returns:

the removeFromDrillBar attribute.

xgetRemoveFromDrillBar

org.apache.xmlbeans.XmlString xgetRemoveFromDrillBar()

Internal Use Only.

isSetRemoveFromDrillBar

boolean isSetRemoveFromDrillBar()

Checks if the removeFromDrillBar attribute is set.

Returns:

true if the removeFromDrillBar attribute is set, otherwise false

setRemoveFromDrillBar

void setRemoveFromDrillBar(java.lang.String removeFromDrillBar)

Sets the removeFromDrillBar attribute.

Parameters:

removeFromDrillBar - - The String value of removeFromDrillBar attribute

xsetRemoveFromDrillBar

void xsetRemoveFromDrillBar(org.apache.xmlbeans.XmlString removeFromDrillBar)

Internal Use Only.

unsetRemoveFromDrillBar

void unsetRemoveFromDrillBar()

Unsets the removeFromDrillBar attribute