View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo.http;
24  
25  import java.util.Calendar;
26  
27  import de.bea.domingo.DAgent;
28  import de.bea.domingo.DBase;
29  import de.bea.domingo.DNotesMonitor;
30  
31  /***
32   *
33   * @author <a href=mailto:kriede@users.sourceforge.net>Kurt Riede</a>
34   */
35  public final class AgentHttp extends BaseHttp implements DAgent {
36  
37      /*** serial version ID for serialization. */
38      private static final long serialVersionUID = 6380752153299895522L;
39  
40      /*** The name of the agent. */
41      private String fName;
42  
43      /***
44       * Constructor.
45       *
46       * @param theFactory the controlling factory
47       * @param theParent the parent object
48       * @param monitor the monitor
49       * @param agentName the name of the agent
50       */
51      public AgentHttp(final NotesHttpFactory theFactory, final DBase theParent, final DNotesMonitor monitor,
52              final String agentName) {
53          super(theFactory, theParent, monitor);
54          this.fName = agentName;
55      }
56  
57      /***
58       * Factory method for instances of this class.
59       *
60       * @param theFactory the controlling factory
61       * @param theParent the parent the session that produced the database
62       * @param monitor the monitor that handles logging
63       * @param agentName name of a Notes agent
64       *
65       * @return Returns a DDatabase instance of type DatabaseProxy
66       */
67      static AgentHttp getInstance(final NotesHttpFactory theFactory, final DBase theParent, final DNotesMonitor monitor,
68              final String agentName) {
69          return new AgentHttp(theFactory, theParent, monitor, agentName);
70      }
71  
72      /***
73       * {@inheritDoc}
74       *
75       * @see de.bea.domingo.DAgent#getComment()
76       */
77      public String getComment() {
78          // TODO Auto-generated method stub
79          return null;
80      }
81  
82      /***
83       * {@inheritDoc}
84       *
85       * @see de.bea.domingo.DAgent#getCommonOwner()
86       */
87      public String getCommonOwner() {
88          // TODO Auto-generated method stub
89          return null;
90      }
91  
92      /***
93       * {@inheritDoc}
94       *
95       * @see de.bea.domingo.DAgent#isEnabled()
96       */
97      public boolean isEnabled() {
98          // TODO Auto-generated method stub
99          return false;
100     }
101 
102     /***
103      * {@inheritDoc}
104      *
105      * @see de.bea.domingo.DAgent#setEnabled(boolean)
106      */
107     public void setEnabled(final boolean enabled) {
108         // TODO Auto-generated method stub
109     }
110 
111     /***
112      * {@inheritDoc}
113      *
114      * @see de.bea.domingo.DAgent#isNotesAgent()
115      */
116     public boolean isNotesAgent() {
117         // TODO Auto-generated method stub
118         return false;
119     }
120 
121     /***
122      * {@inheritDoc}
123      *
124      * @see de.bea.domingo.DAgent#isPublic()
125      */
126     public boolean isPublic() {
127         // TODO Auto-generated method stub
128         return false;
129     }
130 
131     /***
132      * {@inheritDoc}
133      *
134      * @see de.bea.domingo.DAgent#isWebAgent()
135      */
136     public boolean isWebAgent() {
137         // TODO Auto-generated method stub
138         return false;
139     }
140 
141     /***
142      * {@inheritDoc}
143      *
144      * @see de.bea.domingo.DAgent#getLastRun()
145      */
146     public Calendar getLastRun() {
147         // TODO Auto-generated method stub
148         return null;
149     }
150 
151     /***
152      * {@inheritDoc}
153      *
154      * @see de.bea.domingo.DAgent#getName()
155      */
156     public String getName() {
157         return fName;
158     }
159 
160     /***
161      * {@inheritDoc}
162      *
163      * @see de.bea.domingo.DAgent#getOwner()
164      */
165     public String getOwner() {
166         // TODO Auto-generated method stub
167         return null;
168     }
169 
170     /***
171      * {@inheritDoc}
172      *
173      * @see de.bea.domingo.DAgent#getParameterDocID()
174      */
175     public String getParameterDocID() {
176         // TODO Auto-generated method stub
177         return null;
178     }
179 
180     /***
181      * {@inheritDoc}
182      *
183      * @see de.bea.domingo.DAgent#getQuery()
184      */
185     public String getQuery() {
186         // TODO Auto-generated method stub
187         return null;
188     }
189 
190     /***
191      * {@inheritDoc}
192      *
193      * @see de.bea.domingo.DAgent#getServerName()
194      */
195     public String getServerName() {
196         // TODO Auto-generated method stub
197         return null;
198     }
199 
200     /***
201      * {@inheritDoc}
202      *
203      * @see de.bea.domingo.DAgent#setServerName(java.lang.String)
204      */
205     public void setServerName(final String serverName) {
206         // TODO Auto-generated method stub
207     }
208 
209     /***
210      * {@inheritDoc}
211      *
212      * @see de.bea.domingo.DAgent#getTarget()
213      */
214     public int getTarget() {
215         // TODO Auto-generated method stub
216         return 0;
217     }
218 
219     /***
220      * {@inheritDoc}
221      *
222      * @see de.bea.domingo.DAgent#getTrigger()
223      */
224     public int getTrigger() {
225         // TODO Auto-generated method stub
226         return 0;
227     }
228 
229     /***
230      * {@inheritDoc}
231      *
232      * @see de.bea.domingo.DAgent#remove()
233      */
234     public void remove() {
235         // TODO Auto-generated method stub
236     }
237 
238     /***
239      * {@inheritDoc}
240      *
241      * @see de.bea.domingo.DAgent#run()
242      */
243     public void run() {
244         // TODO Auto-generated method stub
245     }
246 
247     /***
248      * {@inheritDoc}
249      *
250      * @see de.bea.domingo.DAgent#run(java.lang.String)
251      */
252     public void run(final String noteId) {
253         // TODO Auto-generated method stub
254     }
255 
256     /***
257      * {@inheritDoc}
258      *
259      * @see de.bea.domingo.DAgent#runOnServer()
260      */
261     public int runOnServer() {
262         // TODO Auto-generated method stub
263         return 0;
264     }
265 
266     /***
267      * {@inheritDoc}
268      *
269      * @see de.bea.domingo.DAgent#runOnServer(java.lang.String)
270      */
271     public int runOnServer(final String noteId) {
272         // TODO Auto-generated method stub
273         return 0;
274     }
275 
276     /***
277      * {@inheritDoc}
278      *
279      * @see de.bea.domingo.DAgent#save()
280      */
281     public void save() {
282         // TODO Auto-generated method stub
283     }
284 
285     /***
286      * {@inheritDoc}
287      *
288      * @see java.lang.Object#toString()
289      */
290     public String toString() {
291         // TODO Auto-generated method stub
292         return fName;
293     }
294 }