IMissionTripService.java

/*
     fEMR - fast Electronic Medical Records
     Copyright (C) 2014  Team fEMR

     fEMR 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 3 of the License, or
     (at your option) any later version.

     fEMR 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 fEMR.  If not, see <http://www.gnu.org/licenses/>. If
     you have any questions, contact <info@teamfemr.org>.
*/
package femr.business.services.core;

import femr.common.dtos.ServiceResponse;
import femr.common.models.*;
import femr.data.models.core.IMissionTrip;

import java.util.List;
import java.util.Optional;

public interface IMissionTripService {

    /**
     * Adds a list of users to a trip.
     *
     * @param tripId id of the trip to add users to, not null
     * @param userIds list of user ids being added to the trip, not null
     * @return the current trip or null if an error occurs
     */
    ServiceResponse<MissionTripItem> addUsersToTrip(int tripId, List<Integer> userIds);

    /**
     * Removes a list of users from a trip.
     *
     * @param tripId id of the trip to remove users from, not null
     * @param userIds list of user ids being removed from the trip, not null
     * @return the current trip or null if an error occurs
     */
    ServiceResponse<MissionTripItem> removeUsersFromTrip(int tripId, List<Integer> userIds);

    /**
     * Retrieve the current trip information. If you are calling this, consider the fact that you
     * can access the ID of the current trip through the CurrentUser you get out of a session.
     *
     * @return the current trip or null if an error occurs
     */
    Optional<IMissionTrip> retrieveCurrentMissionTripForUser(int userId);

    /**
     * Retrieve a list of all cities.
     *
     * @return a service response that contains a list of available cities as CityItems
     * and/or errors if they exist.
     */
    ServiceResponse<List<CityItem>> retrieveAvailableCities();

    /**
     * Retrieve a list of all countries.
     *
     * @return a service response that contains a list of available countries as Strings
     * and/or errors if they exist.
     */
    ServiceResponse<List<String>> retrieveAvailableCountries();

    /**
     * Get a comprehensive list of trip information
     *
     * @return a service response that contains a list of trip information
     * and/or errors if they exist.
     */
    ServiceResponse<List<MissionItem>> retrieveAllTripInformation();

    /**
     * Get a comprehensive list of trip information for a specific trip
     *
     * @param tripId id of the trip, not null
     * @return a service responset hat contains a list of trip information
     * and/or errors if they exist.
     */
    ServiceResponse<MissionTripItem> retrieveAllTripInformationByTripId(int tripId);

    /**
     * Get a comprehensive list of trip information for a specific user.(all trips that
     * the user has attended).
     *
     * @param userId id of the user, not null
     * @return a service responset hat contains a list of trip information for
     * the user and/or errors if they exist.
     */
    ServiceResponse<List<MissionTripItem>> retrieveAllTripInformationByUserId(int userId);

    /**
     * Create a new team.
     *
     * @param teamItem - the name is required TODO: separate into parameters
     * @return a service response that contains a new TeamItem that was created
     * and/or errors if they exist.
     */
    ServiceResponse<TeamItem> createNewTeam(TeamItem teamItem);

    /**
     * Create a new trip
     *
     * @param tripItem everything except end date required TODO: separate into parameters
     * @return a service response that contains a new TripItem that was created
     * and/or errors if they exist.
     */
    ServiceResponse<TripItem> createNewTrip(TripItem tripItem);

    /**
     * Create a new city
     *
     * @param cityName name of the city, not null
     * @param countryName name of the country, not null
     * @return a service response that contains a new CityItem that was created
     * and/or errors if they exist.
     */
    ServiceResponse<CityItem> createNewCity(String cityName, String countryName);
}