org.jboss.shrinkwrap.descriptor.api.ejbjar31.TimerType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.ejbjar31;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.TimerScheduleType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.NamedMethodType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeTimerCommonType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.TimerScheduleType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.NamedMethodType;/**
* This interface defines the contract for the timerType
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface TimerType extends Child,
JavaeeTimerCommonType,
TimerScheduleType>,
NamedMethodType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description
elements,
* a new description
element
* @param values list of description
objects
* @return the current instance of TimerType
*/
public TimerType description(String ... values);
/**
* Returns all description
elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description
element
* @return the current instance of TimerType
*/
public TimerType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: javaee:timer-scheduleType ElementType : schedule
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new schedule
element with the given value will be created.
* Otherwise, the existing schedule
element will be returned.
* @return a new or existing instance of TimerScheduleType>
*/
public TimerScheduleType> getOrCreateSchedule();
/**
* Removes the schedule
element
* @return the current instance of TimerType
*/
public TimerType removeSchedule();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:dateTime ElementType : start
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the start
element
* @param start the value for the element start
* @return the current instance of TimerType
*/
public TimerType start(java.util.Date start);
/**
* Returns the start
element
* @return the node defined for the element start
*/
public java.util.Date getStart();
/**
* Removes the start
element
* @return the current instance of TimerType
*/
public TimerType removeStart();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:dateTime ElementType : end
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the end
element
* @param end the value for the element end
* @return the current instance of TimerType
*/
public TimerType end(java.util.Date end);
/**
* Returns the end
element
* @return the node defined for the element end
*/
public java.util.Date getEnd();
/**
* Removes the end
element
* @return the current instance of TimerType
*/
public TimerType removeEnd();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: javaee:named-methodType ElementType : timeout-method
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new timeout-method
element with the given value will be created.
* Otherwise, the existing timeout-method
element will be returned.
* @return a new or existing instance of NamedMethodType>
*/
public NamedMethodType> getOrCreateTimeoutMethod();
/**
* Removes the timeout-method
element
* @return the current instance of TimerType
*/
public TimerType removeTimeoutMethod();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: javaee:xsdBooleanType ElementType : persistent
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the persistent
element
* @param persistent the value for the element persistent
* @return the current instance of TimerType
*/
public TimerType persistent(Boolean persistent);
/**
* Returns the persistent
element
* @return the node defined for the element persistent
*/
public Boolean isPersistent();
/**
* Removes the persistent
element
* @return the current instance of TimerType
*/
public TimerType removePersistent();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:token ElementType : timezone
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the timezone
element
* @param timezone the value for the element timezone
* @return the current instance of TimerType
*/
public TimerType timezone(String timezone);
/**
* Returns the timezone
element
* @return the node defined for the element timezone
*/
public String getTimezone();
/**
* Removes the timezone
element
* @return the current instance of TimerType
*/
public TimerType removeTimezone();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:token ElementType : info
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the info
element
* @param info the value for the element info
* @return the current instance of TimerType
*/
public TimerType info(String info);
/**
* Returns the info
element
* @return the node defined for the element info
*/
public String getInfo();
/**
* Removes the info
element
* @return the current instance of TimerType
*/
public TimerType removeInfo();
// --------------------------------------------------------------------------------------------------------||
// ClassName: TimerType ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id
attribute
* @param id the value for the attribute id
* @return the current instance of TimerType
*/
public TimerType id(String id);
/**
* Returns the id
attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id
attribute
* @return the current instance of TimerType
*/
public TimerType removeId();
}