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 import static de.kaiserpfalzedv.commons.api.resources.HasName.*;
26
27 /**
28 * HasNameSpace -- The object has a name space.
29 *
30 * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
31 * @version 2.0.2 2022-01-16
32 * @since 2.0.2 2022-01-16
33 */
34 public interface HasNameSpace {
35 @Schema(
36 name = "nameSpace",
37 description = "The name space of a resource.",
38 pattern = VALID_NAME_PATTERN,
39 minLength = VALID_NAME_MIN_LENGTH,
40 maxLength = VALID_NAME_MAX_LENGTH,
41 example = VALID_NAME_EXAMPLE
42 )
43 @Size(min = VALID_NAME_MIN_LENGTH, max = VALID_NAME_MAX_LENGTH, message = VALID_NAME_LENGTH_MSG)
44 @Pattern(regexp = VALID_NAME_PATTERN, message = VALID_NAME_PATTERN_MSG)
45 String getNameSpace();
46 }