public abstract class ECQuery
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String | ADMIN_ROLES
Key used to store vector of administrative roles
|
static java.lang.String | CLASSNAME
The class name.
|
static java.lang.String | COPYRIGHT
IBM Copyright
|
static java.lang.Integer | DEFAULT_START
Default start position.
|
protected static java.lang.String | ROLE_PARAMETER_MARKERS
Key used to store role parameter markers to be used in query.
|
static java.lang.Integer | UNDEFINED_MAX_RESULTS
Default maximum number of results to fetch.
|
Constructor and Description |
---|
ECQuery()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.util.Vector | executeQuery(java.sql.Connection aConnection)
Build up the search query based on the defined parameters, and execute it.
|
protected java.util.Vector | extractRowFromResultSet(java.sql.ResultSet resultSet)
Extract the current row from the java.sql.ResultSet .
|
TableField[] | getAdditionalSelectTableFields()
This method returns the additional TableField objects defined for the SELECT clause.
|
protected abstract java.util.HashMap | getAliasedTableNames()
Returns a HashMap mapping aliases to table names.
|
protected abstract TableField[] | getDefaultSelectTableFields()
Abstract method should be overridden in the child class.
|
protected abstract java.util.Vector | getJoinInformation()
Get the join information.
|
protected WhereClauseCondition | getJoinWhereClause()
Get the JOIN WHERE clause.
|
java.lang.Integer | getMaxResults()
Get the value for the maximum number of results to return.
|
protected static java.util.Hashtable | getMemberSearchData()
Returns data representing MemberSearch.xml that defines the roles to be used in the Organization and User queries.
|
TableField | getOrderBy()
Get the ORDER BY clause.
|
java.lang.Integer | getResultSize()
Get the count of all elements matched by this search.
|
boolean | getRetrieveCountOnly()
Get whether or not to retrieve the count only.
|
java.lang.Integer | getStart()
Get the value for the start cursor position.
|
boolean | getUncommittedRead()
Get whether or not to use UNCOMMITTED READ in the query.
|
WhereClauseCondition | getWhereClause()
Gets the WhereClauseCondition object to be used to generate the WHERE clause(s) used by this query.
|
protected static void | initializeQueries(java.util.Hashtable ahshSearchElement, java.util.HashMap ahshQueries)
Helper method to store the Organization and User search queries based on WC_install_dir\xml\tools\buyerconsole\MemberSearch.xml
|
boolean | isValid()
Sanity check on the query, check that the parameters are properly initialized.
|
void | setAdditionalSelectTableFields(TableField[] atfAdditionalSelectTableFields)
Set the additional TableField objects to return as part of this query execution.
|
void | setAllFromTables(java.util.Set aSetFromTables)
Set the FROM Tables for the search query If not specified, by default, the FROM tables will be taken from the SELECT, WHERE and JOIN clauses.
|
void | setMaxResults(java.lang.Integer aInMaxResults)
Set the value for the maximum number of results to return.
|
void | setOrderBy(TableField atfOrderBy)
Set the ORDER BY clause.
|
void | setRetrieveCountOnly(boolean abRetrieveCountOnly)
Set whether or not to retrieve the count only.
|
void | setStart(java.lang.Integer anStart)
Set the value for the start cursor position.
|
void | setUncommittedRead(boolean abUncomittedRead)
Set whether or not to use UNCOMMITTED READ in the query.
|
void | setWhereClause(WhereClauseCondition aWhereClause)
Set the WHERE clauses for this query.
|
java.lang.String | toString()
Print the object, for tracing purposes.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public static final java.lang.Integer DEFAULT_START
public static final java.lang.Integer UNDEFINED_MAX_RESULTS
protected static final java.lang.String ADMIN_ROLES
protected static final java.lang.String ROLE_PARAMETER_MARKERS
protected static java.util.Hashtable getMemberSearchData()
protected abstract java.util.Vector getJoinInformation()
protected abstract TableField[] getDefaultSelectTableFields()
protected abstract java.util.HashMap getAliasedTableNames()
public WhereClauseCondition getWhereClause()
public void setWhereClause(WhereClauseCondition aWhereClause)
public final TableField[] getAdditionalSelectTableFields()
public final void setAdditionalSelectTableFields(TableField[] atfAdditionalSelectTableFields)
public java.lang.Integer getMaxResults()
public void setMaxResults(java.lang.Integer aInMaxResults)
public boolean getRetrieveCountOnly()
public void setRetrieveCountOnly(boolean abRetrieveCountOnly)
public java.lang.Integer getStart()
public void setStart(java.lang.Integer anStart)
public java.lang.Integer getResultSize()
public TableField getOrderBy()
public void setOrderBy(TableField atfOrderBy)
public java.util.Vector executeQuery(java.sql.Connection aConnection) throws java.sql.SQLException
protected WhereClauseCondition getJoinWhereClause()
public boolean isValid()
protected java.util.Vector extractRowFromResultSet(java.sql.ResultSet resultSet) throws java.sql.SQLException
public java.lang.String toString()
public void setUncommittedRead(boolean abUncomittedRead)
public boolean getUncommittedRead()
public void setAllFromTables(java.util.Set aSetFromTables)
protected static void initializeQueries(java.util.Hashtable ahshSearchElement, java.util.HashMap ahshQueries)