org.apache.ambari.server.api.services

Class ResultStatus

java.lang.Object

org.apache.ambari.server.api.services.ResultStatus

public class ResultStatus
extends Object

Result status information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultStatus.STATUS STATUS enum.

Constructor Summary

Constructors

Constructor and Description
ResultStatus(ResultStatus.STATUS status) Constructor.
ResultStatus(ResultStatus.STATUS status, Exception e) Constructor.
ResultStatus(ResultStatus.STATUS status, String msg) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Obtain the result message.
ResultStatus.STATUS	getStatus() Obtain the result status.
int	getStatusCode() Obtain the status code.
boolean	isErrorState() Determine whether the status is an error state.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultStatus

public ResultStatus(ResultStatus.STATUS status,
                    String msg)

Constructor.

Parameters:

status - result status

msg - result msg. Usually used in case of an error.

ResultStatus

public ResultStatus(ResultStatus.STATUS status)

Constructor.

Parameters:

status - result status

ResultStatus

public ResultStatus(ResultStatus.STATUS status,
                    Exception e)

Constructor.

Parameters:

status - result status

e - result exception

Method Detail

getStatus

public ResultStatus.STATUS getStatus()

Obtain the result status. The result status contains a status code and a description of the status.

Returns:

the result status

getStatusCode

public int getStatusCode()

Obtain the status code. This is a shortcut to obtaining the status code from the associated result status.

Returns:

the status code

isErrorState

public boolean isErrorState()

Determine whether the status is an error state. This is a shortcut to getting this information from the associated result status.

Returns:

true if the status is a result state; false otherwise

getMessage

public String getMessage()

Obtain the result message. This message is usually used when an exception occurred.

Returns:

the result message