Package com.ptc.odata.windchill

Class WCExceptionBuilder

java.lang.Object

com.ptc.odata.windchill.WCExceptionBuilder

public class WCExceptionBuilder
extends Object

This builder simplifies the process of throwing localized ODataApplicationExceptions.

Use one of these methods if you have a Throwable (which is used to derive the HTTP status code):

• Use buildODataApplicationException(Throwable, Locale) to use the message from the exception.
• Use buildODataApplicationException(Throwable, Locale, Class, String) to use the localized message with the inserted exception message.

And one of these methods if you don't have a Throwable (in which case you much provide the HTTP status code).

• Use buildODataApplicationException(HttpStatusCode, Locale, Class, String) to use the localized message.
• Use buildODataApplicationException(HttpStatusCode, Locale, Class, String, Object[]) to use the localized message with inserted text.

Or use buildODataApplicationException(HttpStatusCode, String, String) to specify a non-localized message.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static org.apache.olingo.server.api.ODataApplicationException	buildODataApplicationException(Throwable e, Locale locale)	See WCExceptionBuilder JavaDoc for description of the methods to use.
static org.apache.olingo.server.api.ODataApplicationException	buildODataApplicationException(org.apache.olingo.commons.api.http.HttpStatusCode httpStatusCode, String message, String errorCode)	Supported API: true See WCExceptionBuilder JavaDoc for description of the methods to use.
static org.apache.olingo.server.api.ODataApplicationException	buildODataApplicationException(org.apache.olingo.commons.api.http.HttpStatusCode httpStatusCode, Locale locale, Class resource, String key, Object[] textInserts)	Supported API: true See WCExceptionBuilder JavaDoc for description of the methods to use.

Methods inherited from class java.lang.Object

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

Method Details

buildODataApplicationException

public static org.apache.olingo.server.api.ODataApplicationException buildODataApplicationException(Throwable e,
 Locale locale)

See WCExceptionBuilder JavaDoc for description of the methods to use.

Supported API: true

buildODataApplicationException

public static org.apache.olingo.server.api.ODataApplicationException buildODataApplicationException(org.apache.olingo.commons.api.http.HttpStatusCode httpStatusCode,
 Locale locale,
 Class resource,
 String key,
 Object[] textInserts)

Supported API: true
See WCExceptionBuilder JavaDoc for description of the methods to use.

buildODataApplicationException

public static org.apache.olingo.server.api.ODataApplicationException buildODataApplicationException(org.apache.olingo.commons.api.http.HttpStatusCode httpStatusCode,
 String message,
 String errorCode)

Supported API: true
See WCExceptionBuilder JavaDoc for description of the methods to use.