org.eclipse.modisco.jee.webapp.webapp25
Interface ServletType


public interface ServletType

A representation of the model object ' Servlet Type'. 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

The following features are supported:

See Also:
Webapp25Package.getServletType()
Generated:
Model:
extendedMetaData="name='servletType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
  getDisplayName()
          Returns the value of the 'Display Name' containment reference list.
  getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getInitParam()
          Returns the value of the 'Init Param' containment reference list.
 JspFileType getJspFile()
          Returns the value of the 'Jsp File' containment reference.
 java.lang.Object getLoadOnStartup()
          Returns the value of the 'Load On Startup' attribute.
 RunAsType getRunAs()
          Returns the value of the 'Run As' containment reference.
  getSecurityRoleRef()
          Returns the value of the 'Security Role Ref' containment reference list.
 FullyQualifiedClassType getServletClass()
          Returns the value of the 'Servlet Class' containment reference.
 ServletNameType getServletName()
          Returns the value of the 'Servlet Name' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setJspFile(JspFileType value)
          Sets the value of the 'Jsp File' containment reference.
 void setLoadOnStartup(java.lang.Object value)
          Sets the value of the 'Load On Startup' attribute.
 void setRunAs(RunAsType value)
          Sets the value of the 'Run As' containment reference.
 void setServletClass(FullyQualifiedClassType value)
          Sets the value of the 'Servlet Class' containment reference.
 void setServletName(ServletNameType value)
          Sets the value of the 'Servlet Name' containment reference.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
Webapp25Package.getServletType_Description()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='description' namespace='##targetNamespace'"

getDisplayName

 getDisplayName()
Returns the value of the 'Display Name' containment reference list. The list contents are of type DisplayNameType.

If the meaning of the 'Display Name' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Display Name' containment reference list.
See Also:
Webapp25Package.getServletType_DisplayName()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='display-name' namespace='##targetNamespace'"

getIcon

 getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType.

If the meaning of the 'Icon' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Icon' containment reference list.
See Also:
Webapp25Package.getServletType_Icon()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='icon' namespace='##targetNamespace'"

getServletName

ServletNameType getServletName()
Returns the value of the 'Servlet Name' containment reference.

If the meaning of the 'Servlet Name' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Servlet Name' containment reference.
See Also:
setServletName(ServletNameType), Webapp25Package.getServletType_ServletName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='servlet-name' namespace='http://java.sun.com/xml/ns/javaee'"

setServletName

void setServletName(ServletNameType value)
Sets the value of the 'Servlet Name' containment reference.

Parameters:
value - the new value of the 'Servlet Name' containment reference.
See Also:
getServletName()
Generated:

getServletClass

FullyQualifiedClassType getServletClass()
Returns the value of the 'Servlet Class' containment reference. The servlet-class element contains the fully qualified class name of the servlet.

Returns:
the value of the 'Servlet Class' containment reference.
See Also:
setServletClass(FullyQualifiedClassType), Webapp25Package.getServletType_ServletClass()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='servlet-class' namespace='##targetNamespace'"

setServletClass

void setServletClass(FullyQualifiedClassType value)
Sets the value of the 'Servlet Class' containment reference.

Parameters:
value - the new value of the 'Servlet Class' containment reference.
See Also:
getServletClass()
Generated:

getJspFile

JspFileType getJspFile()
Returns the value of the 'Jsp File' containment reference.

If the meaning of the 'Jsp File' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Jsp File' containment reference.
See Also:
setJspFile(JspFileType), Webapp25Package.getServletType_JspFile()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='jsp-file' namespace='http://java.sun.com/xml/ns/javaee'"

setJspFile

void setJspFile(JspFileType value)
Sets the value of the 'Jsp File' containment reference.

Parameters:
value - the new value of the 'Jsp File' containment reference.
See Also:
getJspFile()
Generated:

getInitParam

 getInitParam()
Returns the value of the 'Init Param' containment reference list. The list contents are of type ParamValueType.

If the meaning of the 'Init Param' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Init Param' containment reference list.
See Also:
Webapp25Package.getServletType_InitParam()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='init-param' namespace='##targetNamespace'"

getLoadOnStartup

java.lang.Object getLoadOnStartup()
Returns the value of the 'Load On Startup' attribute. The load-on-startup element indicates that this servlet should be loaded (instantiated and have its init() called) on the startup of the web application. The optional contents of these element must be an integer indicating the order in which the servlet should be loaded. If the value is a negative integer, or the element is not present, the container is free to load the servlet whenever it chooses. If the value is a positive integer or 0, the container must load and initialize the servlet as the application is deployed. The container must guarantee that servlets marked with lower integers are loaded before servlets marked with higher integers. The container may choose the order of loading of servlets with the same load-on-start-up value.

Returns:
the value of the 'Load On Startup' attribute.
See Also:
setLoadOnStartup(Object), Webapp25Package.getServletType_LoadOnStartup()
Generated:
Model:
dataType="org.eclipse.modisco.jee.webapp.webapp25.LoadOnStartupType" extendedMetaData= "kind='element' name='load-on-startup' namespace='##targetNamespace'"

setLoadOnStartup

void setLoadOnStartup(java.lang.Object value)
Sets the value of the 'Load On Startup' attribute.

Parameters:
value - the new value of the 'Load On Startup' attribute.
See Also:
getLoadOnStartup()
Generated:

getRunAs

RunAsType getRunAs()
Returns the value of the 'Run As' containment reference.

If the meaning of the 'Run As' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Run As' containment reference.
See Also:
setRunAs(RunAsType), Webapp25Package.getServletType_RunAs()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='run-as' namespace='http://java.sun.com/xml/ns/javaee'"

setRunAs

void setRunAs(RunAsType value)
Sets the value of the 'Run As' containment reference.

Parameters:
value - the new value of the 'Run As' containment reference.
See Also:
getRunAs()
Generated:

getSecurityRoleRef

 getSecurityRoleRef()
Returns the value of the 'Security Role Ref' containment reference list. The list contents are of type SecurityRoleRefType.

If the meaning of the 'Security Role Ref' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Security Role Ref' containment reference list.
See Also:
Webapp25Package.getServletType_SecurityRoleRef()
Generated:
Model:
containment="true" extendedMetaData= "kind='element' name='security-role-ref' namespace='##targetNamespace'"

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp25Package.getServletType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: