001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar 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 * Sonar 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
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.api.web;
021
022import java.lang.annotation.*;
023
024/**
025 * Depending on its scope, a widget can be available for project dashboards <code>(value = "PROJECT")</code>,
026 * global dashboards <code>(value = "GLOBAL")</code> or both <code>(value = {"PROJECT", "GLOBAL"})</code>.
027 * 
028 * <p>Before version 3.1 all widget had a scope <code>"PROJECT"</code>. If a widget is not annotated with {@WidgetScope},
029 * then is is assumed project scoped.</p>
030 *
031 * @since 3.1
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Target(ElementType.TYPE)
035public @interface WidgetScope {
036  String PROJECT = "PROJECT";
037  String GLOBAL = "GLOBAL";
038
039  String[] value() default PROJECT;
040}