1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:00 IST 2011 -->
\r
10 <META NAME="keywords" CONTENT="com.pras.Collaborator class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="Collaborator";
\r
25 <BODY BGCOLOR="white" onload="windowTitle();">
\r
28 <!-- ========= START OF TOP NAVBAR ======= -->
\r
29 <A NAME="navbar_top"><!-- --></A>
\r
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
\r
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
34 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
36 <TR ALIGN="center" VALIGN="top">
\r
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Collaborator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 PREV CLASS
\r
56 <A HREF="../../com/pras/Log.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../index.html?com/pras/Collaborator.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="Collaborator.html" target="_top"><B>NO FRAMES</B></A>
\r
60 <SCRIPT type="text/javascript">
\r
63 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
68 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
76 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
81 <A NAME="skip-navbar_top"></A>
\r
82 <!-- ========= END OF TOP NAVBAR ========= -->
\r
85 <!-- ======== START OF CLASS DATA ======== -->
\r
90 Class Collaborator</H2>
\r
93 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>com.pras.Collaborator</B>
\r
97 <DT><PRE>public class <B>Collaborator</B><DT>extends java.lang.Object</DL>
\r
101 ACL details of a SpreadSheet
\r
106 <DT><B>Author:</B></DT>
\r
107 <DD>Prasanta Paul</DD>
\r
112 <!-- =========== FIELD SUMMARY =========== -->
\r
114 <A NAME="field_summary"><!-- --></A>
\r
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
118 <B>Field Summary</B></FONT></TH>
\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
121 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
122 <CODE>static java.lang.String</CODE></FONT></TD>
\r
123 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#ROLE_OWNER">ROLE_OWNER</A></B></CODE>
\r
126 Owner of a SpreadSheet</TD>
\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
130 <CODE>static java.lang.String</CODE></FONT></TD>
\r
131 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#ROLE_READER">ROLE_READER</A></B></CODE>
\r
134 Able to Read</TD>
\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
138 <CODE>static java.lang.String</CODE></FONT></TD>
\r
139 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#ROLE_WRITER">ROLE_WRITER</A></B></CODE>
\r
142 Able to Read/Write and Further Share as Reader/Writer</TD>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
146 <CODE>static java.lang.String</CODE></FONT></TD>
\r
147 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#SCOPE_DEFAULT">SCOPE_DEFAULT</A></B></CODE>
\r
150 Use this scope to make the SpreadSheet publicly accessible to anyuser</TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
154 <CODE>static java.lang.String</CODE></FONT></TD>
\r
155 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#SCOPE_DOMAIN">SCOPE_DOMAIN</A></B></CODE>
\r
158 Use this scope to share it with a Domain</TD>
\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
162 <CODE>static java.lang.String</CODE></FONT></TD>
\r
163 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#SCOPE_GROUP">SCOPE_GROUP</A></B></CODE>
\r
166 Use this scope to share it with a Group</TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE>static java.lang.String</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#SCOPE_USER">SCOPE_USER</A></B></CODE>
\r
174 Use this scope to share it with an Email account</TD>
\r
178 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
180 <A NAME="constructor_summary"><!-- --></A>
\r
181 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
182 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
183 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
184 <B>Constructor Summary</B></FONT></TH>
\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
187 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#Collaborator()">Collaborator</A></B>()</CODE>
\r
190 </TD>
\r
194 <!-- ========== METHOD SUMMARY =========== -->
\r
196 <A NAME="method_summary"><!-- --></A>
\r
197 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
198 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
199 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
200 <B>Method Summary</B></FONT></TH>
\r
202 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
204 <CODE> java.lang.String</CODE></FONT></TD>
\r
205 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#getEditLink()">getEditLink</A></B>()</CODE>
\r
208 Get Edit Link</TD>
\r
210 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
212 <CODE> java.lang.String</CODE></FONT></TD>
\r
213 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#getRole()">getRole</A></B>()</CODE>
\r
216 Get Role - {"owner", "writer", "reader"}</TD>
\r
218 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
220 <CODE> java.lang.String</CODE></FONT></TD>
\r
221 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#getScopeType()">getScopeType</A></B>()</CODE>
\r
224 Get Scope Type - {"user", "group", "domain", "default"}</TD>
\r
226 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
227 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
228 <CODE> java.lang.String</CODE></FONT></TD>
\r
229 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#getScopeValue()">getScopeValue</A></B>()</CODE>
\r
232 Get Scope Value e.g.</TD>
\r
234 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
235 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
236 <CODE> void</CODE></FONT></TD>
\r
237 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#setEditLink(java.lang.String)">setEditLink</A></B>(java.lang.String editLink)</CODE>
\r
240 Set Edit Link</TD>
\r
242 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
244 <CODE> void</CODE></FONT></TD>
\r
245 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#setRole(java.lang.String)">setRole</A></B>(java.lang.String role)</CODE>
\r
248 Set Role - {"owner", "writer", "reader"}</TD>
\r
250 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
252 <CODE> void</CODE></FONT></TD>
\r
253 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#setScopeType(java.lang.String)">setScopeType</A></B>(java.lang.String scopeType)</CODE>
\r
256 Set Scope Type {"user", "group", "domain", "default"}</TD>
\r
258 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
259 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
260 <CODE> void</CODE></FONT></TD>
\r
261 <TD><CODE><B><A HREF="../../com/pras/Collaborator.html#setScopeValue(java.lang.String)">setScopeValue</A></B>(java.lang.String scopeValue)</CODE>
\r
264 Set Scope Value</TD>
\r
267 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
268 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
269 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
270 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
273 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
279 <!-- ============ FIELD DETAIL =========== -->
\r
281 <A NAME="field_detail"><!-- --></A>
\r
282 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
283 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
284 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
285 <B>Field Detail</B></FONT></TH>
\r
289 <A NAME="ROLE_OWNER"><!-- --></A><H3>
\r
292 public static java.lang.String <B>ROLE_OWNER</B></PRE>
\r
294 <DD>Owner of a SpreadSheet
\r
301 <A NAME="ROLE_WRITER"><!-- --></A><H3>
\r
304 public static java.lang.String <B>ROLE_WRITER</B></PRE>
\r
306 <DD>Able to Read/Write and Further Share as Reader/Writer
\r
313 <A NAME="ROLE_READER"><!-- --></A><H3>
\r
316 public static java.lang.String <B>ROLE_READER</B></PRE>
\r
325 <A NAME="SCOPE_USER"><!-- --></A><H3>
\r
328 public static java.lang.String <B>SCOPE_USER</B></PRE>
\r
330 <DD>Use this scope to share it with an Email account
\r
337 <A NAME="SCOPE_GROUP"><!-- --></A><H3>
\r
340 public static java.lang.String <B>SCOPE_GROUP</B></PRE>
\r
342 <DD>Use this scope to share it with a Group
\r
349 <A NAME="SCOPE_DOMAIN"><!-- --></A><H3>
\r
352 public static java.lang.String <B>SCOPE_DOMAIN</B></PRE>
\r
354 <DD>Use this scope to share it with a Domain
\r
361 <A NAME="SCOPE_DEFAULT"><!-- --></A><H3>
\r
364 public static java.lang.String <B>SCOPE_DEFAULT</B></PRE>
\r
366 <DD>Use this scope to make the SpreadSheet publicly accessible to anyuser
\r
372 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
374 <A NAME="constructor_detail"><!-- --></A>
\r
375 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
376 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
377 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
378 <B>Constructor Detail</B></FONT></TH>
\r
382 <A NAME="Collaborator()"><!-- --></A><H3>
\r
385 public <B>Collaborator</B>()</PRE>
\r
389 <!-- ============ METHOD DETAIL ========== -->
\r
391 <A NAME="method_detail"><!-- --></A>
\r
392 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
393 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
394 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
395 <B>Method Detail</B></FONT></TH>
\r
399 <A NAME="getRole()"><!-- --></A><H3>
\r
402 public java.lang.String <B>getRole</B>()</PRE>
\r
404 <DD>Get Role - {"owner", "writer", "reader"}
\r
408 <DT><B>Returns:</B><DD></DL>
\r
413 <A NAME="setRole(java.lang.String)"><!-- --></A><H3>
\r
416 public void <B>setRole</B>(java.lang.String role)</PRE>
\r
418 <DD>Set Role - {"owner", "writer", "reader"}
\r
421 <DT><B>Parameters:</B><DD><CODE>role</CODE> - {ROLE_OWNER, ROLE_WRITER, ROLE_READER}</DL>
\r
426 <A NAME="getScopeType()"><!-- --></A><H3>
\r
429 public java.lang.String <B>getScopeType</B>()</PRE>
\r
431 <DD>Get Scope Type - {"user", "group", "domain", "default"}
\r
435 <DT><B>Returns:</B><DD></DL>
\r
440 <A NAME="setScopeType(java.lang.String)"><!-- --></A><H3>
\r
443 public void <B>setScopeType</B>(java.lang.String scopeType)</PRE>
\r
445 <DD>Set Scope Type {"user", "group", "domain", "default"}
\r
448 <DT><B>Parameters:</B><DD><CODE>scopeType</CODE> - {SCOPE_USER, SCOPE_GROUP, SCOPE_DOMAIN, SCOPE_DEFAULT}</DL>
\r
453 <A NAME="getScopeValue()"><!-- --></A><H3>
\r
456 public java.lang.String <B>getScopeValue</B>()</PRE>
\r
458 <DD>Get Scope Value e.g. <email address>
\r
462 <DT><B>Returns:</B><DD></DL>
\r
467 <A NAME="setScopeValue(java.lang.String)"><!-- --></A><H3>
\r
470 public void <B>setScopeValue</B>(java.lang.String scopeValue)</PRE>
\r
472 <DD>Set Scope Value
\r
475 <DT><B>Parameters:</B><DD><CODE>scopeValue</CODE> - Email Address</DL>
\r
480 <A NAME="getEditLink()"><!-- --></A><H3>
\r
483 public java.lang.String <B>getEditLink</B>()</PRE>
\r
489 <DT><B>Returns:</B><DD></DL>
\r
494 <A NAME="setEditLink(java.lang.String)"><!-- --></A><H3>
\r
497 public void <B>setEditLink</B>(java.lang.String editLink)</PRE>
\r
502 <DT><B>Parameters:</B><DD><CODE>editLink</CODE> - </DL>
\r
505 <!-- ========= END OF CLASS DATA ========= -->
\r
509 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
510 <A NAME="navbar_bottom"><!-- --></A>
\r
511 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
512 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
514 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
515 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
516 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
517 <TR ALIGN="center" VALIGN="top">
\r
518 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
519 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
520 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
521 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Collaborator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
522 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
523 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
524 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
525 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
529 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
535 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
536 PREV CLASS
\r
537 <A HREF="../../com/pras/Log.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>
\r
538 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
539 <A HREF="../../index.html?com/pras/Collaborator.html" target="_top"><B>FRAMES</B></A>
\r
540 <A HREF="Collaborator.html" target="_top"><B>NO FRAMES</B></A>
\r
541 <SCRIPT type="text/javascript">
\r
544 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
549 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
556 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
557 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
558 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
559 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
562 <A NAME="skip-navbar_bottom"></A>
\r
563 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r