// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.orsup.base;

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

public interface UnfilteringFinder extends NonTransactionalFinder<UnfilteringFinder>
{
    public Transaction createUnaugmentedTransaction();

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     *
     * @throws DBException - Exception regarding the OR layer
     */
    public long count( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause )
            throws DBException;

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     *
     * @throws DBException - Exception regarding the OR layer
     */
    public long count( Class<? extends PersistentObject> pPersistedObjectClass, WhereClause pSelectionWhereClause )
            throws DBException;

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all, which will only succeed if the table only has one entry
     * @param pOrderBy              - null means order immaterial
     * @param pUpdateValuePairs     - additional columns to set
     *
     * @return 'snaged' PO or Null if no POs available to be 'snaged'
     *
     * @throws UnsupportedOperationException - if the PO type does not support 'snaging'
     * @throws DBException                   - other Exception regarding the OR layer
     */
    public PersistentObject<?> snagOne( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause, OrderBy pOrderBy, ColumnUpdateValuePair... pUpdateValuePairs )
            throws UnsupportedOperationException, DBException;

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all, which will only succeed if the table only has one entry
     * @param pOrderBy              - null means order immaterial
     * @param pUpdateValuePairs     - additional columns to set
     *
     * @return 'snaged' PO or Null if no POs available to be 'snaged'
     *
     * @throws UnsupportedOperationException - if the PO type does not support 'snaging'
     * @throws DBException                   - other Exception regarding the OR layer
     */
    public <T extends PersistentObject> T snagOne( Class<T> pPersistedObjectClass, WhereClause pSelectionWhereClause, OrderBy pOrderBy, ColumnUpdateValuePair... pUpdateValuePairs )
            throws UnsupportedOperationException, DBException;
}