jars/gss-lib-2.2/javadoc/com/pras/SpreadSheetFactory.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->\r
   6 <TITLE>\r
   7 SpreadSheetFactory\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.pras.SpreadSheetFactory class">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     parent.document.title="SpreadSheetFactory";\r
  18 }\r
  19 </SCRIPT>\r
  20 <NOSCRIPT>\r
  21 </NOSCRIPT>\r
  22 \r
  23 </HEAD>\r
  24 \r
  25 <BODY BGCOLOR="white" onload="windowTitle();">\r
  26 \r
  27 \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
  32 <TR>\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>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpreadSheetFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  45   </TR>\r
  46 </TABLE>\r
  47 </TD>\r
  48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  49 </EM>\r
  50 </TD>\r
  51 </TR>\r
  52 \r
  53 <TR>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55 &nbsp;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../com/pras/WorkSheet.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/SpreadSheetFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="SpreadSheetFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  60 &nbsp;<SCRIPT type="text/javascript">\r
  61   <!--\r
  62   if(window==top) {\r
  63     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  64   }\r
  65   //-->\r
  66 </SCRIPT>\r
  67 <NOSCRIPT>\r
  68   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
  69 </NOSCRIPT>\r
  70 \r
  71 \r
  72 </FONT></TD>\r
  73 </TR>\r
  74 <TR>\r
  75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  78 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  79 </TR>\r
  80 </TABLE>\r
  81 <A NAME="skip-navbar_top"></A>\r
  82 <!-- ========= END OF TOP NAVBAR ========= -->\r
  83 \r
  84 <HR>\r
  85 <!-- ======== START OF CLASS DATA ======== -->\r
  86 <H2>\r
  87 <FONT SIZE="-1">\r
  88 com.pras</FONT>\r
  89 <BR>\r
  90 Class SpreadSheetFactory</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>com.pras.SpreadSheetFactory</B>\r
  94 </PRE>\r
  95 <HR>\r
  96 <DL>\r
  97 <DT><PRE>public class <B>SpreadSheetFactory</B><DT>extends java.lang.Object</DL>\r
  98 </PRE>\r
  99 \r
 100 <P>\r
 101 <p>
 102  It is a SpreadSheet Generator Class. It accepts Gmail User ID and PassWord
 103  to generate Authentication Token.
 104  <br/>
 105  It uses 2 Google APIs-
 106  <br/>
 107  SpreadSheet Create/Delete - <a href="http://code.google.com/apis/documents/docs/3.0/developers_guide_protocol.html">Google Document API</a>
 108  <br/>
 109  WorkSheet Create/Delete, Record Add - <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html">Google SpreadSheet API</a>\r
 110 <P>\r
 111 \r
 112 <P>\r
 113 <DL>\r
 114 <DT><B>Author:</B></DT>\r
 115   <DD>Prasanta Paul</DD>\r
 116 </DL>\r
 117 <HR>\r
 118 \r
 119 <P>\r
 120 <!-- =========== FIELD SUMMARY =========== -->\r
 121 \r
 122 <A NAME="field_summary"><!-- --></A>\r
 123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 125 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 126 <B>Field Summary</B></FONT></TH>\r
 127 </TR>\r
 128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 130 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
 131 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#authToken">authToken</A></B></CODE>\r
 132 \r
 133 <BR>\r
 134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 135 </TR>\r
 136 </TABLE>\r
 137 &nbsp;\r
 138 <!-- ========== METHOD SUMMARY =========== -->\r
 139 \r
 140 <A NAME="method_summary"><!-- --></A>\r
 141 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 142 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 143 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 144 <B>Method Summary</B></FONT></TH>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 148 <CODE>&nbsp;void</CODE></FONT></TD>\r
 149 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#addSharePermission(com.pras.SpreadSheet, com.pras.Collaborator[])">addSharePermission</A></B>(<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&nbsp;sp,\r
 150                    <A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>[]&nbsp;collaborators)</CODE>\r
 151 \r
 152 <BR>\r
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Share a SpreadSheet with a given list of Collaborators.</TD>\r
 154 </TR>\r
 155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 157 <CODE>&nbsp;void</CODE></FONT></TD>\r
 158 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#changeSharePermission(com.pras.Collaborator, java.lang.String)">changeSharePermission</A></B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c,\r
 159                       java.lang.String&nbsp;role)</CODE>\r
 160 \r
 161 <BR>\r
 162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Change Share permission for a particular ACL entry</TD>\r
 163 </TR>\r
 164 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 166 <CODE>&nbsp;void</CODE></FONT></TD>\r
 167 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#createSpreadSheet(java.lang.String)">createSpreadSheet</A></B>(java.lang.String&nbsp;spName)</CODE>\r
 168 \r
 169 <BR>\r
 170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create SpreadSheet with the given name</TD>\r
 171 </TR>\r
 172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 174 <CODE>&nbsp;void</CODE></FONT></TD>\r
 175 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#deleteSpreadSheet(java.lang.String)">deleteSpreadSheet</A></B>(java.lang.String&nbsp;resID)</CODE>\r
 176 \r
 177 <BR>\r
 178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete a SpreadSheet</TD>\r
 179 </TR>\r
 180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 182 <CODE>&nbsp;void</CODE></FONT></TD>\r
 183 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#flushMe()">flushMe</A></B>()</CODE>\r
 184 \r
 185 <BR>\r
 186 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deallocate SpreadSheetFactory instance</TD>\r
 187 </TR>\r
 188 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 190 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt;</CODE></FONT></TD>\r
 191 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getAllCollaborators(com.pras.SpreadSheet)">getAllCollaborators</A></B>(<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&nbsp;sp)</CODE>\r
 192 \r
 193 <BR>\r
 194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get list of all Collaborators to whom this SpreadSheet is shared</TD>\r
 195 </TR>\r
 196 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 198 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt;</CODE></FONT></TD>\r
 199 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getAllSpreadSheets()">getAllSpreadSheets</A></B>()</CODE>\r
 200 \r
 201 <BR>\r
 202 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get All stored SpreadSheets from Server</TD>\r
 203 </TR>\r
 204 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 206 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt;</CODE></FONT></TD>\r
 207 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getAllSpreadSheets(boolean)">getAllSpreadSheets</A></B>(boolean&nbsp;doRefresh)</CODE>\r
 208 \r
 209 <BR>\r
 210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get All stored SpreadSheets either from Server or Local Cache</TD>\r
 211 </TR>\r
 212 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 214 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt;</CODE></FONT></TD>\r
 215 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getAllSpreadSheets(boolean, java.lang.String, boolean)">getAllSpreadSheets</A></B>(boolean&nbsp;doRefresh,\r
 216                    java.lang.String&nbsp;title,\r
 217                    boolean&nbsp;isTitleExact)</CODE>\r
 218 \r
 219 <BR>\r
 220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get All stored SpreadSheets either from Server or Local Cache</TD>\r
 221 </TR>\r
 222 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 224 <CODE>static&nbsp;<A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A></CODE></FONT></TD>\r
 225 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getInstance()">getInstance</A></B>()</CODE>\r
 226 \r
 227 <BR>\r
 228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will return an existing SpreadSheetFactory instance or null
 229  </br>
 230  <b>Note:</b>
 231  Make sure you have previously called getInstance(String userName, String password)</TD>\r
 232 </TR>\r
 233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 235 <CODE>static&nbsp;<A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A></CODE></FONT></TD>\r
 236 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getInstance(com.pras.auth.Authenticator)">getInstance</A></B>(<A HREF="../../com/pras/auth/Authenticator.html" title="interface in com.pras.auth">Authenticator</A>&nbsp;authenticator)</CODE>\r
 237 \r
 238 <BR>\r
 239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will create SpreadSheetFactory Instance using your custom Authenticatior.</TD>\r
 240 </TR>\r
 241 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 243 <CODE>static&nbsp;<A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A></CODE></FONT></TD>\r
 244 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getInstance(java.lang.String, java.lang.String)">getInstance</A></B>(java.lang.String&nbsp;email,\r
 245             java.lang.String&nbsp;password)</CODE>\r
 246 \r
 247 <BR>\r
 248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will create SpreadSheetFactory Instance with valid User ID (e.g.</TD>\r
 249 </TR>\r
 250 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 252 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt;</CODE></FONT></TD>\r
 253 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#getSpreadSheet(java.lang.String, boolean)">getSpreadSheet</A></B>(java.lang.String&nbsp;title,\r
 254                boolean&nbsp;isTitleExact)</CODE>\r
 255 \r
 256 <BR>\r
 257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get list of SpreadSheet with matching title.</TD>\r
 258 </TR>\r
 259 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 261 <CODE>&nbsp;void</CODE></FONT></TD>\r
 262 <TD><CODE><B><A HREF="../../com/pras/SpreadSheetFactory.html#removeSharePermission(com.pras.Collaborator)">removeSharePermission</A></B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c)</CODE>\r
 263 \r
 264 <BR>\r
 265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove Share access of a selected user.</TD>\r
 266 </TR>\r
 267 </TABLE>\r
 268 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 269 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 270 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 271 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 272 </TR>\r
 273 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 274 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 275 </TR>\r
 276 </TABLE>\r
 277 &nbsp;\r
 278 <P>\r
 279 \r
 280 <!-- ============ FIELD DETAIL =========== -->\r
 281 \r
 282 <A NAME="field_detail"><!-- --></A>\r
 283 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 284 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 285 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 286 <B>Field Detail</B></FONT></TH>\r
 287 </TR>\r
 288 </TABLE>\r
 289 \r
 290 <A NAME="authToken"><!-- --></A><H3>\r
 291 authToken</H3>\r
 292 <PRE>\r
 293 public static java.lang.String <B>authToken</B></PRE>\r
 294 <DL>\r
 295 <DL>\r
 296 </DL>\r
 297 </DL>\r
 298 \r
 299 <!-- ============ METHOD DETAIL ========== -->\r
 300 \r
 301 <A NAME="method_detail"><!-- --></A>\r
 302 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 303 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 304 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 305 <B>Method Detail</B></FONT></TH>\r
 306 </TR>\r
 307 </TABLE>\r
 308 \r
 309 <A NAME="getInstance()"><!-- --></A><H3>\r
 310 getInstance</H3>\r
 311 <PRE>\r
 312 public static <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A> <B>getInstance</B>()</PRE>\r
 313 <DL>\r
 314 <DD>This will return an existing SpreadSheetFactory instance or null
 315  </br>
 316  <b>Note:</b>
 317  Make sure you have previously called getInstance(String userName, String password)\r
 318 <P>\r
 319 <DD><DL>\r
 320 \r
 321 <DT><B>Returns:</B><DD></DL>\r
 322 </DD>\r
 323 </DL>\r
 324 <HR>\r
 325 \r
 326 <A NAME="getInstance(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 327 getInstance</H3>\r
 328 <PRE>\r
 329 public static <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A> <B>getInstance</B>(java.lang.String&nbsp;email,\r
 330                                              java.lang.String&nbsp;password)</PRE>\r
 331 <DL>\r
 332 <DD>This will create SpreadSheetFactory Instance with valid User ID (e.g. abc@gmail.com) and password\r
 333 <P>\r
 334 <DD><DL>\r
 335 <DT><B>Parameters:</B><DD><CODE>userName</CODE> - Gmail account id e.g. abc@gmail.com<DD><CODE>password</CODE> - Gmail account password\r
 336 <DT><B>Returns:</B><DD></DL>\r
 337 </DD>\r
 338 </DL>\r
 339 <HR>\r
 340 \r
 341 <A NAME="getInstance(com.pras.auth.Authenticator)"><!-- --></A><H3>\r
 342 getInstance</H3>\r
 343 <PRE>\r
 344 public static <A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras">SpreadSheetFactory</A> <B>getInstance</B>(<A HREF="../../com/pras/auth/Authenticator.html" title="interface in com.pras.auth">Authenticator</A>&nbsp;authenticator)</PRE>\r
 345 <DL>\r
 346 <DD>This will create SpreadSheetFactory Instance using your custom Authenticatior.
 347
 348  Use this if you want to use your custom Authenticator e.g. in Android you can use AccountManager
 349  to create a custom Authenticator.\r
 350 <P>\r
 351 <DD><DL>\r
 352 <DT><B>Parameters:</B><DD><CODE>authenticator</CODE> - Your Custom Authenticator.\r
 353 <DT><B>Returns:</B><DD></DL>\r
 354 </DD>\r
 355 </DL>\r
 356 <HR>\r
 357 \r
 358 <A NAME="flushMe()"><!-- --></A><H3>\r
 359 flushMe</H3>\r
 360 <PRE>\r
 361 public void <B>flushMe</B>()</PRE>\r
 362 <DL>\r
 363 <DD>Deallocate SpreadSheetFactory instance\r
 364 <P>\r
 365 <DD><DL>\r
 366 </DL>\r
 367 </DD>\r
 368 </DL>\r
 369 <HR>\r
 370 \r
 371 <A NAME="createSpreadSheet(java.lang.String)"><!-- --></A><H3>\r
 372 createSpreadSheet</H3>\r
 373 <PRE>\r
 374 public void <B>createSpreadSheet</B>(java.lang.String&nbsp;spName)</PRE>\r
 375 <DL>\r
 376 <DD>Create SpreadSheet with the given name\r
 377 <P>\r
 378 <DD><DL>\r
 379 <DT><B>Parameters:</B><DD><CODE>spName</CODE> - SpreadSheet name</DL>\r
 380 </DD>\r
 381 </DL>\r
 382 <HR>\r
 383 \r
 384 <A NAME="deleteSpreadSheet(java.lang.String)"><!-- --></A><H3>\r
 385 deleteSpreadSheet</H3>\r
 386 <PRE>\r
 387 public void <B>deleteSpreadSheet</B>(java.lang.String&nbsp;resID)</PRE>\r
 388 <DL>\r
 389 <DD>Delete a SpreadSheet\r
 390 <P>\r
 391 <DD><DL>\r
 392 <DT><B>Parameters:</B><DD><CODE>resID</CODE> - Resource ID of the SpreadSheet you want to Delete</DL>\r
 393 </DD>\r
 394 </DL>\r
 395 <HR>\r
 396 \r
 397 <A NAME="getSpreadSheet(java.lang.String, boolean)"><!-- --></A><H3>\r
 398 getSpreadSheet</H3>\r
 399 <PRE>\r
 400 public java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt; <B>getSpreadSheet</B>(java.lang.String&nbsp;title,\r
 401                                                        boolean&nbsp;isTitleExact)</PRE>\r
 402 <DL>\r
 403 <DD>Get list of SpreadSheet with matching title. It will do Synch with Server\r
 404 <P>\r
 405 <DD><DL>\r
 406 <DT><B>Parameters:</B><DD><CODE>title</CODE> - SpreadSheet title<DD><CODE>isTitleExact</CODE> - Whether title string should be an exact match\r
 407 <DT><B>Returns:</B><DD></DL>\r
 408 </DD>\r
 409 </DL>\r
 410 <HR>\r
 411 \r
 412 <A NAME="getAllSpreadSheets()"><!-- --></A><H3>\r
 413 getAllSpreadSheets</H3>\r
 414 <PRE>\r
 415 public java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt; <B>getAllSpreadSheets</B>()</PRE>\r
 416 <DL>\r
 417 <DD>Get All stored SpreadSheets from Server\r
 418 <P>\r
 419 <DD><DL>\r
 420 \r
 421 <DT><B>Returns:</B><DD></DL>\r
 422 </DD>\r
 423 </DL>\r
 424 <HR>\r
 425 \r
 426 <A NAME="getAllSpreadSheets(boolean)"><!-- --></A><H3>\r
 427 getAllSpreadSheets</H3>\r
 428 <PRE>\r
 429 public java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt; <B>getAllSpreadSheets</B>(boolean&nbsp;doRefresh)</PRE>\r
 430 <DL>\r
 431 <DD>Get All stored SpreadSheets either from Server or Local Cache\r
 432 <P>\r
 433 <DD><DL>\r
 434 <DT><B>Parameters:</B><DD><CODE>doRefresh</CODE> - Do you want to Synch with Server ?\r
 435 <DT><B>Returns:</B><DD>List of Entry. Each Entry represents a SpreadSheet</DL>\r
 436 </DD>\r
 437 </DL>\r
 438 <HR>\r
 439 \r
 440 <A NAME="getAllSpreadSheets(boolean, java.lang.String, boolean)"><!-- --></A><H3>\r
 441 getAllSpreadSheets</H3>\r
 442 <PRE>\r
 443 public java.util.ArrayList&lt;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&gt; <B>getAllSpreadSheets</B>(boolean&nbsp;doRefresh,\r
 444                                                            java.lang.String&nbsp;title,\r
 445                                                            boolean&nbsp;isTitleExact)</PRE>\r
 446 <DL>\r
 447 <DD>Get All stored SpreadSheets either from Server or Local Cache\r
 448 <P>\r
 449 <DD><DL>\r
 450 <DT><B>Parameters:</B><DD><CODE>doRefresh</CODE> - <DD><CODE>title</CODE> - SpreadSheet title. <b>null</b> means all SpreadSheets. No need to do URL encode.<DD><CODE>isTitleExact</CODE> - Whether title string should be an exact match\r
 451 <DT><B>Returns:</B><DD></DL>\r
 452 </DD>\r
 453 </DL>\r
 454 <HR>\r
 455 \r
 456 <A NAME="addSharePermission(com.pras.SpreadSheet, com.pras.Collaborator[])"><!-- --></A><H3>\r
 457 addSharePermission</H3>\r
 458 <PRE>\r
 459 public void <B>addSharePermission</B>(<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&nbsp;sp,\r
 460                                <A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>[]&nbsp;collaborators)</PRE>\r
 461 <DL>\r
 462 <DD>Share a SpreadSheet with a given list of Collaborators.
 463  NOTE: You need not to mention editLink of Collaborator\r
 464 <P>\r
 465 <DD><DL>\r
 466 <DT><B>Parameters:</B><DD><CODE>sp</CODE> - The SpreadSheet you want to share<DD><CODE>collaborators</CODE> - List of Collaborators with whim you want to share this.</DL>\r
 467 </DD>\r
 468 </DL>\r
 469 <HR>\r
 470 \r
 471 <A NAME="getAllCollaborators(com.pras.SpreadSheet)"><!-- --></A><H3>\r
 472 getAllCollaborators</H3>\r
 473 <PRE>\r
 474 public java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt; <B>getAllCollaborators</B>(<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras">SpreadSheet</A>&nbsp;sp)</PRE>\r
 475 <DL>\r
 476 <DD>Get list of all Collaborators to whom this SpreadSheet is shared\r
 477 <P>\r
 478 <DD><DL>\r
 479 <DT><B>Parameters:</B><DD><CODE>sp</CODE> - SpreadSheet\r
 480 <DT><B>Returns:</B><DD></DL>\r
 481 </DD>\r
 482 </DL>\r
 483 <HR>\r
 484 \r
 485 <A NAME="changeSharePermission(com.pras.Collaborator, java.lang.String)"><!-- --></A><H3>\r
 486 changeSharePermission</H3>\r
 487 <PRE>\r
 488 public void <B>changeSharePermission</B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c,\r
 489                                   java.lang.String&nbsp;role)</PRE>\r
 490 <DL>\r
 491 <DD>Change Share permission for a particular ACL entry\r
 492 <P>\r
 493 <DD><DL>\r
 494 <DT><B>Parameters:</B><DD><CODE>c</CODE> - Collaborator instance stored in SpreadSheet. It should have a valid EditLink URL<DD><CODE>role</CODE> - {owner, writer, reader}</DL>\r
 495 </DD>\r
 496 </DL>\r
 497 <HR>\r
 498 \r
 499 <A NAME="removeSharePermission(com.pras.Collaborator)"><!-- --></A><H3>\r
 500 removeSharePermission</H3>\r
 501 <PRE>\r
 502 public void <B>removeSharePermission</B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c)</PRE>\r
 503 <DL>\r
 504 <DD>Remove Share access of a selected user.\r
 505 <P>\r
 506 <DD><DL>\r
 507 <DT><B>Parameters:</B><DD><CODE>c</CODE> - Collaborator Instance. It should have the Edit Link.</DL>\r
 508 </DD>\r
 509 </DL>\r
 510 <!-- ========= END OF CLASS DATA ========= -->\r
 511 <HR>\r
 512 \r
 513 \r
 514 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 515 <A NAME="navbar_bottom"><!-- --></A>\r
 516 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 517 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 518 <TR>\r
 519 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 520 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 521 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 522   <TR ALIGN="center" VALIGN="top">\r
 523   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 524   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 525   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 526   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpreadSheetFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 527   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 528   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 529   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 530   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 531   </TR>\r
 532 </TABLE>\r
 533 </TD>\r
 534 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 535 </EM>\r
 536 </TD>\r
 537 </TR>\r
 538 \r
 539 <TR>\r
 540 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 541 &nbsp;<A HREF="../../com/pras/SpreadSheet.html" title="class in com.pras"><B>PREV CLASS</B></A>&nbsp;\r
 542 &nbsp;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>\r
 543 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 544   <A HREF="../../index.html?com/pras/SpreadSheetFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 545 &nbsp;<A HREF="SpreadSheetFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 546 &nbsp;<SCRIPT type="text/javascript">\r
 547   <!--\r
 548   if(window==top) {\r
 549     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 550   }\r
 551   //-->\r
 552 </SCRIPT>\r
 553 <NOSCRIPT>\r
 554   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 555 </NOSCRIPT>\r
 556 \r
 557 \r
 558 </FONT></TD>\r
 559 </TR>\r
 560 <TR>\r
 561 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 562   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 563 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 564 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 565 </TR>\r
 566 </TABLE>\r
 567 <A NAME="skip-navbar_bottom"></A>\r
 568 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 569 \r
 570 <HR>\r
 571 \r
 572 </BODY>\r
 573 </HTML>\r