org.sdmxsource.sdmx.api.model.superbeans.registry.RegistrationSuperBean 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.model.superbeans.registry;

import org.sdmxsource.sdmx.api.constants.TERTIARY_BOOL;
import org.sdmxsource.sdmx.api.model.base.SdmxDate;
import org.sdmxsource.sdmx.api.model.beans.base.DataSourceBean;
import org.sdmxsource.sdmx.api.model.beans.registry.RegistrationBean;
import org.sdmxsource.sdmx.api.model.superbeans.base.MaintainableSuperBean;

/**
 * Wraps a registration bean, has all referenced structures by compoisition
 */
public interface RegistrationSuperBean extends MaintainableSuperBean {

    /**
     * Gets index time series.
     *
     * @return the index time series
     */
    TERTIARY_BOOL getIndexTimeSeries();

    /**
     * Gets index dataset.
     *
     * @return the index dataset
     */
    TERTIARY_BOOL getIndexDataset();

    /**
     * Gets index attributes.
     *
     * @return the index attributes
     */
    TERTIARY_BOOL getIndexAttributes();

    /**
     * Gets index reporting period.
     *
     * @return the index reporting period
     */
    TERTIARY_BOOL getIndexReportingPeriod();

    /**
     * Gets last updated.
     *
     * @return the last updated
     */
    SdmxDate getLastUpdated();

    /**
     * Gets valid from.
     *
     * @return the valid from
     */
    SdmxDate getValidFrom();

    /**
     * Gets valid to.
     *
     * @return the valid to
     */
    SdmxDate getValidTo();


    /**
     * Gets data source.
     *
     * @return the data source
     */
    DataSourceBean getDataSource();

    /**
     * Returns the provision agreement that this registration is referencing
     *
     * @return provision agreement
     */
    ProvisionAgreementSuperBean getProvisionAgreement();

    /**
     * Override of interface method
     */
    @Override
    RegistrationBean getBuiltFrom();
}