org.jboss.shrinkwrap.descriptor.api.webcommon31.SessionConfigType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.webcommon31; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.webcommon31.CookieConfigType;
import org.jboss.shrinkwrap.descriptor.api.webcommon31.TrackingModeType;
import org.jboss.shrinkwrap.descriptor.api.webcommon.*;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.*;
import org.jboss.shrinkwrap.descriptor.api.jsp.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.JavaeeSessionConfigCommonType;
/**
 * This interface defines the contract for the  session-configType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface SessionConfigType extends Child, 
    JavaeeSessionConfigCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SessionConfigType ElementName: xsd:integer ElementType : session-timeout
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the session-timeout element
    * @param sessionTimeout the value for the element session-timeout 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType sessionTimeout(Integer sessionTimeout);

   /**
    * Returns the session-timeout element
    * @return the node defined for the element session-timeout 
    */
   public Integer getSessionTimeout();

   /**
    * Removes the session-timeout element 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType removeSessionTimeout();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SessionConfigType ElementName: javaee:cookie-configType ElementType : cookie-config
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new cookie-config element with the given value will be created.
    * Otherwise, the existing cookie-config element will be returned.
    * @return  a new or existing instance of CookieConfigType> 
    */
   public CookieConfigType> getOrCreateCookieConfig();

   /**
    * Removes the cookie-config element 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType removeCookieConfig();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SessionConfigType ElementName: javaee:tracking-modeType ElementType : tracking-mode
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all javaee:tracking-modeType objects representing tracking-mode elements, 
    * a new tracking-mode element 
    * @param values list of tracking-mode objects 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType trackingMode(TrackingModeType ... values);

   /**
    * Creates for all String objects representing tracking-mode elements, 
    * a new tracking-mode element 
    * @param values list of tracking-mode objects 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType trackingMode(String ... values);

   /**
    * Returns all tracking-mode elements
    * @return list of tracking-mode 
    */
   public List getAllTrackingMode();

   /**
    * Removes the tracking-mode element 
    * @return the current instance of SessionConfigType 
    */
   public SessionConfigType removeAllTrackingMode();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: SessionConfigType 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 SessionConfigType 
    */
   public SessionConfigType 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 SessionConfigType 
    */
   public SessionConfigType removeId();
}