SkillService.java

package com.ciandt.techgallery.service;

import com.google.api.server.spi.response.BadRequestException;
import com.google.api.server.spi.response.InternalServerErrorException;
import com.google.api.server.spi.response.NotFoundException;
import com.google.appengine.api.oauth.OAuthRequestException;
import com.google.appengine.api.users.User;

import com.ciandt.techgallery.persistence.model.Skill;
import com.ciandt.techgallery.persistence.model.TechGalleryUser;
import com.ciandt.techgallery.persistence.model.Technology;
import com.ciandt.techgallery.service.model.UserSkillTO;

import java.util.List;

/**
 * Services for Skills.
 * 
 * @author Felipe Goncalves de Castro
 *
 */
public interface SkillService {

  /**
   * Service for adding a technology.
   * 
   * @param skill json with skill info.
   * @return skill info or message error.
   * @throws InternalServerErrorException in case something goes wrong
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  Skill addOrUpdateSkill(Skill skill, User user)
      throws InternalServerErrorException, BadRequestException, NotFoundException;

  void deleteUserSkill(String techId, User user)
          throws InternalServerErrorException, BadRequestException, NotFoundException, OAuthRequestException;

  /**
   * Service for getting an user skill.
   * 
   * @param techId technology id.
   * @param user oauth user.
   * @return skill info or message error.
   * @throws InternalServerErrorException in case something goes wrong
   * @throws OAuthRequestException in case of authentication problem
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  Skill getUserSkill(String techId, User user) throws BadRequestException, OAuthRequestException,
      NotFoundException, InternalServerErrorException;

  /**
   * Service for getting a TechGalleyUser skill.
   * 
   * @param techId technology id.
   * @param user datastore user.
   * @return skill info or message error.
   * @throws InternalServerErrorException in case something goes wrong
   * @throws OAuthRequestException in case of authentication problem
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  Skill getUserSkill(String techId, TechGalleryUser user) throws BadRequestException,
      OAuthRequestException, NotFoundException, InternalServerErrorException;

  /**
   * Service for import user´s skills from sheet.
   * 
   * @param userSkills Transient object with user email and array of skills for each technology.
   * @param user oauth user.
   * @return String with error or success message.
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   * @throws InternalServerErrorException in case something goes wrong
   */
  String importUserSkill(UserSkillTO userSkills, User user)
      throws NotFoundException, InternalServerErrorException, BadRequestException;

  /**
   * Service for getting all skills informed for a technology.
   * 
   * @param technology Technology Entity.
   * @return List of all skills of the informed technology.
   * @throws BadRequestException in case a request with problem were made.
   */
  List<Skill> getSkillsByTech(Technology technology) throws BadRequestException;
}