Package com.appiancorp.suiteapi.process.upgrade

Class UpgradeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.suiteapi.process.upgrade.UpgradeException

All Implemented Interfaces:

Serializable

public class UpgradeException
extends AppianException

This class is available as a preview of functionality that will be added to the supported public API in a future release. While it is in the preview phase, it is subject to change or removal without deprecation or notice. Although notice of change is not guaranteed, we will try to let developers know of major changes through announcements in release notes.

Thrown when a condition occurs during a process upgrade that prevents the upgrade from continuing.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UpgradeException(ErrorCode errorCode, Object... errorCodeArgs)
UpgradeException(ErrorCode errorCode, Throwable cause)	Creates an instance with the given error code and cause.
UpgradeException(ErrorCode errorCode, Throwable cause, Object... errorCodeArgs)

Method Summary

Modifier and Type	Method	Description
ProcessUpgrade[]	getCompletedUpgrades()	Gets the ProcessUpgrade objects representing the upgrade attempts that completed before the exception occurred.
Long[]	getProcessIdsCausingFailure()	Gets the process ids of the batch of processes that were being upgraded when the exception occurred.
void	setCompletedUpgrades(ProcessUpgrade[] completedUpgrades)	Sets the ProcessUpgrade objects representing the upgrade attempts that completed before the exception occurred.
void	setProcessIdsCausingFailure(Long[] processIdsCausingFailure)	Sets the process ids of the batch of processes that were being upgraded when the exception occurred.

Methods inherited from class com.appiancorp.suiteapi.common.exceptions.AppianException

getErrorCode, getErrorCodeArguments, getErrorCodeArguments, getErrorCodeArgumentsAsStringArray, getLocalizedMessage, getLocalizedMessage, getLocalizedMessageWithErrorCode, getLocalizedTitle, getMessage, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UpgradeException

public UpgradeException(ErrorCode errorCode,
 Throwable cause)

Creates an instance with the given error code and cause.

Parameters:

errorCode - the error code associated with the exception

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

UpgradeException

public UpgradeException(ErrorCode errorCode,
 Object... errorCodeArgs)

Parameters:

errorCode - the error code associated with the exception

errorCodeArgs - the arguments to be used to render this exception's message representation

UpgradeException

public UpgradeException(ErrorCode errorCode,
 Throwable cause,
 Object... errorCodeArgs)

Parameters:

errorCode - the error code associated with the exception

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

errorCodeArgs - the arguments to be used to render this exception's message representation

Method Details

setCompletedUpgrades

public void setCompletedUpgrades(ProcessUpgrade[] completedUpgrades)

Sets the ProcessUpgrade objects representing the upgrade attempts that completed before the exception occurred. Completed does not mean that the outcome was ProcessUpgrade.Outcome.SUCCESS and any outcomes are allowed.

Parameters:

completedUpgrades - the completed upgrade attempts, which can be empty but not null

getCompletedUpgrades

public ProcessUpgrade[] getCompletedUpgrades()

Gets the ProcessUpgrade objects representing the upgrade attempts that completed before the exception occurred. Completed does not mean that the outcome was ProcessUpgrade.Outcome.SUCCESS and any outcomes may be present.

Returns:

the completed upgrade attempts, which may be empty but will not be null

setProcessIdsCausingFailure

public void setProcessIdsCausingFailure(Long[] processIdsCausingFailure)

Sets the process ids of the batch of processes that were being upgraded when the exception occurred.

Parameters:

processIdsCausingFailure - The process ids whose attempted upgrade resulted in failure. Can be empty if the exception occurred prior to processing any of the batches, but may not be null.

getProcessIdsCausingFailure

public Long[] getProcessIdsCausingFailure()

Gets the process ids of the batch of processes that were being upgraded when the exception occurred.

Returns:

The process ids whose attempted upgrade resulted in failure. Can be empty if the exception occurred prior to processing any of the batches, but will not be null.