oracle.ifs.admin.tools.upgrade

Interface ProgressAssistant

public interface ProgressAssistant

Allows an upgrade action to record its progress.

(Unpublished)

Method Summary

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.

Method Detail

setPreUpgradeProgress

void setPreUpgradeProgress(String progress)
                    throws IfsException

Sets a characterization of the upgrade action's progress within the pre-upgrade phase.

The specified value is action-specific, for example "2983 of 2983 rows pre-upgraded" if the pre-upgrade phase were complete.

Parameters:

progress - the pre-upgrade progress, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

getPreUpgradeProgress

String getPreUpgradeProgress()
                      throws IfsException

Gets a characterization of the upgrade action's progress within the pre-upgrade phase.

Returns:

the pre-upgrade progress, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

setUpgradeProgress

void setUpgradeProgress(String progress)
                 throws IfsException

Sets a characterization of the upgrade action's progress within the upgrade phase.

The specified value is action-specific, for example "321 of 2983 rows upgraded" if the upgrade phase were underway.

Parameters:

progress - the upgrade progress, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

getUpgradeProgress

String getUpgradeProgress()
                   throws IfsException

Gets a characterization of the upgrade action's progress within the upgrade phase.

Returns:

the upgrade progress

Throws:

IfsException - if the operation fails

(Unpublished)

setPostUpgradeProgress

void setPostUpgradeProgress(String progress)
                     throws IfsException

Sets a characterization of the upgrade action's progress within the post-upgrade phase.

The specified value is action-specific, for example "0 of 2983 rows post-upgraded" if the post-upgrade phase were not yet started.

Parameters:

progress - the post-upgrade progress, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

getPostUpgradeProgress

String getPostUpgradeProgress()
                       throws IfsException

Gets a characterization of the upgrade action's progress within the post-upgrade phase.

Returns:

the post-upgrade progress, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

setProgressPercentage

void setProgressPercentage(Integer progressPercentage)
                    throws IfsException

Sets an estimate of the upgrade action's progress in the current upgrade phase, as an integer percentage.

Parameters:

progressPercentage - within the current upgrade phase, the upgrade action's percent complete, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

getProgressPercentage

Integer getProgressPercentage()
                       throws IfsException

Gets an estimate of the upgrade action's progress in the current upgrade phase, as an integer percentage.

Returns:

within the current upgrade phase, the upgrade action's percent complete, or null if unknown

Throws:

IfsException - if the operation fails

(Unpublished)

getProgressLastModified

Date getProgressLastModified()
                      throws IfsException

Gets the time the progress of the upgrade action was last updated.

Returns:

the time the progress was last updated

Throws:

IfsException - if the operation fails

(Unpublished)