Package: JobDeviceManagementOperationCreator

JobDeviceManagementOperationCreator

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2019, 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.job;
14:
15: import org.eclipse.kapua.model.KapuaEntityCreator;
16: import org.eclipse.kapua.model.id.KapuaId;
17:
18: import javax.xml.bind.annotation.XmlAccessType;
19: import javax.xml.bind.annotation.XmlAccessorType;
20: import javax.xml.bind.annotation.XmlRootElement;
21: import javax.xml.bind.annotation.XmlType;
22:
23: /**
24: * {@link JobDeviceManagementOperationCreator} encapsulates all the information needed to create a new {@link JobDeviceManagementOperation} in the system.<br>
25: * The data provided will be used to seed the new {@link JobDeviceManagementOperation}.
26: *
27: * @since 1.1.0
28: */
29: @XmlRootElement(name = "jobDeviceManagementOperationCreator")
30: @XmlAccessorType(XmlAccessType.PROPERTY)
31: @XmlType(factoryClass = JobDeviceManagementOperationXmlRegistry.class, factoryMethod = "newJobDeviceManagementOperationCreator")
32: public interface JobDeviceManagementOperationCreator extends KapuaEntityCreator<JobDeviceManagementOperation> {
33:
34: /**
35: * Gets the {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
36: *
37: * @return The {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
38: * @since 1.1.0
39: */
40: KapuaId getJobId();
41:
42: /**
43: * Sets the {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
44: *
45: * @param jobId The {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
46: * @since 1.1.0
47: */
48: void setJobId(KapuaId jobId);
49:
50: /**
51: * Gets the {@link org.eclipse.kapua.service.device.management.registry.operation.DeviceManagementOperation} {@link KapuaId}.
52: *
53: * @return The {@link org.eclipse.kapua.service.device.management.registry.operation.DeviceManagementOperation} {@link KapuaId}.
54: * @since 1.1.0
55: */
56: KapuaId getDeviceManagementOperationId();
57:
58: /**
59: * Sets the {@link org.eclipse.kapua.service.device.management.registry.operation.DeviceManagementOperation} {@link KapuaId}.
60: *
61: * @param deviceManagementOperationId The {@link org.eclipse.kapua.service.device.management.registry.operation.DeviceManagementOperation} {@link KapuaId}.
62: * @since 1.1.0
63: */
64: void setDeviceManagementOperationId(KapuaId deviceManagementOperationId);
65: }