View Javadoc

1   /*
2   * Copyright 2005 Arnaud Prost
3   * 
4   * Arnaud.prost@gmail.com
5   * 
6   * This software is a computer program whose purpose is to ease the 
7   * management of software project.
8   * 
9   * This software is governed by the CeCILL  license under French law and
10  * abiding by the rules of distribution of free software.  You can  use, 
11  * modify and/ or redistribute the software under the terms of the CeCILL
12  * license as circulated by CEA, CNRS and INRIA at the following URL
13  * "http://www.cecill.info". 
14  * 
15  * As a counterpart to the access to the source code and  rights to copy,
16  * modify and redistribute granted by the license, users are provided only
17  * with a limited warranty  and the software's author,  the holder of the
18  * economic rights,  and the successive licensors  have only  limited
19  * liability. 
20  * 
21  * In this respect, the user's attention is drawn to the risks associated
22  * with loading,  using,  modifying and/or developing or reproducing the
23  * software by the user in light of its specific status of free software,
24  * that may mean  that it is complicated to manipulate,  and  that  also
25  * therefore means  that it is reserved for developers  and  experienced
26  * professionals having in-depth computer knowledge. Users are therefore
27  * encouraged to load and test the software's suitability as regards their
28  * requirements in conditions enabling the security of their systems and/or 
29  * data to be ensured and,  more generally, to use and operate it in the 
30  * same conditions as regards security. 
31  * 
32  * The fact that you are presently reading this means that you have had
33  * knowledge of the CeCILL license and that you accept its terms.
34  */
35  package net.sf.pmr.agilePlanning.service;
36  
37  import java.util.Set;
38  
39  import net.sf.pmr.agilePlanning.domain.story.Story;
40  import net.sf.pmr.agilePlanning.domain.story.task.Task;
41  import net.sf.pmr.keopsframework.domain.validation.Errors;
42  
43  /***
44   * @author Arnaud Prost (arnaud.prost@gmail.com)
45   */
46  public interface StoryService {
47  
48      /***
49       * find stories for a projet (using his persistanceId)
50       * @param projectPersistanceId ProjectPersistanceId
51       * @return Iteration
52       */
53      Set findByProjectPersistanceId(final int projectPersistanceId);
54  
55      /***
56       * find story by its persistance Id
57       * @param persistanceId persistanceId
58       * @return Story
59       */
60      Story findByPersistanceId(final int persistanceId);
61  
62      /***
63       * Add a story
64       * @param agileProjectPersistanceId id of the agileProject
65       * @param shortDescription short description of the story
66       * @param description description of the story
67       * @param estimate first estimate
68       * @param iterationPersistanceId persistance id of the iteration
69       * @return errors errors
70       */
71      Errors add(final int agileProjectPersistanceId, final String shortDescription, final String description, final int estimate, final int iterationPersistanceId);
72  
73      /***
74       * Update a story
75       * @param agileProjectPersistanceId id of the agileProject
76       * @param shortDescription short description of the story
77       * @param description description of the story
78       * @param estimate first estimate
79       * @param iterationPersistanceId persistance id of the iteration
80       * @param persistanceId of the story
81       * @param persistanceVersion persistance version
82       * @return errors errors
83       */
84      Errors update(final int agileProjectPersistanceId, final String shortDescription, final String description, final int estimate,
85              final int iterationPersistanceId, final int persistanceId, final long persistanceVersion);
86  
87  //    /***
88  //     * Delete a story
89  //     * @param persistanceId of the story
90  //     * @param persistanceVersion persistance version
91  //     * @return errors errors
92  //     */
93  //    Errors delete(final int persistanceId, final long persistanceVersion);
94  
95      /***
96       * find task by its persistance Id
97       * @param persistanceId persistanceId
98       * @return Task
99       */
100     Task findTaskByPersistanceId(final int persistanceId);
101 
102     /***
103      * Add a task
104      * @param storyPersistanceId id of the story
105      * @param persistanceId of the task (0 if the task is new)
106      * @param numberOfIdealDays of the task
107      * @param shortDescription short description of the task
108      * @param devopperPersistanceId for the task
109      * @return errors errors
110      */
111     Errors addTask(final int storyPersistanceId, final int numberOfIdealDays, final String shortDescription, final int devopperPersistanceId);
112 
113     /***
114      * Update a task
115      * @param storyPersistanceId id of the story
116      * @param numberOfIdealDays of the task
117      * @param shortDescription short description of the task
118      * @param developperPersistanceId for the task
119      * @param persistanceId of the task
120      * @param persistanceVersion persistance version
121      * @return errors errors
122      */
123     Errors updateTask(final int storyPersistanceId, final int numberOfIdealDays, final String shortDescription, final int developperPersistanceId,
124             final int persistanceId, final long persistanceVersion);
125 
126 }