1 /*
2 * Tethys: GUI Utilities
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.tethys.api.thread;
18
19 /**
20 * Thread Status.
21 */
22 public interface TethysUIThreadStatus {
23 /**
24 * Get step.
25 *
26 * @return the step name
27 */
28 String getStep();
29
30 /**
31 * Get number of steps.
32 *
33 * @return number of steps
34 */
35 int getNumSteps();
36
37 /**
38 * Get number of steps done.
39 *
40 * @return number of steps done
41 */
42 int getStepsDone();
43
44 /**
45 * Get stage progress done.
46 *
47 * @return stage progress
48 */
49 double getStageProgress();
50
51 /**
52 * Get number of stages.
53 *
54 * @return number of stages
55 */
56 int getNumStages();
57
58 /**
59 * Get number of stages done.
60 *
61 * @return number of stages done
62 */
63 int getStagesDone();
64
65 /**
66 * Get task progress done.
67 *
68 * @return task progress
69 */
70 double getTaskProgress();
71
72 /**
73 * Get name of stage.
74 *
75 * @return name of stage
76 */
77 String getStage();
78
79 /**
80 * Get name of task.
81 *
82 * @return name of task
83 */
84 String getTask();
85
86 /**
87 * Set Number of steps in this stage.
88 *
89 * @param pValue the value
90 */
91 void setNumSteps(int pValue);
92
93 /**
94 * Set Next step.
95 *
96 * @param pStep the next step
97 */
98 void setNextStep(String pStep);
99
100 /**
101 * Set StepsDone.
102 *
103 * @param pSteps the # of steps done
104 */
105 void setStepsDone(int pSteps);
106
107 /**
108 * Set Next step.
109 */
110 void setNextStep();
111
112 /**
113 * Set Number of stages in this task.
114 *
115 * @param pValue the value
116 */
117 void setNumStages(int pValue);
118
119 /**
120 * Set Number of stages completed in this task.
121 *
122 * @param pValue the value
123 */
124 void setStagesDone(int pValue);
125
126 /**
127 * Set name of stage in this task.
128 *
129 * @param pValue the value
130 */
131 void setStage(String pValue);
132
133 /**
134 * Set Name of task.
135 *
136 * @param pValue the value
137 */
138 void setTask(String pValue);
139
140 /**
141 * Set Completion.
142 */
143 void setCompletion();
144 }