KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > dd > api > web > Servlet


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.modules.j2ee.dd.api.web;
21 /**
22  * Generated interface for Servlet element.
23  *
24  *<p><b><font color="red"><em>Important note: Do not provide an implementation of this interface unless you are a DD API provider!</em></font></b>
25  *</p>
26  */

27
28 public interface Servlet extends org.netbeans.modules.j2ee.dd.api.common.ComponentInterface {
29         /** Setter for servlet-name property.
30          * @param value property value
31          */

32     public void setServletName(java.lang.String JavaDoc value);
33         /** Getter for servlet-name property.
34          * @return property value
35          */

36     public java.lang.String JavaDoc getServletName();
37         /** Setter for servlet-class property.
38          * @param value property value
39          */

40     public void setServletClass(java.lang.String JavaDoc value);
41         /** Getter for servlet-class property.
42          * @return property value
43          */

44     public java.lang.String JavaDoc getServletClass();
45         /** Setter for jsp-file property.
46          * @param value property value
47          */

48     public void setJspFile(java.lang.String JavaDoc value);
49         /** Getter for jsp-file property.
50          * @return property value
51          */

52     public java.lang.String JavaDoc getJspFile();
53         /** Setter for init-param element.
54          * @param index position in the array of elements
55          * @param valueInterface init-param element (InitParam object)
56          */

57     public void setInitParam(int index, org.netbeans.modules.j2ee.dd.api.common.InitParam valueInterface);
58         /** Getter for init-param element.
59          * @param index position in the array of elements
60          * @return init-param element (InitParam object)
61          */

62     public org.netbeans.modules.j2ee.dd.api.common.InitParam getInitParam(int index);
63         /** Setter for init-param elements.
64          * @param value array of init-param elements (InitParam objects)
65          */

66     public void setInitParam(org.netbeans.modules.j2ee.dd.api.common.InitParam[] value);
67         /** Getter for init-param elements.
68          * @return array of init-param elements (InitParam objects)
69          */

70     public org.netbeans.modules.j2ee.dd.api.common.InitParam[] getInitParam();
71         /** Returns size of init-param elements.
72          * @return number of init-param elements
73          */

74     public int sizeInitParam();
75         /** Adds init-param element.
76          * @param valueInterface init-param element (InitParam object)
77          * @return index of new init-param
78          */

79     public int addInitParam(org.netbeans.modules.j2ee.dd.api.common.InitParam valueInterface);
80         /** Removes init-param element.
81          * @param valueInterface init-param element (InitParam object)
82          * @return index of the removed init-param
83          */

84     public int removeInitParam(org.netbeans.modules.j2ee.dd.api.common.InitParam valueInterface);
85         /** Setter for load-on-startup property.
86          * @param value property value
87          */

88     public void setLoadOnStartup(java.math.BigInteger JavaDoc value);
89         /** Getter for load-on-startup property.
90          * @return property value
91          */

92     public java.math.BigInteger JavaDoc getLoadOnStartup();
93         /** Setter for run-as element.
94          * @param valueInterface run-as element (RunAs object)
95          */

96     public void setRunAs(org.netbeans.modules.j2ee.dd.api.common.RunAs valueInterface);
97         /** Getter for run-as element.
98          * @return run-as element (RunAs object)
99          */

100     public org.netbeans.modules.j2ee.dd.api.common.RunAs getRunAs();
101         /** Setter for security-role-ref element.
102          * @param index position in the array of elements
103          * @param valueInterface security-role-ref element (SecurityRoleRef object)
104          */

105     public void setSecurityRoleRef(int index, org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef valueInterface);
106         /** Getter for security-role-ref element.
107          * @param index position in the array of elements
108          * @return security-role-ref element (SecurityRoleRef object)
109          */

110     public org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef getSecurityRoleRef(int index);
111         /** Setter for security-role-ref elements.
112          * @param value array of security-role-ref elements (SecurityRoleRef objects)
113          */

114     public void setSecurityRoleRef(org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef[] value);
115         /** Getter for security-role-ref elements.
116          * @return array of security-role-ref elements (SecurityRoleRef objects)
117          */

118     public org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef[] getSecurityRoleRef();
119         /** Returns size of security-role-ref elements.
120          * @return number of security-role-ref elements
121          */

122     public int sizeSecurityRoleRef();
123         /** Adds security-role-ref element.
124          * @param valueInterface security-role-ref element (SecurityRoleRef object)
125          * @return index of new security-role-ref
126          */

127     public int addSecurityRoleRef(org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef valueInterface);
128         /** Removes security-role-ref element.
129          * @param valueInterface security-role-ref element (SecurityRoleRef object)
130          * @return index of the removed security-role-ref
131          */

132     public int removeSecurityRoleRef(org.netbeans.modules.j2ee.dd.api.common.SecurityRoleRef valueInterface);
133
134 }
135
Popular Tags