org.jboss.shrinkwrap.descriptor.api.ejbjar30
Interface ApplicationExceptionType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
ApplicationExceptionTypeImpl

public interface ApplicationExceptionType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the application-exceptionType xsd type

Original Documentation:



The application-exceptionType declares an application
exception. The declaration consists of:

- the exception class. When the container receives
an exception of this type, it is required to
forward this exception as an applcation exception
to the client regardless of whether it is a checked
or unchecked exception.
- an optional rollback element. If this element is
set to true, the container must rollback the current
transaction before forwarding the exception to the
client. If not specified, it defaults to false.


Since:
Generation date :2011-07-19T22:54:35.59+02:00
Author:
Ralf Battenfeld

Method Summary
 java.lang.String getExceptionClass()
          Returns the exception-class element
 java.lang.Boolean isRollback()
          Returns the rollback element
 ApplicationExceptionType<T> removeExceptionClass()
          Removes the exception-class element
 ApplicationExceptionType<T> removeRollback()
          Removes the rollback element
 ApplicationExceptionType<T> setExceptionClass(java.lang.String exceptionClass)
          If not already created, a new exception-class element with the given value will be created.
 ApplicationExceptionType<T> setRollback(java.lang.Boolean rollback)
          If not already created, a new rollback element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setExceptionClass

ApplicationExceptionType<T> setExceptionClass(java.lang.String exceptionClass)
If not already created, a new exception-class element with the given value will be created. Otherwise, the existing exception-class element will be updated with the given value.

Returns:
the current instance of ApplicationExceptionType

removeExceptionClass

ApplicationExceptionType<T> removeExceptionClass()
Removes the exception-class element

Returns:
the current instance of ApplicationExceptionType

getExceptionClass

java.lang.String getExceptionClass()
Returns the exception-class element

Returns:
the node defined for the element exception-class

setRollback

ApplicationExceptionType<T> setRollback(java.lang.Boolean rollback)
If not already created, a new rollback element with the given value will be created. Otherwise, the existing rollback element will be updated with the given value.

Returns:
the current instance of ApplicationExceptionType

removeRollback

ApplicationExceptionType<T> removeRollback()
Removes the rollback element

Returns:
the current instance of ApplicationExceptionType

isRollback

java.lang.Boolean isRollback()
Returns the rollback element

Returns:
the node defined for the element rollback