net.sourceforge.ccxjc.it.model.pkg.indexed.novalueclass.javaee
Interface ServletType

All Known Implementing Classes:

ServletTypeImpl

public interface ServletType

The servletType is used to declare a servlet. It contains the declarative data of a servlet. If a jsp-file is specified and the load-on-startup element is present, then the JSP should be precompiled and loaded. Used in: web-app

Java class for servletType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="servletType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="servlet-name" type="{http://java.sun.com/xml/ns/javaee}servlet-nameType"/>
         <choice>
           <element name="servlet-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
           <element name="jsp-file" type="{http://java.sun.com/xml/ns/javaee}jsp-fileType"/>
         </choice>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="load-on-startup" type="{http://java.sun.com/xml/ns/javaee}load-on-startupType" minOccurs="0"/>
         <element name="run-as" type="{http://java.sun.com/xml/ns/javaee}run-asType" minOccurs="0"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/javaee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
IconType[]	getIcon()
IconType	getIcon(int idx)
int	getIconLength()
String	getId() Gets the value of the id property.
ParamValueType[]	getInitParam()
ParamValueType	getInitParam(int idx)
int	getInitParamLength()
JspFileType	getJspFile() Gets the value of the jspFile property.
String	getLoadOnStartup() Gets the value of the loadOnStartup property.
RunAsType	getRunAs() Gets the value of the runAs property.
SecurityRoleRefType[]	getSecurityRoleRef()
SecurityRoleRefType	getSecurityRoleRef(int idx)
int	getSecurityRoleRefLength()
FullyQualifiedClassType	getServletClass() Gets the value of the servletClass property.
ServletNameType	getServletName() Gets the value of the servletName property.
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setIcon(IconType[] values)
IconType	setIcon(int idx, IconType value)
void	setId(String value) Sets the value of the id property.
ParamValueType	setInitParam(int idx, ParamValueType value)
void	setInitParam(ParamValueType[] values)
void	setJspFile(JspFileType value) Sets the value of the jspFile property.
void	setLoadOnStartup(String value) Sets the value of the loadOnStartup property.
void	setRunAs(RunAsType value) Sets the value of the runAs property.
SecurityRoleRefType	setSecurityRoleRef(int idx, SecurityRoleRefType value)
void	setSecurityRoleRef(SecurityRoleRefType[] values)
void	setServletClass(FullyQualifiedClassType value) Sets the value of the servletClass property.
void	setServletName(ServletNameType value) Sets the value of the servletName property.

Method Detail

getDescription

DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

int getDescriptionLength()

setDescription

void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

DescriptionType setDescription(int idx,
                               DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

int getDisplayNameLength()

setDisplayName

void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

DisplayNameType setDisplayName(int idx,
                               DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getIcon

IconType[] getIcon()

Returns:

array of IconType

getIcon

IconType getIcon(int idx)

Returns:

one of IconType

getIconLength

int getIconLength()

setIcon

void setIcon(IconType[] values)

Parameters:

values - allowed objects are IconType

setIcon

IconType setIcon(int idx,
                 IconType value)

Parameters:

value - allowed object is IconType

getServletName

ServletNameType getServletName()

Gets the value of the servletName property.

Returns:

possible object is ServletNameType

setServletName

void setServletName(ServletNameType value)

Sets the value of the servletName property.

Parameters:

value - allowed object is ServletNameType

getServletClass

FullyQualifiedClassType getServletClass()

Gets the value of the servletClass property.

Returns:

possible object is FullyQualifiedClassType

setServletClass

void setServletClass(FullyQualifiedClassType value)

Sets the value of the servletClass property.

Parameters:

value - allowed object is FullyQualifiedClassType

getJspFile

JspFileType getJspFile()

Gets the value of the jspFile property.

Returns:

possible object is JspFileType

setJspFile

void setJspFile(JspFileType value)

Sets the value of the jspFile property.

Parameters:

value - allowed object is JspFileType

getInitParam

ParamValueType[] getInitParam()

Returns:

array of ParamValueType

getInitParam

ParamValueType getInitParam(int idx)

Returns:

one of ParamValueType

getInitParamLength

int getInitParamLength()

setInitParam

void setInitParam(ParamValueType[] values)

Parameters:

values - allowed objects are ParamValueType

setInitParam

ParamValueType setInitParam(int idx,
                            ParamValueType value)

Parameters:

value - allowed object is ParamValueType

getLoadOnStartup

String getLoadOnStartup()

Gets the value of the loadOnStartup property.

Returns:

possible object is String

setLoadOnStartup

void setLoadOnStartup(String value)

Sets the value of the loadOnStartup property.

Parameters:

value - allowed object is String

getRunAs

RunAsType getRunAs()

Gets the value of the runAs property.

Returns:

possible object is RunAsType

setRunAs

void setRunAs(RunAsType value)

Sets the value of the runAs property.

Parameters:

value - allowed object is RunAsType

getSecurityRoleRef

SecurityRoleRefType[] getSecurityRoleRef()

Returns:

array of SecurityRoleRefType

getSecurityRoleRef

SecurityRoleRefType getSecurityRoleRef(int idx)

Returns:

one of SecurityRoleRefType

getSecurityRoleRefLength

int getSecurityRoleRefLength()

setSecurityRoleRef

void setSecurityRoleRef(SecurityRoleRefType[] values)

Parameters:

values - allowed objects are SecurityRoleRefType

setSecurityRoleRef

SecurityRoleRefType setSecurityRoleRef(int idx,
                                       SecurityRoleRefType value)

Parameters:

value - allowed object is SecurityRoleRefType

getId

String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String