jetbrains.buildServer.serverSide.maintenance
Interface MaintenanceProcess

All Known Subinterfaces:
BackupProcess

public interface MaintenanceProcess

A maintenance process, that can be performed in TeamCity only one at one time.

See Also:
MaintenanceProcessManager

Method Summary
 void cancel()
          Request the process to cancel.
 java.lang.Exception[] getExceptions()
          Returns exceptions that occured during process performing.
 int getProcessId()
          Returns the maintenance process identifier.
 MaintenanceProcessKind getProcessKind()
          Returns kind of this process.
 ProgressInfo getProgressInfo()
          Returns the progress in percents and a name of phase.
 ProgressStatus getProgressStatus()
          Returns the progress status of the process.
 boolean hasExceptions()
          Determines whether exceptions occurred during process performing.
 boolean isFinished()
          Determines whether the process has already performed its operations or has been stopped.
 

Method Detail

getProcessKind

@NotNull
MaintenanceProcessKind getProcessKind()
Returns kind of this process.


getProcessId

int getProcessId()
Returns the maintenance process identifier. This identifier is an internal identified of the maintenance process, it doesn't relate to operating system process identifiers or something else.

Returns:
the maintenance process identifier.

getProgressStatus

@NotNull
ProgressStatus getProgressStatus()
Returns the progress status of the process.

Returns:
the progress status.

getProgressInfo

@NotNull
ProgressInfo getProgressInfo()
Returns the progress in percents and a name of phase.

Returns:
the progress in percents and a name of phase.

cancel

void cancel()
Request the process to cancel.


hasExceptions

boolean hasExceptions()
Determines whether exceptions occurred during process performing.

Returns:
true if there are exceptions.

getExceptions

java.lang.Exception[] getExceptions()
Returns exceptions that occured during process performing.

Returns:
occured exceptions in time order.

isFinished

boolean isFinished()
Determines whether the process has already performed its operations or has been stopped. If this functions has returned true, then this process will never do something more. And, the result is not depeneded on whether the process has ended successfully or with errors.

Returns:
true means all possible works have already done.
Since:
7.1