ccc.api.core
Class Failure

java.lang.Object
  ccc.api.core.Failure

All Implemented Interfaces:

java.io.Serializable

public class Failure
extends java.lang.Object
implements java.io.Serializable

A serializable representation of CCC failure.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Constructor Summary

protected	Failure() Constructor: for persistence only.
	Failure(java.util.UUID id, java.lang.String code, java.util.Map<java.lang.String,java.lang.String> params) Constructor.

Method Summary

java.lang.String	getCode() Accessor.
java.lang.String	getExceptionId() Accessor.
java.util.UUID	getId() Accessor.
java.util.Map<java.lang.String,java.lang.String>	getParams() Accessor.
void	setCode(java.lang.String code) Mutator.
void	setId(java.util.UUID id) Mutator.
void	setParams(java.util.Map<java.lang.String,java.lang.String> params) Mutator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Failure

protected Failure()

Constructor: for persistence only.

Failure

public Failure(java.util.UUID id,
               java.lang.String code,
               java.util.Map<java.lang.String,java.lang.String> params)

Constructor.

Parameters:

id - The failure's ID.

code - The internal code for this failure.

params - Further details describing the failure.

Method Detail

getCode

public java.lang.String getCode()

Accessor.

Returns:

Returns the errorCode.

getExceptionId

public java.lang.String getExceptionId()

Accessor.

Returns:

Returns the exceptionId.

getId

public java.util.UUID getId()

Accessor.

Returns:

Returns the failure's ID.

getParams

public final java.util.Map<java.lang.String,java.lang.String> getParams()

Accessor.

Returns:

Returns the parameters.

setId

public void setId(java.util.UUID id)

Mutator.

Parameters:

id - The id to set.

setCode

public void setCode(java.lang.String code)

Mutator.

Parameters:

code - The code to set.

setParams

public void setParams(java.util.Map<java.lang.String,java.lang.String> params)

Mutator.

Parameters:

params - The params to set.