001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.web;
021
022/**
023 * Widget in project dashboard page. It's recommended to also extend AbstractRubyTemplate :
024 * <p/>
025 * <code>
026 * public class MyWidget extends AbstractRubyTemplate implements RubyRailsWidget {
027 * protected String getTemplatePath() {
028 * return "/myplugin/my_template.erb";
029 * }
030 * }
031 * </code>
032 *
033 * @since 1.11
034 */
035public interface RubyRailsWidget extends Widget {
036  /**
037   * @return content of the Ruby on Rails template
038   */
039  String getTemplate();
040}