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 java.io.Serializable;
21 import java.time.OffsetDateTime;
22
23 import org.eclipse.microprofile.openapi.annotations.media.Schema;
24
25 /**
26 * HasRevision --
27 *
28 * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
29 * @version 4.0.0 2024-09-22
30 * @since 2.0.0 2023-01-06
31 *
32 * @param T The type of Id of this resource (I normally use UUID).
33 */
34 @Schema(description = "If something has a revision.")
35 public interface HasRevision<T extends Serializable> extends HasId<T> {
36 /**
37 * @return The date of the last version. It is literally the {@link #getModified()}.
38 * @deprecated Will be removed with version 5.0.0 of this library.
39 */
40 // TODO 2024-09-27 klenkes74 Remove with 5.0.0
41 @SuppressWarnings({"java:S1133","java:S1135"})
42 @Schema(description = "The date and time of the current revision.")
43 @Deprecated
44 default OffsetDateTime getRevisioned() {
45 return getModified();
46 }
47
48 @Schema(description = "The version of this resource.")
49 Integer getVersion();
50
51 @Schema(description = "The creation date of this resource.")
52 OffsetDateTime getCreated();
53
54 @Schema(description = "The date of the last modification to this resource.")
55 OffsetDateTime getModified();
56 }