source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 29.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:30 NZST 2007 -->
6<TITLE>
7SOSGet (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.sos.SOSGet class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="SOSGet (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="SOSGet.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.sos</FONT>
85<BR>
86Class SOSGet</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">org.apache.tools.ant.taskdefs.optional.sos.SOS</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.sos.SOSGet</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html" title="interface in org.apache.tools.ant.taskdefs.optional.sos">SOSCmd</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>SOSGet</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOS</A></DL>
100
101<P>
102Retrieves a read-only copy of the specified project or file
103 from Visual SourceSafe via a SourceOffSite server.
104<P>
105
106<P>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115<A NAME="field_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Field Summary</B></FONT></TD>
120</TR>
121</TABLE>
122&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
125<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.optional.sos.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOS</A></B></TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#commandLine">commandLine</A></CODE></TD>
129</TR>
130</TABLE>
131&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
134<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
138</TR>
139</TABLE>
140&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
143<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
147</TR>
148</TABLE>
149&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOSCmd"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
152<TD><B>Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html" title="interface in org.apache.tools.ant.taskdefs.optional.sos">SOSCmd</A></B></TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKIN_FILE">COMMAND_CHECKIN_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKIN_PROJECT">COMMAND_CHECKIN_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKOUT_FILE">COMMAND_CHECKOUT_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKOUT_PROJECT">COMMAND_CHECKOUT_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_GET_FILE">COMMAND_GET_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_GET_PROJECT">COMMAND_GET_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_HISTORY">COMMAND_HISTORY</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_LABEL">COMMAND_LABEL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_SOS_EXE">COMMAND_SOS_EXE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_COMMAND">FLAG_COMMAND</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_COMMENT">FLAG_COMMENT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_FILE">FLAG_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_LABEL">FLAG_LABEL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_NO_CACHE">FLAG_NO_CACHE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_NO_COMPRESSION">FLAG_NO_COMPRESSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_PASSWORD">FLAG_PASSWORD</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_PROJECT">FLAG_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_RECURSION">FLAG_RECURSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_SOS_HOME">FLAG_SOS_HOME</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_SOS_SERVER">FLAG_SOS_SERVER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_USERNAME">FLAG_USERNAME</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VERBOSE">FLAG_VERBOSE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VERSION">FLAG_VERSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VSS_SERVER">FLAG_VSS_SERVER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_WORKING_DIR">FLAG_WORKING_DIR</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#PROJECT_PREFIX">PROJECT_PREFIX</A></CODE></TD>
156</TR>
157</TABLE>
158&nbsp;
159<!-- ======== CONSTRUCTOR SUMMARY ======== -->
160
161<A NAME="constructor_summary"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164<TD COLSPAN=2><FONT SIZE="+2">
165<B>Constructor Summary</B></FONT></TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#SOSGet()">SOSGet</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
172</TR>
173</TABLE>
174&nbsp;
175<!-- ========== METHOD SUMMARY =========== -->
176
177<A NAME="method_summary"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
180<TD COLSPAN=2><FONT SIZE="+2">
181<B>Method Summary</B></FONT></TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>protected &nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A></CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#buildCmdLine()">buildCmdLine</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Build the command line <br>
190
191 GetFile required parameters: -server -name -password -database -project -file<br>
192 GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome<br>
193
194 GetProject required parameters: -server -name -password -database -project<br>
195 GetProject optional parameters: -label -workdir -recursive -verbose -nocache
196 -nocompression -soshome<br></TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&nbsp;void</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#setFile(java.lang.String)">setFile</A></B>(java.lang.String&nbsp;filename)</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Filename to act upon.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;void</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#setLabel(java.lang.String)">setLabel</A></B>(java.lang.String&nbsp;label)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The labeled version to operate on in SourceSafe.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#setRecursive(boolean)">setRecursive</A></B>(boolean&nbsp;recursive)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to recursively apply the action.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html#setVersion(java.lang.String)">setVersion</A></B>(java.lang.String&nbsp;version)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the version number to get -
229 only works with SOSGet on a file.</TD>
230</TR>
231</TABLE>
232&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
235<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOS</A></B></TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#execute()">execute</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getComment()">getComment</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getFilename()">getFilename</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getLabel()">getLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getLocalPath()">getLocalPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getNoCache()">getNoCache</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getNoCompress()">getNoCompress</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getOptionalAttributes()">getOptionalAttributes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getPassword()">getPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getProjectPath()">getProjectPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getRecursive()">getRecursive</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getRequiredAttributes()">getRequiredAttributes</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosCommand()">getSosCommand</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosHome()">getSosHome</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosServerPath()">getSosServerPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getUsername()">getUsername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVerbose()">getVerbose</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVersion()">getVersion</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVssServerPath()">getVssServerPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#run(org.apache.tools.ant.types.Commandline)">run</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalComment(java.lang.String)">setInternalComment</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalFilename(java.lang.String)">setInternalFilename</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalLabel(java.lang.String)">setInternalLabel</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalRecursive(boolean)">setInternalRecursive</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalVersion(java.lang.String)">setInternalVersion</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setLocalPath(org.apache.tools.ant.types.Path)">setLocalPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setNoCache(boolean)">setNoCache</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setNoCompress(boolean)">setNoCompress</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setPassword(java.lang.String)">setPassword</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setProjectPath(java.lang.String)">setProjectPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosCmd(java.lang.String)">setSosCmd</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosHome(java.lang.String)">setSosHome</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosServerPath(java.lang.String)">setSosServerPath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setUsername(java.lang.String)">setUsername</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setVerbose(boolean)">setVerbose</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setVssServerPath(java.lang.String)">setVssServerPath</A></CODE></TD>
239</TR>
240</TABLE>
241&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
243<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
244<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
248</TR>
249</TABLE>
250&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
251<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
252<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
253<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
257</TR>
258</TABLE>
259&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
260<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
262<TD><B>Methods inherited from class java.lang.Object</B></TD>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
266</TR>
267</TABLE>
268&nbsp;
269<P>
270
271<!-- ============ FIELD DETAIL =========== -->
272
273
274<!-- ========= CONSTRUCTOR DETAIL ======== -->
275
276<A NAME="constructor_detail"><!-- --></A>
277<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279<TD COLSPAN=1><FONT SIZE="+2">
280<B>Constructor Detail</B></FONT></TD>
281</TR>
282</TABLE>
283
284<A NAME="SOSGet()"><!-- --></A><H3>
285SOSGet</H3>
286<PRE>
287public <B>SOSGet</B>()</PRE>
288<DL>
289</DL>
290
291<!-- ============ METHOD DETAIL ========== -->
292
293<A NAME="method_detail"><!-- --></A>
294<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
295<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
296<TD COLSPAN=1><FONT SIZE="+2">
297<B>Method Detail</B></FONT></TD>
298</TR>
299</TABLE>
300
301<A NAME="setFile(java.lang.String)"><!-- --></A><H3>
302setFile</H3>
303<PRE>
304public final void <B>setFile</B>(java.lang.String&nbsp;filename)</PRE>
305<DL>
306<DD>The Filename to act upon.
307 If no file is specified then the tasks
308 act upon the project.
309<P>
310<DD><DL>
311<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The new file value</DL>
312</DD>
313</DL>
314<HR>
315
316<A NAME="setRecursive(boolean)"><!-- --></A><H3>
317setRecursive</H3>
318<PRE>
319public void <B>setRecursive</B>(boolean&nbsp;recursive)</PRE>
320<DL>
321<DD>Flag to recursively apply the action. Defaults to false
322<P>
323<DD><DL>
324<DT><B>Parameters:</B><DD><CODE>recursive</CODE> - True for recursive operation.</DL>
325</DD>
326</DL>
327<HR>
328
329<A NAME="setVersion(java.lang.String)"><!-- --></A><H3>
330setVersion</H3>
331<PRE>
332public void <B>setVersion</B>(java.lang.String&nbsp;version)</PRE>
333<DL>
334<DD>Set the version number to get -
335 only works with SOSGet on a file.
336<P>
337<DD><DL>
338<DT><B>Parameters:</B><DD><CODE>version</CODE> - The new version value</DL>
339</DD>
340</DL>
341<HR>
342
343<A NAME="setLabel(java.lang.String)"><!-- --></A><H3>
344setLabel</H3>
345<PRE>
346public void <B>setLabel</B>(java.lang.String&nbsp;label)</PRE>
347<DL>
348<DD>The labeled version to operate on in SourceSafe.
349<P>
350<DD><DL>
351<DT><B>Parameters:</B><DD><CODE>label</CODE> - The new label value</DL>
352</DD>
353</DL>
354<HR>
355
356<A NAME="buildCmdLine()"><!-- --></A><H3>
357buildCmdLine</H3>
358<PRE>
359protected <A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> <B>buildCmdLine</B>()</PRE>
360<DL>
361<DD>Build the command line <br>
362
363 GetFile required parameters: -server -name -password -database -project -file<br>
364 GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome<br>
365
366 GetProject required parameters: -server -name -password -database -project<br>
367 GetProject optional parameters: -label -workdir -recursive -verbose -nocache
368 -nocompression -soshome<br>
369<P>
370<DD><DL>
371
372<DT><B>Returns:</B><DD>Commandline the generated command to be executed</DL>
373</DD>
374</DL>
375<!-- ========= END OF CLASS DATA ========= -->
376<HR>
377
378
379<!-- ======= START OF BOTTOM NAVBAR ====== -->
380<A NAME="navbar_bottom"><!-- --></A>
381<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
382<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
383<TR>
384<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
385<A NAME="navbar_bottom_firstrow"><!-- --></A>
386<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
387 <TR ALIGN="center" VALIGN="top">
388 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
389 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
390 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
391 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
392 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
393 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
394 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
395 </TR>
396</TABLE>
397</TD>
398<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
399</EM>
400</TD>
401</TR>
402
403<TR>
404<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
405&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>PREV CLASS</B></A>&nbsp;
406&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>NEXT CLASS</B></A></FONT></TD>
407<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
408 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
409&nbsp;<A HREF="SOSGet.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
410&nbsp;<SCRIPT type="text/javascript">
411 <!--
412 if(window==top) {
413 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
414 }
415 //-->
416</SCRIPT>
417<NOSCRIPT>
418 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
419</NOSCRIPT>
420
421</FONT></TD>
422</TR>
423<TR>
424<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
425 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
426<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
427DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
428</TR>
429</TABLE>
430<A NAME="skip-navbar_bottom"></A>
431<!-- ======== END OF BOTTOM NAVBAR ======= -->
432
433<HR>
434Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
435</BODY>
436</HTML>
Note: See TracBrowser for help on using the repository browser.