com.businessobjects.dsws.reportengine
Interface LOV

public interface LOV

List Of Values objects are associated either with universe objects created using BusinessObjects Designer or a Crystal Report parameter.
Using a BusinessObjects universe LOV, values can be entered manually by the Universe designer or generated from the database. You can refresh the list to make sure the values displayed are the latest ones.For Web Services, you use a List Of Values when handling prompts or providing drill filters. In both these situations the user can select particular values for the object to focus on a particular aspect of a query or filter.

Example: Retrieving LOVs from associated prompt.

 if (boDocInfo.getMustFillPrompts())
 {
 PromptInfo[] boPromptInfo = boDocInfo.getPromptInfoArray();
 if(boPromptInfo[0].getHasLOV())
        {
 // Get the list of LOVs associated with this prompt.
                LOV objLOV=boPromptInfo[0].getLOV();
            //  Get the single (first) row of LOV data.
                Value[] objValue = objLOV.getValuesArray();
            for(int j=0;j<objValue.length; j++)
                {
                //      Get the content of all the columns in the row.
                String[] strColumns = objValue[j].getColumnsArray();
                        for(int i=0;i<strColumns.length;i++)
                        {
                                out.println(strColumns[i]);
                        }
                }
   }
 }
 

See Also:

SortType, Drill, DrillPath, DrillHierarchy, DrillInfo, Value, Action, RetrieveView, RetrieveData, PromptInfo, Action, FillPrompt, DiscretePromptValue, PromptValue, RangePromptValue, ReportEngine, DocumentInformation, LOVBatch, LOVSort, LOVSearch

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addBatchName(java.lang.String batchName) Internal Use Only.
void	addHeader(java.lang.String header) Internal Use Only.
org.apache.xmlbeans.XmlString	addNewBatchName() Internal Use Only.
org.apache.xmlbeans.XmlString	addNewHeader() Internal Use Only.
Value	addNewValues() Internal Use Only.
java.lang.String[]	getBatchNameArray() Returns an array containing the LOV batch names.
java.lang.String	getBatchNameArray(int i) Returns a single LOV batch name.
int	getCurrentBatchIndex() Returns current batch index on chunk LOV.
java.lang.String[]	getHeaderArray() Returns an array containing the LOV columns header names.
java.lang.String	getHeaderArray(int i) Returns a single LOV column header name.
boolean	getPartialResult() Returns true if the LOV has Partial Results
boolean	getRowIndexed() Returns true if the RowIndexed element is present, otherwise false.
boolean	getSearchActivated() Returns a boolean indicating whether a search has been applied on LOV.
boolean	getSorted() Returns a boolean indicating whether a sort has been applied on LOV.
int	getSortedColumnIndex() Returns the index of the column on which the sort has been applied.
SortType.Enum	getSortType() Returns the type of sort applied to this List Of Values.
Value[]	getValuesArray() Returns an array of Value containing the LOV row data.
Value	getValuesArray(int i) Returns a single row of LOV data.
void	insertBatchName(int i, java.lang.String batchName) Internal Use Only.
void	insertHeader(int i, java.lang.String header) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewBatchName(int i) Internal Use Only.
org.apache.xmlbeans.XmlString	insertNewHeader(int i) Internal Use Only.
Value	insertNewValues(int i) Internal Use Only.
boolean	isNilBatchNameArray(int i) Checks if the BatchName element is nil at the specified index position.
boolean	isNilHeaderArray(int i) Checks if the Header element is nil at the specified index position.
boolean	isNilValuesArray(int i) Checks if the Values element is nil at the specified index position.
void	removeBatchName(int i) Internal Use Only.
void	removeHeader(int i) Internal Use Only.
void	removeValues(int i) Internal Use Only.
void	setBatchNameArray(int i, java.lang.String batchName) Internal Use Only.
void	setBatchNameArray(java.lang.String[] batchNameArray) Internal Use Only.
void	setCurrentBatchIndex(int currentBatchIndex) Internal Use Only.
void	setHeaderArray(int i, java.lang.String header) Internal Use Only.
void	setHeaderArray(java.lang.String[] headerArray) Internal Use Only.
void	setNilBatchNameArray(int i) Internal Use Only.
void	setNilHeaderArray(int i) Sets the Header element to nil at the specified index position.
void	setNilValuesArray(int i) Internal Use Only.
void	setPartialResult(boolean partialResult) Internal Use Only.
void	setRowIndexed(boolean rowIndexed) Internal Use Only.
void	setSearchActivated(boolean searchActivated) Internal Use Only.
void	setSorted(boolean sorted) Internal Use Only.
void	setSortedColumnIndex(int sortedColumnIndex) Internal Use Only.
void	setSortType(SortType.Enum sortType) Internal Use Only.
void	setValuesArray(int i, Value values) Internal Use Only.
void	setValuesArray(Value[] valuesArray) Internal Use Only.
int	sizeOfBatchNameArray() Returns the size of BatchName array.
int	sizeOfHeaderArray() Returns the number of Header element.
int	sizeOfValuesArray() Returns the size of Values array
org.apache.xmlbeans.XmlString[]	xgetBatchNameArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetBatchNameArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetCurrentBatchIndex() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetHeaderArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetHeaderArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPartialResult() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRowIndexed() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetSearchActivated() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetSorted() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetSortedColumnIndex() Internal Use Only.
SortType	xgetSortType() Internal Use Only.
void	xsetBatchNameArray(int i, org.apache.xmlbeans.XmlString batchName) Internal Use Only.
void	xsetBatchNameArray(org.apache.xmlbeans.XmlString[] batchNameArray) Internal Use Only.
void	xsetCurrentBatchIndex(org.apache.xmlbeans.XmlInt currentBatchIndex) Internal Use Only.
void	xsetHeaderArray(int i, org.apache.xmlbeans.XmlString header) Internal Use Only.
void	xsetHeaderArray(org.apache.xmlbeans.XmlString[] headerArray) Internal Use Only.
void	xsetPartialResult(org.apache.xmlbeans.XmlBoolean partialResult) Internal Use Only.
void	xsetRowIndexed(org.apache.xmlbeans.XmlBoolean rowIndexed) Internal Use Only.
void	xsetSearchActivated(org.apache.xmlbeans.XmlBoolean searchActivated) Internal Use Only.
void	xsetSorted(org.apache.xmlbeans.XmlBoolean sorted) Internal Use Only.
void	xsetSortedColumnIndex(org.apache.xmlbeans.XmlInt sortedColumnIndex) Internal Use Only.
void	xsetSortType(SortType sortType) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getHeaderArray

java.lang.String[] getHeaderArray()

Returns an array containing the LOV columns header names.

Returns:

an array of strings containing the LOV columns header names.

getHeaderArray

java.lang.String getHeaderArray(int i)

Returns a single LOV column header name.

Parameters:

i - - The index of the column header to be retrieved.

Returns:

a single LOV column header name.

xgetHeaderArray

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

Internal Use Only.

xgetHeaderArray

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

Internal Use Only.

isNilHeaderArray

boolean isNilHeaderArray(int i)

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

Parameters:

i - the index of the Header element

Returns:

true if the header element is nil, otherwise false

sizeOfHeaderArray

int sizeOfHeaderArray()

Returns the number of Header element.

Returns:

the size of the Header array

setHeaderArray

void setHeaderArray(java.lang.String[] headerArray)

Internal Use Only.

setHeaderArray

void setHeaderArray(int i,
                    java.lang.String header)

Internal Use Only.

xsetHeaderArray

void xsetHeaderArray(org.apache.xmlbeans.XmlString[] headerArray)

Internal Use Only.

xsetHeaderArray

void xsetHeaderArray(int i,
                     org.apache.xmlbeans.XmlString header)

Internal Use Only.

setNilHeaderArray

void setNilHeaderArray(int i)

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

Parameters:

i - the index of the Header element

insertHeader

void insertHeader(int i,
                  java.lang.String header)

Internal Use Only.

addHeader

void addHeader(java.lang.String header)

Internal Use Only.

insertNewHeader

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

Internal Use Only.

addNewHeader

org.apache.xmlbeans.XmlString addNewHeader()

Internal Use Only.

removeHeader

void removeHeader(int i)

Internal Use Only.

getValuesArray

Value[] getValuesArray()

Returns an array of Value containing the LOV row data.

Returns:

an array of Value.

getValuesArray

Value getValuesArray(int i)

Returns a single row of LOV data.

Parameters:

i - - The index of the row to be retrieved.

Returns:

a single value of LOV data.

isNilValuesArray

boolean isNilValuesArray(int i)

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

Parameters:

i - the index of the Values element

Returns:

true if the Values element is nil, otherwise false

sizeOfValuesArray

int sizeOfValuesArray()

Returns the size of Values array

Returns:

the size of the Values array

setValuesArray

void setValuesArray(Value[] valuesArray)

Internal Use Only.

setValuesArray

void setValuesArray(int i,
                    Value values)

Internal Use Only.

setNilValuesArray

void setNilValuesArray(int i)

Internal Use Only.

insertNewValues

Value insertNewValues(int i)

Internal Use Only.

addNewValues

Value addNewValues()

Internal Use Only.

removeValues

void removeValues(int i)

Internal Use Only.

getBatchNameArray

java.lang.String[] getBatchNameArray()

Returns an array containing the LOV batch names.

Returns:

an array containing the LOV batch names.

getBatchNameArray

java.lang.String getBatchNameArray(int i)

Returns a single LOV batch name.

Parameters:

i - - The index of the batch name to be retrieved.

Returns:

an single value of LOV batch name.

xgetBatchNameArray

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

Internal Use Only.

xgetBatchNameArray

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

Internal Use Only.

isNilBatchNameArray

boolean isNilBatchNameArray(int i)

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

Parameters:

i - the index of the BatchName element

Returns:

true if the BatchName element is nil, otherwise false

sizeOfBatchNameArray

int sizeOfBatchNameArray()

Returns the size of BatchName array.

Returns:

the size of BatchName array.

setBatchNameArray

void setBatchNameArray(java.lang.String[] batchNameArray)

Internal Use Only.

setBatchNameArray

void setBatchNameArray(int i,
                       java.lang.String batchName)

Internal Use Only.

xsetBatchNameArray

void xsetBatchNameArray(org.apache.xmlbeans.XmlString[] batchNameArray)

Internal Use Only.

xsetBatchNameArray

void xsetBatchNameArray(int i,
                        org.apache.xmlbeans.XmlString batchName)

Internal Use Only.

setNilBatchNameArray

void setNilBatchNameArray(int i)

Internal Use Only.

insertBatchName

void insertBatchName(int i,
                     java.lang.String batchName)

Internal Use Only.

addBatchName

void addBatchName(java.lang.String batchName)

Internal Use Only.

insertNewBatchName

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

Internal Use Only.

addNewBatchName

org.apache.xmlbeans.XmlString addNewBatchName()

Internal Use Only.

removeBatchName

void removeBatchName(int i)

Internal Use Only.

getRowIndexed

boolean getRowIndexed()

Returns true if the RowIndexed element is present, otherwise false.

Returns:

true if the RowIndexed element is present, otherwise false

xgetRowIndexed

org.apache.xmlbeans.XmlBoolean xgetRowIndexed()

Internal Use Only.

setRowIndexed

void setRowIndexed(boolean rowIndexed)

Internal Use Only.

xsetRowIndexed

void xsetRowIndexed(org.apache.xmlbeans.XmlBoolean rowIndexed)

Internal Use Only.

getSortType

SortType.Enum getSortType()

Returns the type of sort applied to this List Of Values. LOV can be sorted by the following ways:

• Ascending
• Descending
• Unsorted

Returns:

the type of sort applied to this List Of Values.

xgetSortType

SortType xgetSortType()

Internal Use Only.

setSortType

void setSortType(SortType.Enum sortType)

Internal Use Only.

xsetSortType

void xsetSortType(SortType sortType)

Internal Use Only.

getSortedColumnIndex

int getSortedColumnIndex()

Returns the index of the column on which the sort has been applied. It equals 0 when LOVSort is null. It equals 0 when invalid sorted column index is passed in LOVSort.

Returns:

the index of the column on which the sort has been applied.

See Also:

LOVSort

xgetSortedColumnIndex

org.apache.xmlbeans.XmlInt xgetSortedColumnIndex()

Internal Use Only.

setSortedColumnIndex

void setSortedColumnIndex(int sortedColumnIndex)

Internal Use Only.

xsetSortedColumnIndex

void xsetSortedColumnIndex(org.apache.xmlbeans.XmlInt sortedColumnIndex)

Internal Use Only.

getSorted

boolean getSorted()

Returns a boolean indicating whether a sort has been applied on LOV.

Returns:

a boolean indicating whether a sort has been applied on LOV.

xgetSorted

org.apache.xmlbeans.XmlBoolean xgetSorted()

Internal Use Only.

setSorted

void setSorted(boolean sorted)

Internal Use Only.

xsetSorted

void xsetSorted(org.apache.xmlbeans.XmlBoolean sorted)

Internal Use Only.

getSearchActivated

boolean getSearchActivated()

Returns a boolean indicating whether a search has been applied on LOV.

Returns:

a boolean indicating whether a sort has been applied on LOV.

xgetSearchActivated

org.apache.xmlbeans.XmlBoolean xgetSearchActivated()

Internal Use Only.

setSearchActivated

void setSearchActivated(boolean searchActivated)

Internal Use Only.

xsetSearchActivated

void xsetSearchActivated(org.apache.xmlbeans.XmlBoolean searchActivated)

Internal Use Only.

getCurrentBatchIndex

int getCurrentBatchIndex()

Returns current batch index on chunk LOV.

Returns:

current batch index on chunk LOV.

See Also:

LOVBatch

xgetCurrentBatchIndex

org.apache.xmlbeans.XmlInt xgetCurrentBatchIndex()

Internal Use Only.

setCurrentBatchIndex

void setCurrentBatchIndex(int currentBatchIndex)

Internal Use Only.

xsetCurrentBatchIndex

void xsetCurrentBatchIndex(org.apache.xmlbeans.XmlInt currentBatchIndex)

Internal Use Only.

getPartialResult

boolean getPartialResult()

Returns true if the LOV has Partial Results

Returns:

true, if the LOV has Partial Results, otherwise false

xgetPartialResult

org.apache.xmlbeans.XmlBoolean xgetPartialResult()

Internal Use Only.

setPartialResult

void setPartialResult(boolean partialResult)

Internal Use Only.

xsetPartialResult

void xsetPartialResult(org.apache.xmlbeans.XmlBoolean partialResult)

Internal Use Only.