org.sbml.jsbml.ext.spatial.SpatialNamedSBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsbml-spatial Show documentation
The newest version!
/*
 * ----------------------------------------------------------------------------
 * This file is part of JSBML. Please visit 
 * for the latest version of JSBML and more information about SBML.
 * 
 * Copyright (C) 2009-2022 jointly by the following organizations:
 * 1. The University of Tuebingen, Germany
 * 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
 * 3. The California Institute of Technology, Pasadena, CA, USA
 * 4. The University of California, San Diego, La Jolla, CA, USA
 * 5. The Babraham Institute, Cambridge, UK
 * 
 * This 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. A copy of the license agreement is provided
 * in the file named "LICENSE.txt" included with this software distribution
 * and also available online as .
 * ----------------------------------------------------------------------------
 */
package org.sbml.jsbml.ext.spatial;

import org.sbml.jsbml.NamedSBase;
import org.sbml.jsbml.SBase;

/**
 * Interface used to tell if a spatial class can have an id or not. Deprecated, {@link NamedSBase} should be used. 
 * 
 * @author Alex Thomas
 * @since 1.0
 * @deprecated since id and name have been added to the spatial package classes, this interface is not needed any more and {@link NamedSBase} can be used instead.
 */
public interface SpatialNamedSBase extends SBase {

  /**
   * Unsets the id
   *
   * @return {@code true}, if id was set before, otherwise {@code false}
   * @deprecated use {@link SBase#unsetId()}
   */
  public boolean unsetSpatialId();

  /**
   * Sets the value of the id
   * 
   * @param id the id to set
   * @deprecated use {@link SBase#setId(String)}
   */
  public void setSpatialId(String id);

  /**
   * Returns whether id is set
   *
   * @return whether id is set
   * @deprecated use {@link SBase#isSetId()}
   */
  public boolean isSetSpatialId();

  /**
   * Returns the value of the id attribute
   *
   * @return the value of id
   * @deprecated use {@link SBase#getId()}
   */
  public String getSpatialId();

}