org.apache.lenya.core.repository.api/src/main/java/org/apache/lenya/cms/repository/Session.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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 org.apache.lenya.cms.repository;

import org.apache.lenya.cms.observation.RepositoryEvent;
import org.apache.lenya.cms.observation.RepositoryListener;
import org.apache.lenya.transaction.ConcurrentModificationException;
//florent remove this identity as duplication of the core-ac one 
//import org.apache.lenya.transaction.Identity;
import org.apache.lenya.ac.Identity;

import org.apache.lenya.transaction.UnitOfWork;

/**
 * Repository session.
 */
public interface Session extends UnitOfWork {

    /**
     * @return the identity this session belongs to.
     */
    Identity getIdentity();

    /**
     * Commits the transaction.
     * @throws RepositoryException if an error occurs.
     * @throws ConcurrentModificationException if a transactionable has been
     *         modified by another session.
     */
    void commit() throws RepositoryException, ConcurrentModificationException;

    /**
     * Rolls the transaction back.
     * @throws RepositoryException if an error occurs.
     */
    void rollback() throws RepositoryException;

    /**
     * @param factory The factory.
     * @param key The key.
     * @return The item for the specific key.
     * @throws RepositoryException if an error occurs.
     */
    RepositoryItem getRepositoryItem(RepositoryItemFactory factory, String key)
            throws RepositoryException;

    /**
     * @param listener The listener to add.
     * @throws RepositoryException if the listener is already registered.
     */
    void addListener(RepositoryListener listener) throws RepositoryException;

    /**
     * Checks if a listener is registered.
     * @param listener The listener.
     * @return A boolean value.
     */
    boolean isListenerRegistered(RepositoryListener listener);

    /**
     * @param event The event to add to the queue.
     */
    void enqueueEvent(RepositoryEvent event);

    /**
     * @param identity The identity.
     */
    void setIdentity(Identity identity);

    /**
     * @return if the repository items in this session can be modified.
     */
    boolean isModifiable();

    /**
     * @return The ID of this session.
     */
    String getId();

    /**
     * @return The holder of this session.
     */
    SessionHolder getHolder();
    
    /**
     * @param holder The holder of this session.
     */
    void setHolder(SessionHolder holder);

}