Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.businessobjects.rebean.wi
Interface DataSource

public interface DataSource

The DataSource interface defines a single data source.

See Also:
DataProvider.getDataSource(), DataSourceObjects

Method Summary
 DataSourceObjects getClasses()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getComments()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getDomainID()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getDomainName()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 DataSourceObjects getHierarchies()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getID()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getLongName()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 int getMaxInListNumber()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 int getMaxRetrievalTime()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 int getMaxRowsRetrieved()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getName()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 DataSourceParameters getParameters()
          Returns the collection of DataSourceParameter for this data source.
 DataSourceParameters getParameters(java.lang.String className)
          Returns the collection of DataSourceParameter for this data source, matching the specified parameter class name.
 java.lang.String getUniverseID()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isAdvancedConditionSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isBothOperatorSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isCombinedQuerySupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isConditionObjectValueSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isDuplicateRowSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isExceptOperatorSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isIsNullOperatorSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isMissingRowSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isNotIsNullOperatorSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isRankConditionSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 boolean isViewSQLSupported()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 

Method Detail

getID

java.lang.String getID()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the DataSource ID.

Returns:
the DataSource ID

getUniverseID

java.lang.String getUniverseID()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns data source's attached universe id.

Returns:
data source's attached universe id

getName

java.lang.String getName()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the name of the DataSource.

Returns:
Returns the name of the DataSource.
See Also:
DataProvider

getDomainName

java.lang.String getDomainName()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the name of the domain in which the DataSource is stored.

Returns:
the domain name

getDomainID

java.lang.String getDomainID()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the ID of the domain in which the DataSource is stored.

Returns:
Returns the ID of the domain in which the DataSource is stored.

getLongName

java.lang.String getLongName()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the long name of the DataProvider.

Returns:
Returns the long name of the Data

getComments

java.lang.String getComments()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns comments about the DataSource.

Returns:
Returns comments about the DataSource.

getClasses

DataSourceObjects getClasses()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the classes contained in the DataSource.

Returns:
Returns the classes contained in the DataSource.

getHierarchies

DataSourceObjects getHierarchies()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the hierarchies contained in the DataSource.

Returns:
Returns the hierarchies contained in the DataSource.

getMaxRowsRetrieved

int getMaxRowsRetrieved()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the maximum number of rows to be retrieved from a database when a query is run.

Note: The maximum no of rows is set by the Business Objects Universe designer.

Returns:
the maximum number of rows or -1 when no maximum is defined in the associated Business Objects Universe.
Since:
11.5

getMaxRetrievalTime

int getMaxRetrievalTime()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the maximum amount of time to elapse when a query is run.

Note: The maximum retrieval time is set by the Business Objects Universe designer.

Returns:
the maximum amount of time in milliseconds or -1 when no maximum time is defined in the associated Business Objects Universe.
Since:
11.5

isRankConditionSupported

boolean isRankConditionSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource object supports condition ranking.

Returns:
true if the DataSource object supports condition ranking, false if ranking is not supported.
Since:
11.5

isAdvancedConditionSupported

boolean isAdvancedConditionSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource object supports AdvancedCondition.

Returns:
true if the DataSource object supports AdvancedCondition.
Since:
11.5

isCombinedQuerySupported

boolean isCombinedQuerySupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports combined queries.

Returns:
Returns true if the DataSource supports combined queries.
Since:
11.5
See Also:
CombinedQueryOperator

isBothOperatorSupported

boolean isBothOperatorSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports the Operator.BOTH operator in a FilterCondition.

Returns:
Returns true if the DataSource supports the Operator.BOTH operator in a FilterCondition.
Since:
11.5
See Also:
Operator, FilterCondition

isExceptOperatorSupported

boolean isExceptOperatorSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports the Operator.EXCEPT operator in a FilterCondition.

Returns:
Returns true if the DataSource supports the Operator.EXCEPT operator in a FilterCondition.
Since:
11.5
See Also:
Operator, FilterCondition

isIsNullOperatorSupported

boolean isIsNullOperatorSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports the Operator.IS_NULL operator in a FilterCondition.

Returns:
Returns true if the DataSource supports the Operator.IS_NULL operator in a FilterCondition.
Since:
11.5
See Also:
Operator

isNotIsNullOperatorSupported

boolean isNotIsNullOperatorSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports the Operator.NOT_IS_NULL operator in a FilterCondition.

Returns:
Returns true if the DataSource supports the Operator.NOT_IS_NULL operator in a FilterCondition.
Since:
11.5
See Also:
Operator

isConditionObjectValueSupported

boolean isConditionObjectValueSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports ConditionObjectValue in a FilterCondition.

Returns:
Returns true if the DataSource supports the ConditionObjectValue operator in a FilterCondition.
Since:
11.5
See Also:
Operator

isViewSQLSupported

boolean isViewSQLSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports Sql Statement. When it returns false, DataProvider.getSQLContainer() returns null.

Returns:
true or false.
Since:
11.5

isDuplicateRowSupported

boolean isDuplicateRowSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports duplicated rows in query result.

Returns:
true or false.
Since:
11.5

isMissingRowSupported

boolean isMissingRowSupported()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns true if the DataSource supports empty rows in query result.

Returns:
true or false.
Since:
11.5

getMaxInListNumber

int getMaxInListNumber()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the maximum number of values possible in an INLIST query filter. MAX_INLIST_VALUES is a Universe parameter that controls the maximum number of value possible for an INLIST query filter.

This number is defined by the universe designer.

Note: The default value for this variable is 90, this value can be changed in a range of 0 - 265 by the universe designer.

Returns:
The maximum number of values possible in an INLIST query filter.
Since:
11.5

getParameters

DataSourceParameters getParameters()
Returns the collection of DataSourceParameter for this data source.

Returns:
a DataSourceParameters instance.
Since:
12.0

getParameters

DataSourceParameters getParameters(java.lang.String className)
Returns the collection of DataSourceParameter for this data source, matching the specified parameter class name.

Parameters:
className - the requested parameter class name.
Returns:
a DataSourceParameters instance.
Since:
12.0
See Also:
DataSourceParameter#getClass()
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD