Package org.eclipse.lyo.oslc4j.core.model

Class Error

java.lang.Object

org.eclipse.lyo.oslc4j.core.model.AbstractResource

org.eclipse.lyo.oslc4j.core.model.Error

All Implemented Interfaces:

IExtendedResource, IResource

@OslcNamespace("http://open-services.net/ns/core#")
@OslcResourceShape(title="OSLC Error Resource Shape",
                   describes="http://open-services.net/ns/core#Error")
public class Error
extends AbstractResource

OSLC Error resource.

This class extends AbstractResource to support extended properties as required by the OSLC Core specification. This allows adding properties like dcterms:description or dcterms:identifier to error responses.

See Also:

• OSLC Core 3.0: Unknown properties and content
• OSLC Spec Issue #466

Constructor Summary

Constructors

Constructor	Description
Error()

Method Summary

Modifier and Type	Method	Description
ExtendedError	getExtendedError()
String	getMessage()
String	getStatusCode()
void	setExtendedError(ExtendedError extendedError)
void	setMessage(String message)
void	setStatusCode(String statusCode)

Methods inherited from class org.eclipse.lyo.oslc4j.core.model.AbstractResource

addType, getAbout, getExtendedProperties, getTypes, setAbout, setExtendedProperties, setTypes

Methods inherited from class java.lang.Object

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

Constructor Details

Error

public Error()

Method Details

getExtendedError

@OslcDescription("Extended error information.")
@OslcPropertyDefinition("http://open-services.net/ns/core#extendedError")
@OslcRange("http://open-services.net/ns/core#ExtendedError")
@OslcReadOnly
@OslcRepresentation(Inline)
@OslcTitle("Extended Error")
@OslcValueShape("resourceShapes/extendedError")
@OslcValueType(LocalResource)
public ExtendedError getExtendedError()

getMessage

@OslcDescription("An informative message describing the error that occurred.")
@OslcOccurs(ExactlyOne)
@OslcPropertyDefinition("http://open-services.net/ns/core#message")
@OslcReadOnly
@OslcTitle("Message")
public String getMessage()

getStatusCode

@OslcDescription("The HTTP status code reported with the error.")
@OslcOccurs(ExactlyOne)
@OslcPropertyDefinition("http://open-services.net/ns/core#statusCode")
@OslcReadOnly
@OslcTitle("Status Code")
public String getStatusCode()

setExtendedError

public void setExtendedError(ExtendedError extendedError)

setMessage

public void setMessage(String message)

setStatusCode

public void setStatusCode(String statusCode)