public interface ProgressAssistant
Modifier and Type | Method and Description |
---|---|
String |
getPostUpgradeProgress()
Gets a characterization of the upgrade action's progress within the
post-upgrade phase.
|
String |
getPreUpgradeProgress()
Gets a characterization of the upgrade action's progress within the
pre-upgrade phase.
|
Date |
getProgressLastModified()
Gets the time the progress of the upgrade action was last updated.
|
Integer |
getProgressPercentage()
Gets an estimate of the upgrade action's progress in the current upgrade
phase, as an integer percentage.
|
String |
getUpgradeProgress()
Gets a characterization of the upgrade action's progress within the
upgrade phase.
|
void |
setPostUpgradeProgress(String progress)
Sets a characterization of the upgrade action's progress within the
post-upgrade phase.
|
void |
setPreUpgradeProgress(String progress)
Sets a characterization of the upgrade action's progress within the
pre-upgrade phase.
|
void |
setProgressPercentage(Integer progressPercentage)
Sets an estimate of the upgrade action's progress in the current upgrade
phase, as an integer percentage.
|
void |
setUpgradeProgress(String progress)
Sets a characterization of the upgrade action's progress within the
upgrade phase.
|
void setPreUpgradeProgress(String progress) throws IfsException
The specified value is action-specific, for example
"2983 of 2983 rows pre-upgraded
" if the
pre-upgrade phase were complete.
progress
- the pre-upgrade progress, or null if unknownIfsException
- if the operation failsString getPreUpgradeProgress() throws IfsException
IfsException
- if the operation failsvoid setUpgradeProgress(String progress) throws IfsException
The specified value is action-specific, for example
"321 of 2983 rows upgraded
" if the
upgrade phase were underway.
progress
- the upgrade progress, or null if unknownIfsException
- if the operation failsString getUpgradeProgress() throws IfsException
IfsException
- if the operation failsvoid setPostUpgradeProgress(String progress) throws IfsException
The specified value is action-specific, for example
"0 of 2983 rows post-upgraded
" if the
post-upgrade phase were not yet started.
progress
- the post-upgrade progress, or null if unknownIfsException
- if the operation failsString getPostUpgradeProgress() throws IfsException
IfsException
- if the operation failsvoid setProgressPercentage(Integer progressPercentage) throws IfsException
progressPercentage
- within the current upgrade phase, the upgrade
action's percent complete, or null if unknownIfsException
- if the operation failsInteger getProgressPercentage() throws IfsException
IfsException
- if the operation failsDate getProgressLastModified() throws IfsException
IfsException
- if the operation failsCopyright © 2023. All rights reserved.