org.sdmxsource.sdmx.api.model.beans.reference.CrossReferenceBean Maven / Gradle / Ivy
/*******************************************************************************
* 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.reference;
import org.sdmxsource.sdmx.api.model.beans.base.IdentifiableBean;
import org.sdmxsource.sdmx.api.model.beans.base.SDMXBean;
/**
* A Cross Reference is a fully formed (all parameters present) immutable structure reference.
*
* A Cross Reference uniquely references a single structure
*
* @author Matt Nelson
*/
public interface CrossReferenceBean extends StructureReferenceBean {
/**
* Returns the structure that this cross reference belongs to
*
* @return referenced from
*/
SDMXBean getReferencedFrom();
/**
* Creates a mutable instance of this cross reference
*
* @return structure reference bean
*/
StructureReferenceBean createMutableInstance();
/**
* Returns true if the identifiable bean is a match for this cross reference
*
* @param identifiableBean the identifiable bean
* @return true if the identifiable bean is a match for this cross reference
*/
boolean isMatch(IdentifiableBean identifiableBean);
}