org.sdmxsource.sdmx.api.model.beans.metadatastructure.MetadataAttributeBean 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.beans.metadatastructure;

import org.sdmxsource.sdmx.api.constants.TERTIARY_BOOL;
import org.sdmxsource.sdmx.api.model.beans.base.ComponentBean;

import java.util.List;


/**
 * A MetadataAttributeBean is used in a ReportStructureBean and is similar to a DimensionBean
 * in that it contains reference to a semantic (ConceptBean) and representation (codelists/free text)
 *
 * @author Matt Nelson
 */
public interface MetadataAttributeBean extends ComponentBean {

    /**
     * Gets min occurs.
     *
     * @return the min occurs
     */
    Integer getMinOccurs();

    /**
     * Gets max occurs.
     *
     * @return the max occurs
     */
    Integer getMaxOccurs();

    /**
     * Gets presentational.
     *
     * @return the presentational
     */
    TERTIARY_BOOL getPresentational();

    /**
     * Returns any child metadata attributes
     *
     * NOTEThe list is a copy so modifying the returned list will not
     * be reflected in the MetadataAttributeBean instance
     *
     * @return metadata attributes
     */
    List getMetadataAttributes();


}