org.openstack4j.model.common

Class ActionResponse

java.lang.Object

org.openstack4j.model.common.ActionResponse

All Implemented Interfaces:

Serializable

public class ActionResponse
extends Object
implements Serializable

A response that is returned when an Action is performed against the server. If isSuccess() is true then the fault will always be null. The fault will indicate why the action has failed. Any other transport/communication errors will be thrown as with any other API calls.

Author:

Jeremy Unruh

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static ActionResponse	actionFailed(String message, int code)
static ActionResponse	actionSuccess()
static ActionResponse	actionSuccess(int code)
int	getCode() Returns the underlying error code (status code)
String	getFault()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

actionSuccess

public static ActionResponse actionSuccess(int code)

actionSuccess

public static ActionResponse actionSuccess()

actionFailed

public static ActionResponse actionFailed(String message,
                                          int code)

getCode

public int getCode()

Returns the underlying error code (status code)

Returns:

the error code

isSuccess

public boolean isSuccess()

Returns:

true if the action was successful

getFault

public String getFault()

Returns:

the fault if the action was unsuccessful otherwise null

toString

public String toString()

Overrides:

toString in class Object