com.landawn.abacus.Session Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-entity-manager Show documentation
Abacus Entity Manager
The newest version!
/*
 * Copyright (C) 2015 HaiYang Li
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-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 com.landawn.abacus;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import com.landawn.abacus.annotation.Beta;
import com.landawn.abacus.condition.Condition;
import com.landawn.abacus.util.u.Optional;

// TODO: Auto-generated Javadoc
/**
 *
 * @author Haiyang Li
 * @param  the entity type
 * @since 0.8
 */
@Beta
@Deprecated
public interface Session {

    /**
     * Start a transaction.
     *
     * @param isolationLevel
     * @return Transaction
     * @see com.landawn.abacus.DBAccess#startTransaction(IsolationLevel, Map)
     */
    Transaction beginTransaction(IsolationLevel isolationLevel);

    /**
     *
     * @param  the target entity type
     * @param entityId
     * @param selectPropNames
     * @return
     */
     Optional get(EntityId entityId, Collection selectPropNames);

    /**
     * Gets the t.
     *
     * @param  the target entity type
     * @param entityId
     * @param selectPropNames
     * @return
     */
     TT gett(EntityId entityId, Collection selectPropNames);

    /**
     *
     * @param  the target entity type
     * @param entityName
     * @param selectPropNames
     * @param condition
     * @return
     */
     List list(String entityName, Collection selectPropNames, Condition condition);

    /**
     * Make the entity instances managed and persistent. The entity in {@code entities} must be the same type entity.
     * the changes will be committed to data store when flush API is called or the session is closed.
     *
     * @param entities
     */
    void add(T... entities);

    /**
     * Make the entity instances managed and persistent. The entity in {@code entities} must be the same type entity.
     * the changes will be committed to data store when flush API is called or the session is closed.
     *
     * @param entities
     */
    void add(Collection entities);

    /**
     * Add these entities to the entity list managed by this session. Any update in these entities will be committed to
     * data store when flush this session.
     *
     * @param entities
     */
    void update(T... entities);

    /**
     * Add these entities to the entity list managed by this session. Any update in these entities will be committed to
     * data store when flush this session.s Collection
     *
     * @param entities
     */
    void update(Collection entities);

    /**
     * Mark these entities to delete from data store. the changes will be committed to data store when flush API is
     * called or the session is closed. the specified entities will be detached if flush successfully.
     *
     * @param entities
     * @see com.landawn.abacus.util.Options.Eran
     */
    void delete(T... entities);

    /**
     * Mark these entities to delete from data store. the changes will be committed to data store when flush API is
     * called or the session is closed. the specified entities will be detached if flush successfully.
     *
     * @param entities
     * @see com.landawn.abacus.util.Options.Eran
     */
    void delete(Collection entities);

    /**
     * Remove these entities from the entity list managed by this session. Any update in these entities will not be
     * committed to data store when flush this session.
     *
     * @param entities
     */
    void detach(T... entities);

    /**
     * Remove these entities from the entity list managed by this session. Any update in these entities will not be
     * committed to data store when flush this session.
     *
     * @param entities
     */
    void detach(Collection entities);

    /**
     * Check if the instance belongs to the current persistence context.
     *
     * @param entity
     * @return boolean
     */
    boolean contains(T entity);

    /**
     * 
     * @return boolean
     */
    boolean isDirty();

    /**
     * Synchronize the persistence context to the underlying database.
     */
    void flush();

    /**
     * Method clear.
     */
    void clear();

    /**
     * flush and close this session.
     */
    void close();

    /**
     * 
     * @return boolean
     */
    boolean isClosed();
}