org.jboss.shrinkwrap.descriptor.api.ejbjar31
Interface StatefulTimeoutType<T>

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

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

This interface defines the contract for the stateful-timeoutType xsd type

Original Documentation:



The stateful-timeoutType represents the amount of time
a stateful session bean can be idle(not receive any client
invocations) before it is eligible for removal by the container.

A timeout value of 0 means the bean is immediately eligible for removal.

A timeout value of -1 means the bean will never be removed due to timeout.


Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Method Summary
 java.lang.Integer getTimeout()
          Returns the timeout element
 TimeUnitTypeType getUnit()
          Returns the unit element
 java.lang.String getUnitAsString()
          Returns the unit element
 StatefulTimeoutType<T> removeTimeout()
          Removes the timeout element
 StatefulTimeoutType<T> setTimeout(java.lang.Integer timeout)
          If not already created, a new timeout element with the given value will be created.
 StatefulTimeoutType<T> setUnit(java.lang.String unit)
          If not already created, a new unit element with the given value will be created.
 StatefulTimeoutType<T> setUnit(TimeUnitTypeType unit)
          If not already created, a new unit element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setTimeout

StatefulTimeoutType<T> setTimeout(java.lang.Integer timeout)
If not already created, a new timeout element with the given value will be created. Otherwise, the existing timeout element will be updated with the given value.

Returns:
the current instance of StatefulTimeoutType

removeTimeout

StatefulTimeoutType<T> removeTimeout()
Removes the timeout element

Returns:
the current instance of StatefulTimeoutType

getTimeout

java.lang.Integer getTimeout()
Returns the timeout element

Returns:
the node defined for the element timeout

setUnit

StatefulTimeoutType<T> setUnit(TimeUnitTypeType unit)
If not already created, a new unit element with the given value will be created. Otherwise, the existing unit element will be updated with the given value.

Returns:
the current instance of StatefulTimeoutType

setUnit

StatefulTimeoutType<T> setUnit(java.lang.String unit)
If not already created, a new unit element with the given value will be created. Otherwise, the existing unit element will be updated with the given value.

Returns:
the current instance of StatefulTimeoutType

getUnit

TimeUnitTypeType getUnit()
Returns the unit element

Returns:
the node defined for the element unit

getUnitAsString

java.lang.String getUnitAsString()
Returns the unit element

Returns:
the node defined for the element unit