Minor grammar fixes
[openafs-wiki.git] / archive / JavaAdminAPI / PTSEntry.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:36 PDT 2003 -->
6 <TITLE>
7 PTSEntry (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.PTSEntry,PTSEntry interface">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="PTSEntry (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PTSEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;PREV CLASS&nbsp;
46 &nbsp;NEXT CLASS</FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 &nbsp;<A HREF="PTSEntry.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Interface PTSEntry</H2>
79 <DL>
80 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/openafs/jafs/Group.html">Group</A>, <A HREF="../../../org/openafs/jafs/User.html">User</A></DD>
81 </DL>
82 <HR>
83 <DL>
84 <DT>public interface <B>PTSEntry</B></DL>
85
86 <P>
87 An interface representation of a PTS entry as it applies to
88  AFS users and groups.  This interface is implemented in both
89  <A HREF="../../../org/openafs/jafs/User.html"><CODE>User</CODE></A> and <A HREF="../../../org/openafs/jafs/Group.html"><CODE>Group</CODE></A> object abstractions.
90  <BR><BR>
91 <P>
92
93 <P>
94 <DL>
95 <DT><B>Version:</B></DT>
96   <DD>1.0, 3/31/02</DD>
97 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/User.html"><CODE>User</CODE></A>, 
98 <A HREF="../../../org/openafs/jafs/Group.html"><CODE>Group</CODE></A></DL>
99 <HR>
100
101 <P>
102 <!-- ======== NESTED CLASS SUMMARY ======== -->
103
104
105 <!-- =========== FIELD SUMMARY =========== -->
106
107 <A NAME="field_summary"><!-- --></A>
108 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
109 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
110 <TD COLSPAN=2><FONT SIZE="+2">
111 <B>Field Summary</B></FONT></TD>
112 </TR>
113 <TR BGCOLOR="white" CLASS="TableRowColor">
114 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115 <CODE>static&nbsp;short</CODE></FONT></TD>
116 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_GROUP">PTS_GROUP</A></B></CODE>
117
118 <BR>
119 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for <A HREF="../../../org/openafs/jafs/Group.html"><CODE>Group</CODE></A> object implementers,
120  used with <A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()"><CODE>getType()</CODE></A></TD>
121 </TR>
122 <TR BGCOLOR="white" CLASS="TableRowColor">
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124 <CODE>static&nbsp;short</CODE></FONT></TD>
125 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_USER">PTS_USER</A></B></CODE>
126
127 <BR>
128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant for <A HREF="../../../org/openafs/jafs/User.html"><CODE>User</CODE></A> object implementers, 
129  used with <A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()"><CODE>getType()</CODE></A></TD>
130 </TR>
131 </TABLE>
132 &nbsp;
133 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
134
135
136 <!-- ========== METHOD SUMMARY =========== -->
137
138 <A NAME="method_summary"><!-- --></A>
139 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141 <TD COLSPAN=2><FONT SIZE="+2">
142 <B>Method Summary</B></FONT></TD>
143 </TR>
144 <TR BGCOLOR="white" CLASS="TableRowColor">
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A></CODE></FONT></TD>
147 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getCell()">getCell</A></B>()</CODE>
148
149 <BR>
150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Cell this PTS user or group belongs to.</TD>
151 </TR>
152 <TR BGCOLOR="white" CLASS="TableRowColor">
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/PTSEntry.html">PTSEntry</A></CODE></FONT></TD>
155 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getCreator()">getCreator</A></B>()</CODE>
156
157 <BR>
158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the creator of this PTS user or group.</TD>
159 </TR>
160 <TR BGCOLOR="white" CLASS="TableRowColor">
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
163 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getName()">getName</A></B>()</CODE>
164
165 <BR>
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this PTS user or group.</TD>
167 </TR>
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/PTSEntry.html">PTSEntry</A></CODE></FONT></TD>
171 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getOwner()">getOwner</A></B>()</CODE>
172
173 <BR>
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the owner of this PTS user or group.</TD>
175 </TR>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178 <CODE>&nbsp;short</CODE></FONT></TD>
179 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()">getType</A></B>()</CODE>
180
181 <BR>
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the type of PTS entry the implementing object represents.
183  
184  </TD>
185 </TR>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE>&nbsp;int</CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getUID()">getUID</A></B>()</CODE>
190
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the numeric AFS id of this user or group.</TD>
193 </TR>
194 </TABLE>
195 &nbsp;
196 <P>
197
198 <!-- ============ FIELD DETAIL =========== -->
199
200 <A NAME="field_detail"><!-- --></A>
201 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203 <TD COLSPAN=1><FONT SIZE="+2">
204 <B>Field Detail</B></FONT></TD>
205 </TR>
206 </TABLE>
207
208 <A NAME="PTS_USER"><!-- --></A><H3>
209 PTS_USER</H3>
210 <PRE>
211 public static final short <B>PTS_USER</B></PRE>
212 <DL>
213 <DD>Constant for <A HREF="../../../org/openafs/jafs/User.html"><CODE>User</CODE></A> object implementers, 
214  used with <A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()"><CODE>getType()</CODE></A>
215 <P>
216 <DL>
217 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.PTSEntry.PTS_USER">Constant Field Values</A></DL>
218 </DL>
219 <HR>
220
221 <A NAME="PTS_GROUP"><!-- --></A><H3>
222 PTS_GROUP</H3>
223 <PRE>
224 public static final short <B>PTS_GROUP</B></PRE>
225 <DL>
226 <DD>Constant for <A HREF="../../../org/openafs/jafs/Group.html"><CODE>Group</CODE></A> object implementers,
227  used with <A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()"><CODE>getType()</CODE></A>
228 <P>
229 <DL>
230 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.PTSEntry.PTS_GROUP">Constant Field Values</A></DL>
231 </DL>
232
233 <!-- ========= CONSTRUCTOR DETAIL ======== -->
234
235
236 <!-- ============ METHOD DETAIL ========== -->
237
238 <A NAME="method_detail"><!-- --></A>
239 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
240 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
241 <TD COLSPAN=1><FONT SIZE="+2">
242 <B>Method Detail</B></FONT></TD>
243 </TR>
244 </TABLE>
245
246 <A NAME="getCell()"><!-- --></A><H3>
247 getCell</H3>
248 <PRE>
249 public <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>getCell</B>()</PRE>
250 <DL>
251 <DD>Returns the Cell this PTS user or group belongs to.
252 <P>
253 <DD><DL>
254
255 <DT><B>Returns:</B><DD>the Cell this PTS user or group belongs to</DL>
256 </DD>
257 </DL>
258 <HR>
259
260 <A NAME="getCreator()"><!-- --></A><H3>
261 getCreator</H3>
262 <PRE>
263 public <A HREF="../../../org/openafs/jafs/PTSEntry.html">PTSEntry</A> <B>getCreator</B>()
264                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
265 <DL>
266 <DD>Returns the creator of this PTS user or group.
267 <P>
268 <DD><DL>
269
270 <DT><B>Returns:</B><DD>the creator of this PTS user or group
271 <DT><B>Throws:</B>
272 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
273 </DD>
274 </DL>
275 <HR>
276
277 <A NAME="getName()"><!-- --></A><H3>
278 getName</H3>
279 <PRE>
280 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
281 <DL>
282 <DD>Returns the name of this PTS user or group.
283 <P>
284 <DD><DL>
285
286 <DT><B>Returns:</B><DD>the name of this PTS user or group</DL>
287 </DD>
288 </DL>
289 <HR>
290
291 <A NAME="getOwner()"><!-- --></A><H3>
292 getOwner</H3>
293 <PRE>
294 public <A HREF="../../../org/openafs/jafs/PTSEntry.html">PTSEntry</A> <B>getOwner</B>()
295                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
296 <DL>
297 <DD>Returns the owner of this PTS user or group.
298 <P>
299 <DD><DL>
300
301 <DT><B>Returns:</B><DD>the owner of this PTS user or group
302 <DT><B>Throws:</B>
303 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
304 </DD>
305 </DL>
306 <HR>
307
308 <A NAME="getType()"><!-- --></A><H3>
309 getType</H3>
310 <PRE>
311 public short <B>getType</B>()</PRE>
312 <DL>
313 <DD>Returns the type of PTS entry the implementing object represents.
314  
315  <P>Possible values are:<BR>
316  <ul>
317  <li><code><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_USER"><CODE>PTS_USER</CODE></A></code> 
318            -- a <A HREF="../../../org/openafs/jafs/User.html"><CODE>User</CODE></A> object</li>
319  <li><code><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_GROUP"><CODE>PTS_GROUP</CODE></A></code> 
320            -- a <A HREF="../../../org/openafs/jafs/Group.html"><CODE>Group</CODE></A> object</li>
321  </ul>
322 <P>
323 <DD><DL>
324
325 <DT><B>Returns:</B><DD>the name of this PTS user or group</DL>
326 </DD>
327 </DL>
328 <HR>
329
330 <A NAME="getUID()"><!-- --></A><H3>
331 getUID</H3>
332 <PRE>
333 public int <B>getUID</B>()
334            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
335 <DL>
336 <DD>Returns the numeric AFS id of this user or group.
337 <P>
338 <DD><DL>
339
340 <DT><B>Returns:</B><DD>the AFS id of this user/group
341 <DT><B>Throws:</B>
342 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
343 </DD>
344 </DL>
345 <!-- ========= END OF CLASS DATA ========= -->
346 <HR>
347
348 <!-- ========== START OF NAVBAR ========== -->
349 <A NAME="navbar_bottom"><!-- --></A>
350 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
351 <TR>
352 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
353 <A NAME="navbar_bottom_firstrow"><!-- --></A>
354 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
355   <TR ALIGN="center" VALIGN="top">
356   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
357   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
358   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PTSEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
359   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
360   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
361   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
362   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
363   </TR>
364 </TABLE>
365 </TD>
366 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
367 <B>JAFS API v2</B></EM>
368 </TD>
369 </TR>
370
371 <TR>
372 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
373 &nbsp;PREV CLASS&nbsp;
374 &nbsp;NEXT CLASS</FONT></TD>
375 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
376   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
377 &nbsp;<A HREF="PTSEntry.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
378 &nbsp;
379 <SCRIPT>
380   <!--
381   if(window==top) {
382     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
383   }
384   //-->
385 </SCRIPT>
386 <NOSCRIPT>
387 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
388 </NOSCRIPT>
389 </FONT></TD>
390 </TR>
391 <TR>
392 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
393   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
394 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
395 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
396 </TR>
397 </TABLE>
398 <!-- =========== END OF NAVBAR =========== -->
399
400 <HR>
401
402 </BODY>
403 </HTML>