ProjectAssignmentService.java

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package net.rrm.ehour.project.service;

import net.rrm.ehour.data.DateRange;
import net.rrm.ehour.domain.Project;
import net.rrm.ehour.domain.ProjectAssignment;
import net.rrm.ehour.domain.ProjectAssignmentType;
import net.rrm.ehour.domain.User;
import net.rrm.ehour.exception.ObjectNotFoundException;

import java.util.List;

/**
 * Service for handling project assignments
 */

public interface ProjectAssignmentService {
    /**
     * Get active projects for user in date range
     *
     * @param userId
     * @param dateRange
     * @return
     */
    List<ProjectAssignment> getProjectAssignmentsForUser(Integer userId, DateRange dateRange);

    /**
     * Get projects for user
     *
     * @param user
     * @return
     */
    List<ProjectAssignment> getProjectAssignmentsForUser(User user);

    /**
     * Get project assignment and mark it as deletable or not
     *
     * @param assignmentId
     * @return
     */
    ProjectAssignment getProjectAssignment(Integer assignmentId) throws ObjectNotFoundException;

    /**
     * Get project assignments for project
     *
     * @param project
     */
    List<ProjectAssignment> getProjectAssignments(Project project, DateRange dateRange);

    /**
     * Get all project assignments for project
     *
     * @param project
     * @return
     */
    List<ProjectAssignment> getProjectAssignmentsAndCheckDeletability(Project project);

    /**
     * Get available project assignment types
     *
     * @return
     */
    List<ProjectAssignmentType> getProjectAssignmentTypes();
}