Package org.javastro.ivoa.entities.uws

Class ErrorSummary

java.lang.Object

org.javastro.ivoa.entities.uws.ErrorSummary

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class ErrorSummary
extends Object
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

A short summary of an error - a fuller representation of the error may be retrieved from /{jobs}/{job-id}/error

Java class for ErrorSummary complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ErrorSummary">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="message" type="{http://www.w3.org/2001/XMLSchema}string"/>
       </sequence>
       <attribute name="type" use="required" type="{http://www.ivoa.net/xml/UWS/v1.0}ErrorType" />
       <attribute name="hasDetail" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasDetail	if true then there is a more detailed error message available at /{jobs}/{job-id}/error
protected String	message
protected ErrorType	type	characterization of the type of the error

Constructor Summary

Constructors

Constructor	Description
ErrorSummary()	Default no-arg constructor
ErrorSummary(String message, ErrorType type, boolean hasDetail)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
String	getMessage()	Gets the value of the message property.
ErrorType	getType()	characterization of the type of the error
int	hashCode()
boolean	isHasDetail()	if true then there is a more detailed error message available at /{jobs}/{job-id}/error
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
void	setHasDetail(boolean value)	Sets the value of the hasDetail property.
void	setMessage(String value)	Sets the value of the message property.
void	setType(ErrorType value)	Sets the value of the type property.
String	toString()
ErrorSummary	withHasDetail(boolean value)
ErrorSummary	withMessage(String value)
ErrorSummary	withType(ErrorType value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

message

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String message

type

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected ErrorType type

characterization of the type of the error

hasDetail

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected boolean hasDetail

if true then there is a more detailed error message available at /{jobs}/{job-id}/error

Constructor Details

ErrorSummary

public ErrorSummary()

Default no-arg constructor

ErrorSummary

public ErrorSummary(String message,
 ErrorType type,
 boolean hasDetail)

Fully-initialising value constructor

Method Details

getMessage

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getMessage()

Gets the value of the message property.

Returns:

possible object is String

setMessage

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setMessage(String value)

Sets the value of the message property.

Parameters:

value - allowed object is String

getType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ErrorType getType()

characterization of the type of the error

Returns:

possible object is ErrorType

setType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setType(ErrorType value)

Sets the value of the type property.

Parameters:

value - allowed object is ErrorType

See Also:

• getType()

isHasDetail

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean isHasDetail()

if true then there is a more detailed error message available at /{jobs}/{job-id}/error

setHasDetail

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setHasDetail(boolean value)

Sets the value of the hasDetail property.

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class Object

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

withMessage

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ErrorSummary withMessage(String value)

withType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ErrorSummary withType(ErrorType value)

withHasDetail

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ErrorSummary withHasDetail(boolean value)

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom