1 /*
2 * Copyright (c) 2022-2023. Roland T. Lichti, Kaiserpfalz EDV-Service.
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18 package de.kaiserpfalzedv.commons.api.resources;
19
20 import org.eclipse.microprofile.openapi.annotations.media.Schema;
21
22 import jakarta.validation.constraints.Pattern;
23 import jakarta.validation.constraints.Size;
24
25 /**
26 * HasKind -- The object has a kind.
27 *
28 * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
29 * @version 2.1.0 2022-01-16
30 * @since 2.0.2 2022-01-16
31 */
32 public interface HasKind {
33 @Schema(
34 name = "kind",
35 description = "The kind of a resource.",
36 example = HasName.VALID_NAME_EXAMPLE,
37 pattern = HasName.VALID_NAME_PATTERN,
38 minLength = HasName.VALID_NAME_MIN_LENGTH,
39 maxLength = HasName.VALID_NAME_MAX_LENGTH
40 )
41 @Size(min = HasName.VALID_NAME_MIN_LENGTH, max = HasName.VALID_NAME_MAX_LENGTH, message = HasName.VALID_NAME_LENGTH_MSG)
42 @Pattern(regexp = HasName.VALID_NAME_PATTERN, message = HasName.VALID_NAME_PATTERN_MSG)
43 String getKind();
44 }