/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.activiti.rest.service.api.runtime.task;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import io.swagger.annotations.*;
import org.activiti.rest.common.api.DataResponse;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Frederik Heremans
 */
@RestController
@Api(tags = { "Tasks" }, description = "Manage Tasks")
public class TaskQueryResource extends TaskBaseResource {

  @ApiOperation(value = "Query for tasks", tags = {"Tasks"},
          notes ="All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVariables are both JSON-arrays containing objects with the format as described here.")
  @ApiResponses(value = {
          @ApiResponse(code = 200, message =  "Indicates request was successful and the tasks are returned."),
          @ApiResponse(code = 400, message = "Indicates a parameter was passed in the wrong format or that delegationState has an invalid value (other than pending and resolved). The status-message contains additional information.")
  })
  @RequestMapping(value = "/query/tasks", method = RequestMethod.POST, produces = "application/json")
  public DataResponse getQueryResult(@RequestBody TaskQueryRequest request, @ApiParam(hidden = true)@RequestParam Map<String, String> requestParams, HttpServletRequest httpRequest) {

    return getTasksFromQueryRequest(request, requestParams);
  }
}
