Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
11g Release 1 (11.1.1.7.0)
E14128-06

oracle.alm.connector.data
Class QueryInfo

java.lang.Object
  extended by oracle.alm.connector.data.QueryInfo

public class QueryInfo
extends java.lang.Object

The QueryInfo class contains information user provides in a query form specified by the Oracle Team Productivity Center (OTPC) client. Connector writer converts the data in this structure to the format needed for the connector code to perform query against backend repository.

Since:
11.1.1.1.0

Nested Class Summary
static class QueryInfo.Conjunction
          supported enumeration types for the query's conjuction.
 
Constructor Summary
QueryInfo()
          Sole constructor.
 
Method Summary
 QueryInfo.Conjunction getConjunction()
          Retrieves the conjunction used in the query.
 java.util.List<Criterion> getCriteria()
          Retrieves criteria used in the query.
 java.lang.String getDataSource()
          Retrieves the name of the data source for the query.
 java.util.List<java.lang.String> getDisplayNames()
          Gets list of column or field names to display in the query result's table.
 java.lang.String getSelectList()
          Retrieves the list of field names (comma delimited) used in the query.
 SortInfo getSortInfo()
          Retrieves query sort information.
 java.lang.String getWhereOptions()
          Retrieves the WHERE clause.
 void setConjunction(QueryInfo.Conjunction conjunction)
          Sets the conjunction to use in the query.
 void setDataSource(java.lang.String dataSource)
          Sets the data source of the query.
 void setSelectList(java.lang.String selectList)
          Sets list of the fields to query.
 void setSortInfo(SortInfo sortinfo)
          Sets the sort order to be used in the query result set.
 void setWhereOptions(java.lang.String clause)
          Sets the WHERE clause or condition of the query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryInfo

public QueryInfo()
Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

getDataSource

public java.lang.String getDataSource()
Retrieves the name of the data source for the query.

Returns:
the name of the data source

setDataSource

public void setDataSource(java.lang.String dataSource)
Sets the data source of the query.

Parameters:
dataSource - the name of the data source

setSelectList

public void setSelectList(java.lang.String selectList)
Sets list of the fields to query. These fields will contain data when the query returns.

Parameters:
selectList - list of field names (comma delimited)

getSelectList

public java.lang.String getSelectList()
Retrieves the list of field names (comma delimited) used in the query.

Returns:
list of the field names to query

setWhereOptions

public void setWhereOptions(java.lang.String clause)
Sets the WHERE clause or condition of the query.

Parameters:
clause - the where clause option for the query

getWhereOptions

public java.lang.String getWhereOptions()
Retrieves the WHERE clause.

Returns:
the where clause option for the query

setConjunction

public void setConjunction(QueryInfo.Conjunction conjunction)
Sets the conjunction to use in the query.

Parameters:
conjunction - the query conjunction

getConjunction

public QueryInfo.Conjunction getConjunction()
Retrieves the conjunction used in the query.

Returns:
the query conjunction

getDisplayNames

public java.util.List<java.lang.String> getDisplayNames()
Gets list of column or field names to display in the query result's table.

Returns:
list of field names

getCriteria

public java.util.List<Criterion> getCriteria()
Retrieves criteria used in the query.

Returns:
all criteria used in the current query info object

getSortInfo

public SortInfo getSortInfo()
Retrieves query sort information.

Returns:
SortInfo sort order information used in the query result set

setSortInfo

public void setSortInfo(SortInfo sortinfo)
Sets the sort order to be used in the query result set.

Parameters:
sortinfo - sort order to use

Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
11g Release 1 (11.1.1.7.0)
E14128-06

Copyright © 1999, 2013, Oracle. All rights reserved.