// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.orsup.nonpublic;

import org.litesoft.db.*;
import org.litesoft.orsup.base.*;
import org.litesoft.orsup.selection.*;

public interface ORPersistenceHelper extends PersistenceHelper
{
    public long count( boolean pIncludingImmortalInactives, //
                       MetaDataForPO pMetaDataForPO, //
                       WhereClause pSelectionWhereClause )
            throws DBException;

    /**
     * @param pFinder               - either a NonTransactionalFinder or a Transaction
     * @param pMetaDataForPO        - Persisted Object MetaData
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     * @param pOffset               - Rows to Skip (>= 0 verified)
     * @param pLimit                - Max Rows to return (>= 1 verified)
     *
     * @return !Null
     *
     * @throws DBException - Exception regarding the OR layer
     */
    public POQueryIterator findSubset( Finder pFinder, //
                                       boolean pIncludingImmortalInactives, //
                                       MetaDataForPOinternalExtension pMetaDataForPO, //
                                       WhereClause pSelectionWhereClause, OrderBy pOrderBy, //
                                       long pOffset, int pLimit )
            throws DBException;

    /**
     * @return !null
     */
    public POQueryIterator findAllCursored( Finder pFinder, POQueryFilter pPOQueryFilter, //
                                            boolean pIncludingImmortalInactives, //
                                            MetaDataForPOinternalExtension pMetaDataForPO, //
                                            WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws DBException;

    /**
     * @return !null
     */
    public POKeyIterator findAllKeysCursored( POKeyQueryFilter pPOKeyQueryFilter, //
                                              boolean pIncludingImmortalInactives, //
                                              MetaDataForPOinternalExtension pMetaDataForPO, //
                                              SimpleColumnDefinition pKeyColumn, WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws DBException;

    public void createTables( TableManager pTableManager, MetaDataForPO pMetaDataForPO )
            throws DBException;

    public void reCreateIndices( MetaDataForPO pMetaDataForPO )
            throws DBException;

    public void createIndex( MetaDataForPO pMetaDataForPO, MetaDataForPO.Index index )
            throws DBException;
}