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 */
020
021package org.sonar.api.technicaldebt.server;
022
023import org.sonar.api.rule.RuleKey;
024import org.sonar.api.utils.WorkUnit;
025
026import javax.annotation.CheckForNull;
027
028/**
029 * @since 4.1
030 */
031public interface Characteristic {
032
033  Integer id();
034
035  String key();
036
037  String name();
038
039  Integer order();
040
041  @CheckForNull
042  Integer parentId();
043
044  @CheckForNull
045  Integer rootId();
046
047  RuleKey ruleKey();
048
049  String function();
050
051  WorkUnit factor();
052
053  WorkUnit offset();
054
055  boolean isRoot();
056
057  boolean isRequirement();
058
059}