Package: KapuaNamedEntity

KapuaNamedEntity

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2016, 2022 Eurotech and/or its affiliates and others
3: *
4: * This program and the accompanying materials are made
5: * available under the terms of the Eclipse Public License 2.0
6: * which is available at https://www.eclipse.org/legal/epl-2.0/
7: *
8: * SPDX-License-Identifier: EPL-2.0
9: *
10: * Contributors:
11: * Eurotech - initial API and implementation
12: *******************************************************************************/
13: package org.eclipse.kapua.model;
14:
15: import javax.xml.bind.annotation.XmlElement;
16: import javax.xml.bind.annotation.XmlType;
17:
18: /**
19: * {@link KapuaNamedEntity} definition.
20: * <p>
21: * The {@link KapuaNamedEntity} adds on top of the {@link KapuaUpdatableEntity} the following properties:
22: *
23: * <ul>
24: * <li>name</li>
25: * <li>description</li>
26: * </ul>
27: *
28: * <div>
29: *
30: * <p>
31: * <b>Name</b>
32: * </p>
33: * <p>
34: * The <i>Name</i> property is the unique name of the {@link KapuaEntity} in the scope.
35: * </p>
36: *
37: * <p>
38: * <b>Description</b>
39: * </p>
40: * <p>
41: * The <i>Description</i> property is the optional description of the {@link KapuaEntity}.
42: * </p>
43: * </div>
44: *
45: * @since 1.0.0
46: */
47: @XmlType(propOrder = {"name", "description"})
48: public interface KapuaNamedEntity extends KapuaUpdatableEntity {
49:
50: /**
51: * Gets the name of the {@link KapuaEntity}
52: *
53: * @return the name of the {@link KapuaEntity}
54: * @since 1.0.0
55: */
56: @XmlElement(name = "name")
57: String getName();
58:
59: /**
60: * Sets the name of the {@link KapuaEntity}
61: *
62: * @param name the name of the {@link KapuaEntity}
63: * @since 1.0.0
64: */
65: void setName(String name);
66:
67: /**
68: * Gets the description for the {@link KapuaEntity}
69: *
70: * @return the description of this {@link KapuaEntity}
71: * @since 1.1.0
72: */
73: String getDescription();
74:
75: /**
76: * Sets the description for the {@link KapuaEntity}
77: *
78: * @param description the description for the {@link KapuaEntity}
79: * @since 1.1.0
80: */
81: void setDescription(String description);
82: }