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;
025import org.sonar.api.utils.internal.WorkDuration;
026
027import javax.annotation.CheckForNull;
028
029/**
030 * @since 4.1
031 */
032public interface Characteristic {
033
034  Integer id();
035
036  String key();
037
038  String name();
039
040  Integer order();
041
042  @CheckForNull
043  Integer parentId();
044
045  @CheckForNull
046  Integer rootId();
047
048  RuleKey ruleKey();
049
050  String function();
051
052  /**
053   * @deprecated since 4.2
054   */
055  @Deprecated
056  @CheckForNull
057  WorkUnit factor();
058
059  /**
060   * @since 4.2
061   */
062  @CheckForNull
063  Integer factorValue();
064
065  /**
066   * @since 4.2
067   */
068  @CheckForNull
069  WorkDuration.UNIT factorUnit();
070
071  /**
072   * @deprecated since 4.2
073   */
074  @Deprecated
075  @CheckForNull
076  WorkUnit offset();
077
078  /**
079   * @since 4.2
080   */
081  @CheckForNull
082  Integer offsetValue();
083
084  /**
085   * @since 4.2
086   */
087  @CheckForNull
088  WorkDuration.UNIT offsetUnit();
089
090  boolean isRoot();
091
092  boolean isRequirement();
093
094}