Preliminary documentation subject to change

com.bugcollect
Class Report

java.lang.Object
  extended by com.bugcollect.Report

public final class Report
extends java.lang.Object

This class stores the information about a report submitted to bugcollect.com.


Constructor Summary
Report()
          Creates a report.
Report(java.lang.String notes, java.lang.Throwable e)
          Creates a report.
 
Method Summary
 java.lang.String getApplication()
          Gets the application name.
 java.lang.String getApplicationVersion()
          Gets the application version.
 java.lang.String getException()
          Gets the exception class name
 java.lang.String getHostName()
          Gets the host name.
 java.util.Date getIncidentTime()
          Gets the incident time.
 java.lang.String getMessage()
          Gets the error message
 java.lang.String getModule()
          Gets the module name.
 java.lang.String getModuleVersion()
          Gets the module version.
 java.lang.String getNotes()
          Gets the report notes.
 java.lang.String getOs()
          Gets the OS name
 java.lang.String getOsVersion()
          Gets the OS version.
 int getSeverity()
          Gets the report severity.
 java.lang.String getStackTrace()
          Gets the report stack trace.
 java.util.UUID getUUID()
          Gets the report global unique identifier.
 void setApplication(java.lang.String value)
          Sets the application name.
 void setApplicationVersion(java.lang.String value)
          Sets the application version.
 void setException(java.lang.String value)
          Sets the exception class name.
 void setHostName(java.lang.String value)
          The host name from where the report is submitted.
 void setIncidentTime(java.util.Date value)
          The time of the reported incident.
 void setMessage(java.lang.String value)
          Sets the report error message.
 void setModule(java.lang.String value)
          Sets the name of the module that is reporting the incident.
 void setModuleVersion(java.lang.String value)
          Sets the version of the module that is reporting the incident.
 void setNotes(java.lang.String value)
          Sets the report notes.
 void setOs(java.lang.String value)
          The host operating system name.
 void setOsVersion(java.lang.String value)
          The host operating system version.
 void setSeverity(int value)
          Sets the report severity.
 void setStackTrace(java.lang.String value)
          The call stack of the reported incident.
 void setUUID(java.util.UUID value)
          Sets the report global unique identifier.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Report

public Report()
Creates a report. The incidentTime, os and osVersion are initialized implicitly.


Report

public Report(java.lang.String notes,
              java.lang.Throwable e)
Creates a report. Report fields are explicitly initialized from the exception and notes information: notes, message, exception, severity, stackTrace incidentTime, os osVersion and hostName.

Method Detail

setUUID

public void setUUID(java.util.UUID value)
Sets the report global unique identifier. A new random UUID is assigned to each Report in the construnctor. Report UUIDs can be used to retry submittion if bugcollect.com cannot be contacted.


getUUID

public java.util.UUID getUUID()
Gets the report global unique identifier.


setMessage

public void setMessage(java.lang.String value)
Sets the report error message. This property is part of the report bucket hash.


getMessage

public java.lang.String getMessage()
Gets the error message


setException

public void setException(java.lang.String value)
Sets the exception class name. This property is part of the report bucket hash.


getException

public java.lang.String getException()
Gets the exception class name


setSeverity

public void setSeverity(int value)
Sets the report severity. bugcollect.com does not interpret the severity values in any way. This property is part of the report bucket hash.


getSeverity

public int getSeverity()
Gets the report severity.


setStackTrace

public void setStackTrace(java.lang.String value)
The call stack of the reported incident. This is automatically filled with the exception call stack. This property is part of the report bucket hash.


getStackTrace

public java.lang.String getStackTrace()
Gets the report stack trace.


setNotes

public void setNotes(java.lang.String value)
Sets the report notes. Any additional information that can be relevant to the submitted report and varies with each individual report. This property is not part of the report bucket hash.


getNotes

public java.lang.String getNotes()
Gets the report notes.


setApplication

public void setApplication(java.lang.String value)
Sets the application name. This property is part of the report bucket hash.


getApplication

public java.lang.String getApplication()
Gets the application name.


setApplicationVersion

public void setApplicationVersion(java.lang.String value)
Sets the application version. This property is part of the report bucket hash.


getApplicationVersion

public java.lang.String getApplicationVersion()
Gets the application version.


setModule

public void setModule(java.lang.String value)
Sets the name of the module that is reporting the incident. This property is part of the report bucket hash.


getModule

public java.lang.String getModule()
Gets the module name.


setModuleVersion

public void setModuleVersion(java.lang.String value)
Sets the version of the module that is reporting the incident. This property is part of the report bucket hash.


getModuleVersion

public java.lang.String getModuleVersion()
Gets the module version.


setHostName

public void setHostName(java.lang.String value)
The host name from where the report is submitted. This is automatically filled from the network local hostname.


getHostName

public java.lang.String getHostName()
Gets the host name.


setOs

public void setOs(java.lang.String value)
The host operating system name. This value is automatically filled from the System os.name property. This property is not part of the report bucket hash.


getOs

public java.lang.String getOs()
Gets the OS name


setOsVersion

public void setOsVersion(java.lang.String value)
The host operating system version. This value is automatically filled from the System os.version property. This property is not part of the report bucket hash.


getOsVersion

public java.lang.String getOsVersion()
Gets the OS version.


setIncidentTime

public void setIncidentTime(java.util.Date value)
The time of the reported incident. This is automatically filled with the current time when SubmitReport method is called. This property is not part of the report bucket hash


getIncidentTime

public java.util.Date getIncidentTime()
Gets the incident time.


Preliminary documentation subject to change