Load cups into easysw/current.
[thirdparty/cups.git] / scripting / java / docs / com / easysw / cups / IPPRequest.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Tue Feb 11 14:29:07 PST 2003 -->
6 <TITLE>
7 : Class  IPPRequest
8 </TITLE>
9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
10 </HEAD>
11 <BODY BGCOLOR="white">
12
13 <!-- ========== START OF NAVBAR ========== -->
14 <A NAME="navbar_top"><!-- --></A>
15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
16 <TR>
17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18 <A NAME="navbar_top_firstrow"><!-- --></A>
19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
20   <TR ALIGN="center" VALIGN="top">
21   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
22   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
23   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
24   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
25   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
26   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
27   </TR>
28 </TABLE>
29 </TD>
30 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
31 </EM>
32 </TD>
33 </TR>
34
35 <TR>
36 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
37 &nbsp;<A HREF="../../../com/easysw/cups/IPPMD5.html"><B>PREV CLASS</B></A>&nbsp;
38 &nbsp;<A HREF="../../../com/easysw/cups/IPPStatus.html"><B>NEXT CLASS</B></A></FONT></TD>
39 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
40   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
41 &nbsp;<A HREF="IPPRequest.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
42 </TR>
43 <TR>
44 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
45   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
46 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
47 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
48 </TR>
49 </TABLE>
50 <!-- =========== END OF NAVBAR =========== -->
51
52 <HR>
53 <!-- ======== START OF CLASS DATA ======== -->
54 <H2>
55 <FONT SIZE="-1">
56 com.easysw.cups</FONT>
57 <BR>
58 Class  IPPRequest</H2>
59 <PRE>
60 java.lang.Object
61   |
62   +--<B>com.easysw.cups.IPPRequest</B>
63 </PRE>
64 <HR>
65 <DL>
66 <DT>public class <B>IPPRequest</B><DT>extends java.lang.Object</DL>
67
68 <P>
69 An <code>IPPRequest</code> object is used to hold the 
70  status and id's of a request.
71 <P>
72 <DL>
73 <DT><B>Since: </B><DD>JDK1.3</DD>
74 </DL>
75 <HR>
76
77 <P>
78 <!-- ======== INNER CLASS SUMMARY ======== -->
79
80
81 <!-- =========== FIELD SUMMARY =========== -->
82
83
84 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
85
86 <A NAME="constructor_summary"><!-- --></A>
87 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
88 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
89 <TD COLSPAN=2><FONT SIZE="+2">
90 <B>Constructor Summary</B></FONT></TD>
91 </TR>
92 <TR BGCOLOR="white" CLASS="TableRowColor">
93 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPRequest.html#IPPRequest()">IPPRequest</A></B>()</CODE>
94
95 <BR>
96 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor</TD>
97 </TR>
98 <TR BGCOLOR="white" CLASS="TableRowColor">
99 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPRequest.html#IPPRequest(int, short)">IPPRequest</A></B>(int&nbsp;p_request_id,
100            short&nbsp;p_operation_id)</CODE>
101
102 <BR>
103 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor using request id and operation id.</TD>
104 </TR>
105 </TABLE>
106 &nbsp;
107 <!-- ========== METHOD SUMMARY =========== -->
108
109 <A NAME="method_summary"><!-- --></A>
110 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112 <TD COLSPAN=2><FONT SIZE="+2">
113 <B>Method Summary</B></FONT></TD>
114 </TR>
115 <TR BGCOLOR="white" CLASS="TableRowColor">
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117 <CODE>&nbsp;void</CODE></FONT></TD>
118 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPRequest.html#setOpStatus(short)">setOpStatus</A></B>(short&nbsp;p_status_code)</CODE>
119
120 <BR>
121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the operation status of a request.</TD>
122 </TR>
123 <TR BGCOLOR="white" CLASS="TableRowColor">
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125 <CODE>&nbsp;void</CODE></FONT></TD>
126 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPRequest.html#setStatus(short)">setStatus</A></B>(short&nbsp;p_status_code)</CODE>
127
128 <BR>
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current status of a request.</TD>
130 </TR>
131 </TABLE>
132 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
133 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
134 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
135 <TD><B>Methods inherited from class java.lang.Object</B></TD>
136 </TR>
137 <TR BGCOLOR="white" CLASS="TableRowColor">
138 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
139 </TR>
140 </TABLE>
141 &nbsp;
142 <P>
143
144 <!-- ============ FIELD DETAIL =========== -->
145
146
147 <!-- ========= CONSTRUCTOR DETAIL ======== -->
148
149 <A NAME="constructor_detail"><!-- --></A>
150 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152 <TD COLSPAN=1><FONT SIZE="+2">
153 <B>Constructor Detail</B></FONT></TD>
154 </TR>
155 </TABLE>
156
157 <A NAME="IPPRequest()"><!-- --></A><H3>
158 IPPRequest</H3>
159 <PRE>
160 public <B>IPPRequest</B>()</PRE>
161 <DL>
162 <DD>Constructor</DL>
163 <HR>
164
165 <A NAME="IPPRequest(int, short)"><!-- --></A><H3>
166 IPPRequest</H3>
167 <PRE>
168 public <B>IPPRequest</B>(int&nbsp;p_request_id,
169                   short&nbsp;p_operation_id)</PRE>
170 <DL>
171 <DD>Constructor using request id and operation id.<DD><DL>
172 <DT><B>Parameters:</B><DD><CODE><code>p_request_id</code></CODE> - ID of request.<DD><CODE><code>p_operation_id</code></CODE> - Operation ID for request.<DT><B>See Also: </B><DD><code>IPPDefs</code></DL>
173 </DD>
174 </DL>
175
176 <!-- ============ METHOD DETAIL ========== -->
177
178 <A NAME="method_detail"><!-- --></A>
179 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181 <TD COLSPAN=1><FONT SIZE="+2">
182 <B>Method Detail</B></FONT></TD>
183 </TR>
184 </TABLE>
185
186 <A NAME="setStatus(short)"><!-- --></A><H3>
187 setStatus</H3>
188 <PRE>
189 public void <B>setStatus</B>(short&nbsp;p_status_code)</PRE>
190 <DL>
191 <DD>Set the current status of a request.<DD><DL>
192 <DT><B>Parameters:</B><DD><CODE><code>p_status_code</code></CODE> - Status code.<DT><B>See Also: </B><DD><code>IPPDefs</code></DL>
193 </DD>
194 </DL>
195 <HR>
196
197 <A NAME="setOpStatus(short)"><!-- --></A><H3>
198 setOpStatus</H3>
199 <PRE>
200 public void <B>setOpStatus</B>(short&nbsp;p_status_code)</PRE>
201 <DL>
202 <DD>Set the operation status of a request.<DD><DL>
203 <DT><B>Parameters:</B><DD><CODE><code>p_status_code</code></CODE> - Operation status code.<DT><B>See Also: </B><DD><code>IPPDefs</code></DL>
204 </DD>
205 </DL>
206 <!-- ========= END OF CLASS DATA ========= -->
207 <HR>
208
209 <!-- ========== START OF NAVBAR ========== -->
210 <A NAME="navbar_bottom"><!-- --></A>
211 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
212 <TR>
213 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
214 <A NAME="navbar_bottom_firstrow"><!-- --></A>
215 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
216   <TR ALIGN="center" VALIGN="top">
217   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
218   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
219   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
220   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
221   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
223   </TR>
224 </TABLE>
225 </TD>
226 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
227 </EM>
228 </TD>
229 </TR>
230
231 <TR>
232 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
233 &nbsp;<A HREF="../../../com/easysw/cups/IPPMD5.html"><B>PREV CLASS</B></A>&nbsp;
234 &nbsp;<A HREF="../../../com/easysw/cups/IPPStatus.html"><B>NEXT CLASS</B></A></FONT></TD>
235 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
236   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
237 &nbsp;<A HREF="IPPRequest.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
238 </TR>
239 <TR>
240 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
241   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
242 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
243 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
244 </TR>
245 </TABLE>
246 <!-- =========== END OF NAVBAR =========== -->
247
248 <HR>
249
250 </BODY>
251 </HTML>