org.netbeans.modules.j2ee.dd.api.web
Interface Servlet

All Superinterfaces:

CommonDDBean, ComponentInterface, CreateCapability, DescriptionInterface, DisplayNameInterface, FindCapability, IconInterface

public interface Servlet
extends ComponentInterface

Generated interface for Servlet element.

Important note: Do not provide an implementation of this interface unless you are a DD API provider!

Method Summary

int	addInitParam(InitParam valueInterface) Adds init-param element.
int	addSecurityRoleRef(SecurityRoleRef valueInterface) Adds security-role-ref element.
InitParam[]	getInitParam() Getter for init-param elements.
InitParam	getInitParam(int index) Getter for init-param element.
String	getJspFile() Getter for jsp-file property.
BigInteger	getLoadOnStartup() Getter for load-on-startup property.
RunAs	getRunAs() Getter for run-as element.
SecurityRoleRef[]	getSecurityRoleRef() Getter for security-role-ref elements.
SecurityRoleRef	getSecurityRoleRef(int index) Getter for security-role-ref element.
String	getServletClass() Getter for servlet-class property.
String	getServletName() Getter for servlet-name property.
int	removeInitParam(InitParam valueInterface) Removes init-param element.
int	removeSecurityRoleRef(SecurityRoleRef valueInterface) Removes security-role-ref element.
void	setInitParam(InitParam[] value) Setter for init-param elements.
void	setInitParam(int index, InitParam valueInterface) Setter for init-param element.
void	setJspFile(String value) Setter for jsp-file property.
void	setLoadOnStartup(BigInteger value) Setter for load-on-startup property.
void	setRunAs(RunAs valueInterface) Setter for run-as element.
void	setSecurityRoleRef(int index, SecurityRoleRef valueInterface) Setter for security-role-ref element.
void	setSecurityRoleRef(SecurityRoleRef[] value) Setter for security-role-ref elements.
void	setServletClass(String value) Setter for servlet-class property.
void	setServletName(String value) Setter for servlet-name property.
int	sizeInitParam() Returns size of init-param elements.
int	sizeSecurityRoleRef() Returns size of security-role-ref elements.

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.CommonDDBean

addPropertyChangeListener, clone, getId, getValue, removePropertyChangeListener, setId, write

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.DescriptionInterface

getAllDescriptions, getDefaultDescription, getDescription, removeAllDescriptions, removeDescription, removeDescriptionForLocale, setAllDescriptions, setDescription, setDescription

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.DisplayNameInterface

getAllDisplayNames, getDefaultDisplayName, getDisplayName, removeAllDisplayNames, removeDisplayName, removeDisplayNameForLocale, setAllDisplayNames, setDisplayName, setDisplayName

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.CreateCapability

addBean, addBean, createBean

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.FindCapability

findBeanByName

Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.IconInterface

getAllIcons, getDefaultIcon, getLargeIcon, getLargeIcon, getSmallIcon, getSmallIcon, removeAllIcons, removeIcon, removeIcon, removeLargeIcon, removeLargeIcon, removeSmallIcon, removeSmallIcon, setAllIcons, setIcon, setLargeIcon, setLargeIcon, setSmallIcon, setSmallIcon

Method Detail

setServletName

void setServletName(String value)

Setter for servlet-name property.

Parameters:

value - property value

getServletName

String getServletName()

Getter for servlet-name property.

Returns:

property value

setServletClass

void setServletClass(String value)

Setter for servlet-class property.

Parameters:

value - property value

getServletClass

String getServletClass()

Getter for servlet-class property.

Returns:

property value

setJspFile

void setJspFile(String value)

Setter for jsp-file property.

Parameters:

value - property value

getJspFile

String getJspFile()

Getter for jsp-file property.

Returns:

property value

setInitParam

void setInitParam(int index,
                  InitParam valueInterface)

Setter for init-param element.

Parameters:

index - position in the array of elements

valueInterface - init-param element (InitParam object)

getInitParam

InitParam getInitParam(int index)

Getter for init-param element.

Parameters:

index - position in the array of elements

Returns:

init-param element (InitParam object)

setInitParam

void setInitParam(InitParam[] value)

Setter for init-param elements.

Parameters:

value - array of init-param elements (InitParam objects)

getInitParam

InitParam[] getInitParam()

Getter for init-param elements.

Returns:

array of init-param elements (InitParam objects)

sizeInitParam

int sizeInitParam()

Returns size of init-param elements.

Returns:

number of init-param elements

addInitParam

int addInitParam(InitParam valueInterface)

Adds init-param element.

Parameters:

valueInterface - init-param element (InitParam object)

Returns:

index of new init-param

removeInitParam

int removeInitParam(InitParam valueInterface)

Removes init-param element.

Parameters:

valueInterface - init-param element (InitParam object)

Returns:

index of the removed init-param

setLoadOnStartup

void setLoadOnStartup(BigInteger value)

Setter for load-on-startup property.

Parameters:

value - property value

getLoadOnStartup

BigInteger getLoadOnStartup()

Getter for load-on-startup property.

Returns:

property value

setRunAs

void setRunAs(RunAs valueInterface)

Setter for run-as element.

Parameters:

valueInterface - run-as element (RunAs object)

getRunAs

RunAs getRunAs()

Getter for run-as element.

Returns:

run-as element (RunAs object)

setSecurityRoleRef

void setSecurityRoleRef(int index,
                        SecurityRoleRef valueInterface)

Setter for security-role-ref element.

Parameters:

index - position in the array of elements

valueInterface - security-role-ref element (SecurityRoleRef object)

getSecurityRoleRef

SecurityRoleRef getSecurityRoleRef(int index)

Getter for security-role-ref element.

Parameters:

index - position in the array of elements

Returns:

security-role-ref element (SecurityRoleRef object)

setSecurityRoleRef

void setSecurityRoleRef(SecurityRoleRef[] value)

Setter for security-role-ref elements.

Parameters:

value - array of security-role-ref elements (SecurityRoleRef objects)

getSecurityRoleRef

SecurityRoleRef[] getSecurityRoleRef()

Getter for security-role-ref elements.

Returns:

array of security-role-ref elements (SecurityRoleRef objects)

sizeSecurityRoleRef

int sizeSecurityRoleRef()

Returns size of security-role-ref elements.

Returns:

number of security-role-ref elements

addSecurityRoleRef

int addSecurityRoleRef(SecurityRoleRef valueInterface)

Adds security-role-ref element.

Parameters:

valueInterface - security-role-ref element (SecurityRoleRef object)

Returns:

index of new security-role-ref

removeSecurityRoleRef

int removeSecurityRoleRef(SecurityRoleRef valueInterface)

Removes security-role-ref element.

Parameters:

valueInterface - security-role-ref element (SecurityRoleRef object)

Returns:

index of the removed security-role-ref