Package: QueuedJobExecutionCreator

QueuedJobExecutionCreator

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.job.engine.queue;
14:
15: import org.eclipse.kapua.model.KapuaUpdatableEntityCreator;
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 QueuedJobExecutionCreator} definition.
25: *
26: * @since 1.1.0
27: */
28: @XmlRootElement(name = "queuedJobExecutionCreator")
29: @XmlAccessorType(XmlAccessType.PROPERTY)
30: @XmlType(factoryClass = QueuedJobExecutionXmlRegistry.class, factoryMethod = "newQueuedJobExecutionCreator")
31: public interface QueuedJobExecutionCreator extends KapuaUpdatableEntityCreator<QueuedJobExecution> {
32:
33: /**
34: * Gets the {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
35: *
36: * @return The {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
37: * @since 1.1.0
38: */
39: KapuaId getJobId();
40:
41: /**
42: * Sets the {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
43: *
44: * @param jobId The {@link org.eclipse.kapua.service.job.Job} {@link KapuaId}.
45: * @since 1.1.0
46: */
47: void setJobId(KapuaId jobId);
48:
49: /**
50: * Gets the {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId}.
51: *
52: * @return The {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId}.
53: * @since 1.1.0
54: */
55: KapuaId getJobExecutionId();
56:
57: /**
58: * Sets the {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId}.
59: *
60: * @param jobExecutionId The {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId}.
61: * @since 1.1.0
62: */
63: void setJobExecutionId(KapuaId jobExecutionId);
64:
65: /**
66: * Gets the {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId} that needs to complete.
67: *
68: * @return The {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId} that needs to complete.
69: * @since 1.1.0
70: */
71: KapuaId getWaitForJobExecutionId();
72:
73: /**
74: * Sets the {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId} that needs to complete.
75: *
76: * @param waitForJobExecutionId The {@link org.eclipse.kapua.service.job.execution.JobExecution} {@link KapuaId} that needs to complete.
77: * @since 1.1.0
78: */
79: void setWaitForJobExecutionId(KapuaId waitForJobExecutionId);
80:
81: /**
82: * Gets the {@link QueuedJobExecutionStatus}.
83: *
84: * @return The {@link QueuedJobExecutionStatus}.
85: * @since 1.1.0
86: */
87: QueuedJobExecutionStatus getStatus();
88:
89: /**
90: * Sets the {@link QueuedJobExecutionStatus}.
91: *
92: * @param status The {@link QueuedJobExecutionStatus}.
93: * @since 1.1.0
94: */
95: void setStatus(QueuedJobExecutionStatus status);
96: }