/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.sandbox.agile;
  
  import de.smartics.properties.api.core.annotations.AccessType;
  import de.smartics.properties.api.core.annotations.PropertyExpression;
  import de.smartics.properties.api.core.annotations.PropertyIntValueRange;
  import de.smartics.properties.api.core.annotations.PropertyKeyName;
  import de.smartics.properties.api.core.annotations.PropertyLifecycle;
  import de.smartics.properties.api.core.annotations.PropertySet;
  import de.smartics.properties.api.core.annotations.PropertyLifecycle.UpdateInterval;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  
  /**
   * The example features an artificial enumeration of properties of a user story.
   * <p>
   * Just a paragraph to test.
   * </p>
   */
  @PropertySet("agile")
  public interface UserStoryProperties
  {
    /**
     * The name of a user story.
     *
     * @return the property value.
     */
    @PropertyLifecycle(access = AccessType.READ_WRITE,
        updateInterval = UpdateInterval.NO_CACHING)
    String name();
  
    /**
     * The descriptor of the name property.
     *
     * @return descriptor of the name property.
     */
    PropertyDescriptor namePropertyDescriptor();
  
    /**
     * The story point stating the estimated work to implement the story.
     *
     * @return the property value.
     */
    @PropertyKeyName("story-points")
    @PropertyExpression("8")
    // CHECKSTYLE:OFF
    @PropertyIntValueRange({ 0, 1, 2, 3, 5, 8, 13, 21, 50, 100 })
    // CHECKSTYLE:ON
    @PropertyLifecycle(access = AccessType.READ_WRITE,
        updateInterval = UpdateInterval.NO_CACHING)
    int storyPoint();
  
    /**
     * The descriptor of the story point property.
     *
     * @return descriptor of the story point property.
     */
    PropertyDescriptor storyPointPropertyDescriptor();
  
    /**
     * The business priority of the user story.
     *
     * @return the property value.
     */
    @PropertyKeyName("business-priority")
    @PropertyExpression("required")
    @PropertyLifecycle(access = AccessType.READ_WRITE,
        updateInterval = UpdateInterval.NO_CACHING)
    Priority businessPriority();
  
    /**
     * The descriptor of the business priority property.
     *
     * @return descriptor of the business priority property.
     */
    PropertyDescriptor businessPriorityPropertyDescriptor();
  }