Package: KapuaNamedEntityCreator

KapuaNamedEntityCreator

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 KapuaNamedEntityCreator} definition.
20: * <p>
21: * The {@link KapuaNamedEntityCreator} adds on top of the {@link KapuaUpdatableEntityCreator} the following properties:
22: * <ul>
23: * <li>name</li>
24: * <li>description</li>
25: * </ul>
26: *
27: * <div>
28: *
29: * <p>
30: * <b>Name</b>
31: * </p>
32: * <p>
33: * The <i>Name</i> property is the unique name of the {@link KapuaEntity} in the scope.
34: * </p>
35: *
36: * <p>
37: * <b>Description</b>
38: * </p>
39: * <p>
40: * The <i>Description</i> property is the optional description of the {@link KapuaEntity}.
41: * </p>
42: * </div>
43: *
44: * @param <E> {@link KapuaEntity} which this {@link KapuaEntityCreator} is for
45: * @since 1.0.0
46: */
47: @XmlType(propOrder = {"name", "description"})
48: public interface KapuaNamedEntityCreator<E extends KapuaEntity> extends KapuaUpdatableEntityCreator<E> {
49:
50: /**
51: * Gets the name
52: *
53: * @return the name
54: * @since 1.0.0
55: */
56: @XmlElement(name = "name")
57: String getName();
58:
59: /**
60: * Sets the name
61: *
62: * @param name the name
63: * @since 1.0.0
64: */
65: void setName(String name);
66:
67: /**
68: * Gets the description
69: *
70: * @return the description
71: * @since 1.0.0
72: */
73: String getDescription();
74:
75: /**
76: * Sets the description
77: *
78: * @param description the description
79: * @since 1.0.0
80: */
81: void setDescription(String description);
82: }