MethodController.java

/*
 * Copyright 2020 Global Crop Diversity Trust
 *
 * 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.gringlobal.api.v1.impl;

import com.querydsl.core.types.OrderSpecifier;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v1.FilteredCRUDController;
import org.gringlobal.api.v1.FilteredPage;
import org.gringlobal.api.v1.Pagination;
import org.gringlobal.custom.elasticsearch.SearchException;
import org.gringlobal.model.Method;
import org.gringlobal.model.QMethod;
import org.gringlobal.service.MethodService;
import org.gringlobal.service.filter.MethodFilter;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;

/**
 * @author Maxym Borodenko
 */
@RestController("methodApi1")
@RequestMapping(MethodController.API_URL)
@PreAuthorize("isAuthenticated()")
@Tag(name = "Method")
public class MethodController extends FilteredCRUDController<Method, MethodService, MethodFilter> {

	/** The Constant API_URL. */
	public static final String API_URL = ApiBaseController.APIv1_BASE + "/method";

	@Override
	protected OrderSpecifier<?>[] defaultSort() {
		return new OrderSpecifier[] { QMethod.method.id.asc() };
	}

	@Override
	protected Class<MethodFilter> filterType() {
		return MethodFilter.class;
	}

	@Override
	@Operation(operationId = "createMethod", description = "Create a Method", summary = "Add")
	public Method create(@RequestBody Method entity) {
		return super.create(entity);
	}

	@Override
	@Operation(operationId = "updateMethod", description = "Update a Method", summary = "Update")
	public Method update(@RequestBody Method entity) {
		return super.update(entity);
	}

	@Override
	@Operation(operationId = "listMethods", description = "List Methods", summary = "List")
	public FilteredPage<Method, MethodFilter> list(@Parameter(hidden = true) final Pagination page, @RequestBody(required = false) final MethodFilter filter) throws SearchException, IOException {
		return super.list(page, filter);
	}

	@Override
	@Operation(operationId = "filterMethods", description = "Filter Methods", summary = "Filter")
	public FilteredPage<Method, MethodFilter> filter(@RequestParam(name = "f", required = false) final String filterCode, @Parameter(hidden = true) final Pagination page,
			@RequestBody(required = false) final MethodFilter filter) throws IOException, SearchException {
		return super.filter(filterCode, page, filter);
	}
}