/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/kernel/trunk/kernel-util/src/main/java/org/sakaiproject/util/MultiSingleStorageSql.java $
* $Id: MultiSingleStorageSql.java 51317 2008-08-24 04:38:02Z csev@umich.edu $
***********************************************************************************
*
* Copyright (c) 2007, 2008 Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.util;
/**
* database methods.
*/
public interface MultiSingleStorageSql
{
/**
* returns the sql statement which deletes some rows.
*/
public String getDeleteSql(String field, String table);
/**
* returns the sql statement which deletes locks.
*/
public String getDeleteLocksSql();
/**
* returns the sql statement which deletes locks.
*/
public String getInsertLocks();
/**
* returns the sql statement which retrieves a resource id.
*/
public String getResourceIdSql(String field, String table);
/**
* returns the sql statement which retrieves the xml field from the specified table.
*/
public String getXmlSql(String table);
/**
* returns the sql statement which retrieves the xml field from the specified table.
*/
public String getXmlSql(String field, String table);
/**
* returns the sql statement which retrieves the xml field from the specified table.
*/
public String getXmlLikeSql(String field, String table);
/**
* returns the sql statement which retrieves the xml field from the specified table.
*/
public String getXmlWhereSql(String table, String where);
/**
* returns the sql statement which retrieves the specified field and the xml field from the specified table.
*/
public String getXmlAndFieldSql(String field, String table);
/**
* returns the sql statement which retrieves the xml field from the specified table and limits the result set.
*/
public String getXmlSql(String field, String table, int first, int last);
/**
* returns an array of objects needed for the getXmlSql statement with limits.
*/
public Object[] getXmlFields(int first, int last);
/**
* returns the sql statement which retrieves the number of rows in the specified table.
*/
public String getNumRowsSql(String table);
/**
* returns the sql statement which retrieves the number of rows in the specified table.
*/
public String getNumRowsSql(String table, String where);
/**
* Set the storage fields for this type
* @param storageFields
*/
public void setStorageFields(String storageFields);
/**
* returns the SQL statement which retrieves a limited number of rows selected by a particular value for a specified field
* (the selectBy parameter) and returned in ascending order by another specified field (the orderBy parameter). The limit
* on the number of rows is specified by values for the first item to be retrieved (indexed from 0) and the maxCount.
* @param selectBy The name of a field to be used in a where clause with the value provided separately.
* @param orderBy The name of a field to be used in an order-by clause
* @param tableName The table on which the query is to operate
* @param first A non-negative integer indicating the first record to return, indexed from 0.
* @param maxCount A positive integer indicating the maximum number of records to return
*/
public String getXmlWhereLimitSql(String selectBy, String orderBy, String tableName, int first, int maxCount);
}