PersistentAgreement.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;

import org.ogf.graap.wsag.api.Agreement;
import org.w3.x2005.x08.addressing.EndpointReferenceType;

/**
 * PersistentAgreement
 * 
 * @author Oliver Waeldrich
 * 
 */
public interface PersistentAgreement
    extends Agreement
{

    /**
     * @return The agreement instance itself.
     */
    Agreement getAgreement();

    /**
     * @deprecated
     * 
     * @return The EPR of the agreement.
     */
    @Deprecated
    EndpointReferenceType getAgreementEPR();

    /**
     * Loads the agreement (based on the persisted /information/state, the configuration/etc.).
     * 
     * @throws Exception
     *             indicates an exception while loading the agreement from the database
     */
    void load() throws Exception;

    /**
     * Saves/persistes an agreement.
     * 
     * @throws Exception
     *             indicates an exception while saving the agreement to the database
     */
    void save() throws Exception;

    /**
     * Deletes an agreement at the persistence layer.
     * 
     * @throws Exception
     *             failed to delete agreement
     */
    void delete() throws Exception;

}