Package: Actions

Actions

name	instruction	branch	complexity	line	method
static {...}	M: 54 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 6 C: 0 0%	M: 1 C: 0 0%

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.domain;
14:
15: import org.eclipse.kapua.service.KapuaEntityService;
16: import org.eclipse.kapua.service.KapuaNamedEntityService;
17: import org.eclipse.kapua.service.KapuaUpdatableEntityService;
18:
19: /**
20: * {@link Actions} implementation {@code enum}.<br>
21: * Available actions defined are:
22: * <ul>
23: * <li>{@link Actions#read}: Represent any type of fetching data from the system.</li>
24: * <li>{@link Actions#write}: Represent any type of writing data into the system.</li>
25: * <li>{@link Actions#delete}: Represent any type of deleting data from the system.</li>
26: * <li>{@link Actions#connect}: Represent any type of connect to resources of the system.</li>
27: * <li>{@link Actions#execute}: Represent any type of execution of task in the system.</li>
28: * </ul>
29: *
30: * @since 1.0.0
31: */
32: public enum Actions {
33: /**
34: * Represent any type of fetching data from the system. <br>
35: * Common usage is on:
36: * <ul>
37: * <li>{@link KapuaEntityService#find(org.eclipse.kapua.model.id.KapuaId, org.eclipse.kapua.model.id.KapuaId)}</li>
38: * <li>{@link KapuaEntityService#query(org.eclipse.kapua.model.query.KapuaQuery)}</li>
39: * <li>{@link KapuaEntityService#count(org.eclipse.kapua.model.query.KapuaQuery)}</li>
40: * <li>{@link KapuaNamedEntityService#findByName(String)}</li>
41: * </ul>
42: *
43: * @since 1.0.0
44: */
45: read,
46:
47: /**
48: * Represent any type of writing data into the system.
49: * Common usage is on:
50: * <ul>
51: * <li>{@link KapuaEntityService#create(org.eclipse.kapua.model.KapuaEntityCreator)}</li>
52: * <li>{@link KapuaUpdatableEntityService#update(org.eclipse.kapua.model.KapuaEntity)}</li>
53: * </ul>
54: *
55: * @since 1.0.0
56: */
57: write,
58:
59: /**
60: * Represent any type of deleting data from the system. <br>
61: * Common usage is on:
62: * <ul>
63: * <li>{@link KapuaEntityService#delete(org.eclipse.kapua.model.id.KapuaId, org.eclipse.kapua.model.id.KapuaId)}</li>
64: * </ul>
65: *
66: * @since 1.0.0
67: */
68: delete,
69:
70: /**
71: * Represent any type of connect to resources of the system.<br>
72: * Examples are:
73: * <ul>
74: * <li>Connecting to the message broker.</li>
75: * </ul>
76: *
77: * @since 1.0.0
78: */
79: connect,
80:
81: /**
82: * Represent any type of execution of task in the system.
83: *
84: * @since 1.0.0
85: */
86: execute,;
87: }