Package: KapuaNotifyPayload

KapuaNotifyPayload

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.service.device.management.message.notification;
14:
15: import org.eclipse.kapua.message.KapuaPayload;
16: import org.eclipse.kapua.model.id.KapuaId;
17:
18: /**
19: * Notify {@link KapuaPayload} definition.
20: *
21: * @since 1.0.0
22: */
23: public interface KapuaNotifyPayload extends KapuaPayload {
24:
25: /**
26: * Gets the operation {@link KapuaId}.
27: *
28: * @return The operation {@link KapuaId}.
29: * @since 1.0.0
30: */
31: KapuaId getOperationId();
32:
33: /**
34: * Sets the operation {@link KapuaId}.
35: *
36: * @param operationId The operation {@link KapuaId}.
37: * @since 1.0.0
38: */
39: void setOperationId(KapuaId operationId);
40:
41: /**
42: * Gets the resource.
43: *
44: * @return The resource.
45: * @since 1.0.0
46: * @deprecated Since 1.2.0. Please make use of {@link KapuaNotifyChannel#getResources()}
47: */
48: @Deprecated
49: String getResource();
50:
51: /**
52: * Sets the resource.
53: *
54: * @param resource The resource.
55: * @since 1.0.0
56: * @deprecated Since 1.2.0. Please make use of {@link KapuaNotifyChannel#setResources(String[])}
57: */
58: @Deprecated
59: void setResource(String resource);
60:
61: /**
62: * Gets the {@link NotifyStatus}.
63: *
64: * @return The {@link NotifyStatus}.
65: * @since 1.0.0
66: */
67: NotifyStatus getStatus();
68:
69: /**
70: * Sets the {@link NotifyStatus}.
71: *
72: * @param status The {@link NotifyStatus}.
73: * @since 1.0.0
74: */
75: void setStatus(NotifyStatus status);
76:
77: /**
78: * Gets the operation progress.
79: *
80: * @return The operation progress.
81: * @since 1.0.0
82: */
83: Integer getProgress();
84:
85: /**
86: * Sets the operation progress.
87: *
88: * @param progress The operation progress.
89: * @since 1.0.0
90: */
91: void setProgress(Integer progress);
92:
93: /**
94: * Gets the message.
95: *
96: * @return The message.
97: * @since 1.2.0
98: */
99: String getMessage();
100:
101: /**
102: * Gets the message.
103: *
104: * @param message The message.
105: * @since 1.2.0
106: */
107: void setMessage(String message);
108: }