From 94d89fc22606bbb3cecbf4b64bba6cffa94e1076 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=93scar=20Gonz=C3=A1lez=20Fern=C3=A1ndez?=
 <ogonzalez@igalia.com>
Date: Tue, 8 Feb 2011 17:20:02 +0100
Subject: [PATCH] Add documentation for method

FEA: ItEr70S04BugFixing
---
 .../planner/entities/IAllocatable.java        | 20 ++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/IAllocatable.java b/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/IAllocatable.java
index 5c39b3628..ec363ece1 100644
--- a/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/IAllocatable.java
+++ b/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/IAllocatable.java
@@ -33,7 +33,25 @@ public interface IAllocatable extends IAllocateResourcesPerDay {
 
     public IAllocateResourcesPerDay resourcesPerDayFromEndUntil(LocalDate start);
 
-    public IAllocateHoursOnInterval onInterval(LocalDate start, LocalDate end);
+    /**
+     * <p>
+     * It does the allocation in the intersection of the underlying task's
+     * bounds and the interval specified. This ensures it can't modify the start
+     * and end of the task. The start and end of the allocation can grow, but
+     * they can't be shrunk.
+     * </p>
+     * <p>
+     * Putting it in another way: This method can't be used to expand an
+     * allocation beyond the task's bounds.
+     * </p>
+     *
+     * @param startInclusive
+     * @param endExclusive
+     * @return an object which can be used to allocate hours on the interval
+     *         specified
+     */
+    public IAllocateHoursOnInterval onInterval(LocalDate startInclusive,
+            LocalDate endExclusive);
 
     public IAllocateHoursOnInterval fromStartUntil(LocalDate endExclusive);