jimm.twice.ice
Class IceCode

java.lang.Object
  jimm.twice.ice.IceCode

public class IceCode

extends java.lang.Object

ICE codes are used often enough that it's nice to have an objectified representation.

Author:

Jim Menard, jimm@io.com

Field Summary

protected int	errorCode
protected java.lang.String	errorMessage
protected java.lang.String	errorPhrase
protected java.lang.String	language
protected java.lang.String	messageId
protected java.lang.String	packageId
protected java.lang.String	payloadId

Constructor Summary

IceCode(int code, java.lang.String payloadId, java.lang.String messageId, java.lang.String packageId, java.lang.String language)
Constructor.

Method Summary

int	getErrorCode() Returns the error code number.
java.lang.String	getErrorMessage() Returns the error message; may be null.
java.lang.String	getErrorPhrase() Returns the error phrase.
java.lang.String	getMessageId() Returns the message id; may be null.
java.lang.String	getPackageId() Returns the package id; may be null.
java.lang.String	getPayloadId() Returns the payload id; may be null.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

errorCode

protected int errorCode

errorPhrase

protected java.lang.String errorPhrase

errorMessage

protected java.lang.String errorMessage

payloadId

protected java.lang.String payloadId

messageId

protected java.lang.String messageId

packageId

protected java.lang.String packageId

language

protected java.lang.String language

Constructor Detail

IceCode

public IceCode(int code,
               java.lang.String payloadId,
               java.lang.String messageId,
               java.lang.String packageId,
               java.lang.String language)

Constructor.

Parameters:

code - the ICE code number

payloadId - the ICE payload identifier; may be null

messageId - the package id; may be null

language - the xml:lang value; may be null

Method Detail

getErrorCode

public int getErrorCode()

Returns the error code number.

Returns:

the error code number

getErrorPhrase

public java.lang.String getErrorPhrase()

Returns the error phrase. Lazily instantiates it.

Returns:

the error phrase

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message; may be null.

Returns:

the error message; may be null

getPayloadId

public java.lang.String getPayloadId()

Returns the payload id; may be null.

Returns:

the payload id; may be null

getMessageId

public java.lang.String getMessageId()

Returns the message id; may be null.

Returns:

the message id; may be null

getPackageId

public java.lang.String getPackageId()

Returns the package id; may be null.

Returns:

the package id; may be null

toString

public java.lang.String toString()