com.google.gdata.util
Class ErrorDomain.ErrorCode

java.lang.Object
  extended by com.google.gdata.util.ErrorDomain.ErrorCode
Enclosing class:
ErrorDomain

public class ErrorDomain.ErrorCode
extends java.lang.Object

ErrorCode objects represent an error code within an error domain. An inner class is used to make it difficult to construct an ErrorCode that accidentally refers to the wrong subclass of ErrorDomain, or to have more than one ErrorDomain object of the same subclass.


Constructor Summary
ErrorDomain.ErrorCode(java.lang.String codeName)
           
 
Method Summary
 java.lang.String getCodeName()
          Gets the name of this ErrorCode, which must be unique within its domain.
 java.lang.String getDomainName()
          Convenience method to retrieve the name of the domain given an error code.
 java.lang.String getExtendedHelp()
          Gets the extended help URI.
 java.lang.String getInternalReason()
          Gets the internal reason (un-internationalized explanation) associated with this ErrorCode.
 java.lang.String getSendReport()
          Gets the URI to which a report should be sent when this error is received.
 ErrorDomain.ErrorCode setExtendedHelp(java.lang.String newExtendedHelp)
           
 ErrorDomain.ErrorCode setInternalReason(java.lang.String newInternalReason)
           
 ErrorDomain.ErrorCode setSendReport(java.lang.String newSendReport)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ErrorDomain.ErrorCode

public ErrorDomain.ErrorCode(java.lang.String codeName)
Method Detail

getCodeName

public java.lang.String getCodeName()
Gets the name of this ErrorCode, which must be unique within its domain. The value will appear as the content of the code element in the XML error format.


getInternalReason

public java.lang.String getInternalReason()
Gets the internal reason (un-internationalized explanation) associated with this ErrorCode. The value will appear as the content of the internalReason element in the XML error format.


setInternalReason

public ErrorDomain.ErrorCode setInternalReason(java.lang.String newInternalReason)

getExtendedHelp

public java.lang.String getExtendedHelp()
Gets the extended help URI. This can be used to retrieve a detailed explanation of the error code. The value will appear as the content of the extendedHelp element in the XML error format.


setExtendedHelp

public ErrorDomain.ErrorCode setExtendedHelp(java.lang.String newExtendedHelp)

getSendReport

public java.lang.String getSendReport()
Gets the URI to which a report should be sent when this error is received. The value will appear as the content of the sendReport element in the XML error format.


setSendReport

public ErrorDomain.ErrorCode setSendReport(java.lang.String newSendReport)

getDomainName

public java.lang.String getDomainName()
Convenience method to retrieve the name of the domain given an error code.