org.sdmxsource.sdmx.api.manager.persist.mutable.SdmxMutableProvisionPersistenceManager Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2013 Metadata Technology Ltd.
 *
 * All rights reserved. This program and the accompanying materials are made 
 * available under the terms of the GNU Lesser General Public License v 3.0 
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * This file is part of the SDMX Component Library.
 *
 * The SDMX Component Library is free software: you can redistribute it and/or 
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * The SDMX Component Library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser 
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License 
 * along with The SDMX Component Library If not, see 
 * http://www.gnu.org/licenses/lgpl.
 *
 * Contributors:
 * Metadata Technology - initial API and implementation
 ******************************************************************************/
package org.sdmxsource.sdmx.api.manager.persist.mutable;

import org.sdmxsource.sdmx.api.model.mutable.registry.ProvisionAgreementMutableBean;

/**
 * Manages the persistence of provisions - this interface deals with mutable beans, so extra validation is performed to
 * ensure the mutable bean conforms to the SDMX rules
 *
 * @author Matt Nelson
 */
public interface SdmxMutableProvisionPersistenceManager {
    /**
     * Saves the provision agreement
     *
     * @param provisionAgreement the provision agreement
     * @return ProvisionAgreementMutableBean as a representation of what was saved - with values such as URN generated by the system
     */
    ProvisionAgreementMutableBean saveProvision(ProvisionAgreementMutableBean provisionAgreement);

    /**
     * Deletes the provision agreement
     *
     * @param provisionAgreement the provision agreement
     */
    void deleteProvision(ProvisionAgreementMutableBean provisionAgreement);
}