com.evernote.edam.error
Class EDAMUserException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.evernote.edam.error.EDAMUserException
All Implemented Interfaces:
com.evernote.thrift.TBase<EDAMUserException>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<EDAMUserException>

public class EDAMUserException
extends java.lang.Exception
implements com.evernote.thrift.TBase<EDAMUserException>, java.io.Serializable, java.lang.Cloneable

This exception is thrown by EDAM procedures when a call fails as a result of a problem that a caller may be able to resolve. For example, if the user attempts to add a note to their account which would exceed their storage quota, this type of exception may be thrown to indicate the source of the error so that they can choose an alternate action. This exception would not be used for internal system errors that do not reflect user actions, but rather reflect a problem within the service that the user cannot resolve. errorCode: The numeric code indicating the type of error that occurred. must be one of the values of EDAMErrorCode. parameter: If the error applied to a particular input parameter, this will indicate which parameter.

See Also:
Serialized Form

Constructor Summary
EDAMUserException()
           
EDAMUserException(EDAMErrorCode errorCode)
           
EDAMUserException(EDAMUserException other)
          Performs a deep copy on other.
 
Method Summary
 void clear()
          Return to the state of having just been initialized, as though you had just called the default constructor.
 int compareTo(EDAMUserException other)
           
 EDAMUserException deepCopy()
          Creates a deep copy of the object.
 boolean equals(EDAMUserException that)
           
 boolean equals(java.lang.Object that)
           
 EDAMErrorCode getErrorCode()
           
 java.lang.String getParameter()
           
 int hashCode()
           
 boolean isSetErrorCode()
          Returns true if field errorCode is set (has been asigned a value) and false otherwise
 boolean isSetParameter()
          Returns true if field parameter is set (has been asigned a value) and false otherwise
 void read(com.evernote.thrift.protocol.TProtocol iprot)
          Reads an instance of the object from the given protocol.
 void setErrorCode(EDAMErrorCode errorCode)
           
 void setErrorCodeIsSet(boolean value)
           
 void setParameter(java.lang.String parameter)
           
 void setParameterIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetErrorCode()
           
 void unsetParameter()
           
 void validate()
           
 void write(com.evernote.thrift.protocol.TProtocol oprot)
          Writes the object to the given protocol.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EDAMUserException

public EDAMUserException()

EDAMUserException

public EDAMUserException(EDAMErrorCode errorCode)

EDAMUserException

public EDAMUserException(EDAMUserException other)
Performs a deep copy on other.

Method Detail

deepCopy

public EDAMUserException deepCopy()
Description copied from interface: com.evernote.thrift.TBase
Creates a deep copy of the object.

Specified by:
deepCopy in interface com.evernote.thrift.TBase<EDAMUserException>

clear

public void clear()
Description copied from interface: com.evernote.thrift.TBase
Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:
clear in interface com.evernote.thrift.TBase<EDAMUserException>

getErrorCode

public EDAMErrorCode getErrorCode()
See Also:
EDAMErrorCode

setErrorCode

public void setErrorCode(EDAMErrorCode errorCode)
See Also:
EDAMErrorCode

unsetErrorCode

public void unsetErrorCode()

isSetErrorCode

public boolean isSetErrorCode()
Returns true if field errorCode is set (has been asigned a value) and false otherwise


setErrorCodeIsSet

public void setErrorCodeIsSet(boolean value)

getParameter

public java.lang.String getParameter()

setParameter

public void setParameter(java.lang.String parameter)

unsetParameter

public void unsetParameter()

isSetParameter

public boolean isSetParameter()
Returns true if field parameter is set (has been asigned a value) and false otherwise


setParameterIsSet

public void setParameterIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(EDAMUserException that)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

compareTo

public int compareTo(EDAMUserException other)
Specified by:
compareTo in interface java.lang.Comparable<EDAMUserException>

read

public void read(com.evernote.thrift.protocol.TProtocol iprot)
          throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Reads an instance of the object from the given protocol.

Specified by:
read in interface com.evernote.thrift.TBase<EDAMUserException>
Parameters:
iprot - Input protocol
Throws:
com.evernote.thrift.TException

write

public void write(com.evernote.thrift.protocol.TProtocol oprot)
           throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Writes the object to the given protocol.

Specified by:
write in interface com.evernote.thrift.TBase<EDAMUserException>
Parameters:
oprot - Output protocol
Throws:
com.evernote.thrift.TException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Throwable

validate

public void validate()
              throws com.evernote.thrift.TException
Throws:
com.evernote.thrift.TException