source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 28.4 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>
7SOSCheckout (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout 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="SOSCheckout (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/SOSCheckin.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/SOSGet.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="SOSCheckout.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 SOSCheckout</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.SOSCheckout</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>SOSCheckout</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 and locks files in Visual SourceSafe via a SourceOffSite server.
103<P>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111
112<!-- =========== FIELD SUMMARY =========== -->
113
114<A NAME="field_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TD COLSPAN=2><FONT SIZE="+2">
118<B>Field Summary</B></FONT></TD>
119</TR>
120</TABLE>
121&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
124<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>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#commandLine">commandLine</A></CODE></TD>
128</TR>
129</TABLE>
130&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133<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>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<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>
137</TR>
138</TABLE>
139&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
142<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>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
146</TR>
147</TABLE>
148&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOSCmd"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
151<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>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<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>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ======== CONSTRUCTOR SUMMARY ======== -->
159
160<A NAME="constructor_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TD COLSPAN=2><FONT SIZE="+2">
164<B>Constructor Summary</B></FONT></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html#SOSCheckout()">SOSCheckout</A></B>()</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171</TR>
172</TABLE>
173&nbsp;
174<!-- ========== METHOD SUMMARY =========== -->
175
176<A NAME="method_summary"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179<TD COLSPAN=2><FONT SIZE="+2">
180<B>Method Summary</B></FONT></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<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>
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html#buildCmdLine()">buildCmdLine</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Build the command line <br>
189
190 CheckOutFile required parameters: -server -name -password -database -project -file<br>
191 CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome<br>
192
193 CheckOutProject required parameters: -server -name -password -database -project<br>
194 CheckOutProject optional parameters:-workdir -recursive -verbose -nocache
195 -nocompression -soshome<br></TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html#setFile(java.lang.String)">setFile</A></B>(java.lang.String&nbsp;filename)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The filename to act upon.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html#setRecursive(boolean)">setRecursive</A></B>(boolean&nbsp;recursive)</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to recursively apply the action.</TD>
212</TR>
213</TABLE>
214&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOS"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
217<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>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<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>
221</TR>
222</TABLE>
223&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
226<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>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<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>
230</TR>
231</TABLE>
232&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></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.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<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>
239</TR>
240</TABLE>
241&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></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 java.lang.Object</B></TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
248</TR>
249</TABLE>
250&nbsp;
251<P>
252
253<!-- ============ FIELD DETAIL =========== -->
254
255
256<!-- ========= CONSTRUCTOR DETAIL ======== -->
257
258<A NAME="constructor_detail"><!-- --></A>
259<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
260<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
261<TD COLSPAN=1><FONT SIZE="+2">
262<B>Constructor Detail</B></FONT></TD>
263</TR>
264</TABLE>
265
266<A NAME="SOSCheckout()"><!-- --></A><H3>
267SOSCheckout</H3>
268<PRE>
269public <B>SOSCheckout</B>()</PRE>
270<DL>
271</DL>
272
273<!-- ============ METHOD DETAIL ========== -->
274
275<A NAME="method_detail"><!-- --></A>
276<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
278<TD COLSPAN=1><FONT SIZE="+2">
279<B>Method Detail</B></FONT></TD>
280</TR>
281</TABLE>
282
283<A NAME="setFile(java.lang.String)"><!-- --></A><H3>
284setFile</H3>
285<PRE>
286public final void <B>setFile</B>(java.lang.String&nbsp;filename)</PRE>
287<DL>
288<DD>The filename to act upon.
289 If no file is specified then the task
290 acts upon the project.
291<P>
292<DD><DL>
293<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The new file value</DL>
294</DD>
295</DL>
296<HR>
297
298<A NAME="setRecursive(boolean)"><!-- --></A><H3>
299setRecursive</H3>
300<PRE>
301public void <B>setRecursive</B>(boolean&nbsp;recursive)</PRE>
302<DL>
303<DD>Flag to recursively apply the action. Defaults to false.
304<P>
305<DD><DL>
306<DT><B>Parameters:</B><DD><CODE>recursive</CODE> - True for recursive operation.</DL>
307</DD>
308</DL>
309<HR>
310
311<A NAME="buildCmdLine()"><!-- --></A><H3>
312buildCmdLine</H3>
313<PRE>
314protected <A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> <B>buildCmdLine</B>()</PRE>
315<DL>
316<DD>Build the command line <br>
317
318 CheckOutFile required parameters: -server -name -password -database -project -file<br>
319 CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome<br>
320
321 CheckOutProject required parameters: -server -name -password -database -project<br>
322 CheckOutProject optional parameters:-workdir -recursive -verbose -nocache
323 -nocompression -soshome<br>
324<P>
325<DD><DL>
326
327<DT><B>Returns:</B><DD>Commandline the generated command to be executed</DL>
328</DD>
329</DL>
330<!-- ========= END OF CLASS DATA ========= -->
331<HR>
332
333
334<!-- ======= START OF BOTTOM NAVBAR ====== -->
335<A NAME="navbar_bottom"><!-- --></A>
336<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
337<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
338<TR>
339<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
340<A NAME="navbar_bottom_firstrow"><!-- --></A>
341<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
342 <TR ALIGN="center" VALIGN="top">
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
345 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
350 </TR>
351</TABLE>
352</TD>
353<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
354</EM>
355</TD>
356</TR>
357
358<TR>
359<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
360&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>PREV CLASS</B></A>&nbsp;
361&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>NEXT CLASS</B></A></FONT></TD>
362<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
363 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
364&nbsp;<A HREF="SOSCheckout.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
365&nbsp;<SCRIPT type="text/javascript">
366 <!--
367 if(window==top) {
368 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
369 }
370 //-->
371</SCRIPT>
372<NOSCRIPT>
373 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
374</NOSCRIPT>
375
376</FONT></TD>
377</TR>
378<TR>
379<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
380 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>
381<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
382DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
383</TR>
384</TABLE>
385<A NAME="skip-navbar_bottom"></A>
386<!-- ======== END OF BOTTOM NAVBAR ======= -->
387
388<HR>
389Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
390</BODY>
391</HTML>
Note: See TracBrowser for help on using the repository browser.