IAgreementFactoryHome.java

/* 
 * Copyright (c) 2007, Fraunhofer-Gesellschaft
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * (1) Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the disclaimer at the end.
 *     Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 * 
 * (2) Neither the name of Fraunhofer nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 * 
 * DISCLAIMER
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 */
package org.ogf.graap.wsag.server.persistence;


/**
 * This interface encapsulates one or more agreement factory that are loaded with one agreement engine. An
 * agreement engine is based on one particular WSAG4J configuration, i.e. multiple factories can be exposed
 * through the persistence layer, where each factory is instantiated on the same engine configuration file.
 * 
 * @author Oliver Waeldrich
 * 
 */
public interface IAgreementFactoryHome
{

    /**
     * Finds an agreement factory with a given id.
     * 
     * @param factoryId
     *            ID of the agreement factory.
     * @return the factory with the given id
     * 
     * @throws Exception
     *             indicates an exception while loading the factory from the database
     */
    PersistentAgreementFactory find( String factoryId ) throws Exception;

    /**
     * Lists all agreement factories.
     * 
     * @return List of all agreement factories.
     * 
     * @throws Exception
     *             indicates an exception while loading the factories from the database
     */
    PersistentAgreementFactory[] list() throws Exception;

    /**
     * Removes the factory with the given ID.
     * 
     * @param factoryId
     *            ID of the factory to remove.
     * 
     * @throws Exception
     *             indicates an exception while removing the factory from the database
     */
    void remove( String factoryId ) throws Exception;

    /**
     * @deprecated
     * 
     * @param factories
     *            List of factories, which should be saved/persisted.
     * 
     * @throws Exception
     *             indicates an exception while saving the factory in the database
     */
    @Deprecated
    void saveAgreementFactories( PersistentAgreementFactory[] factories ) throws Exception;
}