1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5 <!-- Generated by javadoc on Mon Jun 09 15:53:36 PDT 2003 -->
7 PTSEntry (Java AFS API)
9 <META NAME="keywords" CONTENT="org.openafs.jafs.PTSEntry,PTSEntry interface">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="PTSEntry (Java AFS API)";
18 <BODY BGCOLOR="white" onload="asd();">
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
29 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
30 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PTSEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 PREV CLASS
46 NEXT CLASS</FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
49 <A HREF="PTSEntry.html" TARGET="_top"><B>NO FRAMES</B></A>
54 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
70 <!-- =========== END OF NAVBAR =========== -->
73 <!-- ======== START OF CLASS DATA ======== -->
76 org.openafs.jafs</FONT>
78 Interface PTSEntry</H2>
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>
84 <DT>public interface <B>PTSEntry</B></DL>
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.
95 <DT><B>Version:</B></DT>
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>
102 <!-- ======== NESTED CLASS SUMMARY ======== -->
105 <!-- =========== FIELD SUMMARY =========== -->
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>
113 <TR BGCOLOR="white" CLASS="TableRowColor">
114 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115 <CODE>static short</CODE></FONT></TD>
116 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_GROUP">PTS_GROUP</A></B></CODE>
119 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>
122 <TR BGCOLOR="white" CLASS="TableRowColor">
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124 <CODE>static short</CODE></FONT></TD>
125 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#PTS_USER">PTS_USER</A></B></CODE>
128 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>
133 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
136 <!-- ========== METHOD SUMMARY =========== -->
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>
144 <TR BGCOLOR="white" CLASS="TableRowColor">
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146 <CODE> <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>
150 Returns the Cell this PTS user or group belongs to.</TD>
152 <TR BGCOLOR="white" CLASS="TableRowColor">
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154 <CODE> <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>
158 Returns the creator of this PTS user or group.</TD>
160 <TR BGCOLOR="white" CLASS="TableRowColor">
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162 <CODE> <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>
166 Returns the name of this PTS user or group.</TD>
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170 <CODE> <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>
174 Returns the owner of this PTS user or group.</TD>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178 <CODE> short</CODE></FONT></TD>
179 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getType()">getType</A></B>()</CODE>
182 Returns the type of PTS entry the implementing object represents.
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE> int</CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/openafs/jafs/PTSEntry.html#getUID()">getUID</A></B>()</CODE>
192 Returns the numeric AFS id of this user or group.</TD>
198 <!-- ============ FIELD DETAIL =========== -->
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>
208 <A NAME="PTS_USER"><!-- --></A><H3>
211 public static final short <B>PTS_USER</B></PRE>
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>
217 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.PTSEntry.PTS_USER">Constant Field Values</A></DL>
221 <A NAME="PTS_GROUP"><!-- --></A><H3>
224 public static final short <B>PTS_GROUP</B></PRE>
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>
230 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.PTSEntry.PTS_GROUP">Constant Field Values</A></DL>
233 <!-- ========= CONSTRUCTOR DETAIL ======== -->
236 <!-- ============ METHOD DETAIL ========== -->
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>
246 <A NAME="getCell()"><!-- --></A><H3>
249 public <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>getCell</B>()</PRE>
251 <DD>Returns the Cell this PTS user or group belongs to.
255 <DT><B>Returns:</B><DD>the Cell this PTS user or group belongs to</DL>
260 <A NAME="getCreator()"><!-- --></A><H3>
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>
266 <DD>Returns the creator of this PTS user or group.
270 <DT><B>Returns:</B><DD>the creator of this PTS user or group
272 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
277 <A NAME="getName()"><!-- --></A><H3>
280 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
282 <DD>Returns the name of this PTS user or group.
286 <DT><B>Returns:</B><DD>the name of this PTS user or group</DL>
291 <A NAME="getOwner()"><!-- --></A><H3>
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>
297 <DD>Returns the owner of this PTS user or group.
301 <DT><B>Returns:</B><DD>the owner of this PTS user or group
303 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
308 <A NAME="getType()"><!-- --></A><H3>
311 public short <B>getType</B>()</PRE>
313 <DD>Returns the type of PTS entry the implementing object represents.
315 <P>Possible values are:<BR>
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>
325 <DT><B>Returns:</B><DD>the name of this PTS user or group</DL>
330 <A NAME="getUID()"><!-- --></A><H3>
333 public int <B>getUID</B>()
334 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
336 <DD>Returns the numeric AFS id of this user or group.
340 <DT><B>Returns:</B><DD>the AFS id of this user/group
342 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
345 <!-- ========= END OF CLASS DATA ========= -->
348 <!-- ========== START OF NAVBAR ========== -->
349 <A NAME="navbar_bottom"><!-- --></A>
350 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
357 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
358 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PTSEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
359 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
360 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
362 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
366 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
367 <B>JAFS API v2</B></EM>
372 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
373 PREV CLASS
374 NEXT CLASS</FONT></TD>
375 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
376 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
377 <A HREF="PTSEntry.html" TARGET="_top"><B>NO FRAMES</B></A>
382 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
387 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
392 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
393 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
394 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
395 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
398 <!-- =========== END OF NAVBAR =========== -->