com.ibm.commerce.pagelayout.facade.server.services.dataaccess.db.jdbc

Class LayoutSearchSQLComposer

java.lang.Object

com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc.SQLComposer

com.ibm.commerce.pagelayout.facade.server.services.dataaccess.db.jdbc.LayoutSearchSQLComposer

All Implemented Interfaces:

java.io.Serializable

public class LayoutSearchSQLComposer
extends SQLComposer

The SQL composer class is to compose the queries to narrow the layout search result by layout type, isTemplate, and startDate, endDate of the layout.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc.SQLComposer

SQLComposer.SQLComposerInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
LayoutSearchSQLComposer()

Method Summary

Modifier and Type	Method and Description
SQLComposer.SQLComposerInfo	composeSQLStatement(java.lang.String sqlName, java.lang.String entityTableName, java.util.List resultSetInfo, java.lang.String sqlstatement, java.util.List params) This method composes an SQL statement by appending AND conditions to the WHERE clause of the given SQL statement according to the search criteria specified using the control parameters in the Get Expression.

Methods inherited from class com.ibm.commerce.foundation.server.services.dataaccess.db.jdbc.SQLComposer

getSelectionCriteria, setSelectionCriteria

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

LayoutSearchSQLComposer

public LayoutSearchSQLComposer()

Method Detail

composeSQLStatement

public SQLComposer.SQLComposerInfo composeSQLStatement(java.lang.String sqlName,
                                                       java.lang.String entityTableName,
                                                       java.util.List resultSetInfo,
                                                       java.lang.String sqlstatement,
                                                       java.util.List params)
                                                throws DataServiceSystemException

This method composes an SQL statement by appending AND conditions to the WHERE clause of the given SQL statement according to the search criteria specified using the control parameters in the Get Expression.

The control parameters are documented in the searchLayouts() method in PageLayoutFacadeClient. Based upon the control parameters that are specified, the AND conditions are constructed and appended to the WHERE clause, e.g. AND PAGELAYOUT.ISTEMPLATE = 1 AND PAGELAYOUT.STARTDATE >= '2009-01-01 00:00:00.0'.

Specified by:

composeSQLStatement in class SQLComposer

Parameters:

sqlName - The name of the SQL statement specified in the query template

entityTableName - The entity table name specified in the query template

resultSetInfo - The current resultSet information, which is a list of ResultSetData. If there is no result set information, this will an empty list and the value will never be null.

sqlstatement - The optional SQL statement specified in the query template. This could be null if there is no SQL statement specified in the query template

params - A list of optional parameters of type String specified in the query template. If no parameters are specified, this would be an empty list and will never be null.

Returns:

A structure representing the updated SQL statement, its resultSet information.

Throws:

DataServiceSystemException