1   /**
2    * JHylaFax - A java client for HylaFAX.
3    *
4    * Copyright (C) 2005 by Steffen Pingel <steffenp@gmx.de>
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation; either version 2 of the License, or
9    * (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with this program; if not, write to the Free Software
18   * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19   */
20  package net.sf.jhylafax.fax;
21  
22  import java.util.Date;
23  
24  /**
25   * Representation of a fax job.
26   */
27  public class FaxJob {
28  	
29  	private String destinationSubAddress;
30  	private String destinationPassword;
31  	private String destinationCompanyName;
32  	private String desiredSignallingRate;
33  	private String taglineFormat;
34  	private String desiredMinScanline;
35  	private String desiredDataFormat;
36  	private String clientSchedulingPriority;
37  	private String clientJobTag;
38  	private String desiredECM;
39  	private String destinationLocation;
40  	private boolean usePrivateTagLine;
41  	private boolean useContinuationCoverPage;
42  	private int clientMinimumSignallingRate;
43  	private String receiver;
44  	private double choppingThreshold; // inch
45  	private String jobDoneOperation;
46  	private String communicationIdentifier;
47  	private JobType jobType;
48  	private int consecutiveFailedTries;
49  	private String clientMachineName;
50  	private int consecutiveFailedDials;
51  	private int groupID;
52  	private	PageChopping pageChopping;
53  	private String killTime;
54  	private String assignedModem;
55  	private int retryTime; // seconds
56  	private String clientDialString;
57  	private int dialsAttempted;
58  	private int ID = -1;
59  	private String lastError;
60  	private int maxDials;
61  	private int maxTries;
62  	private String notify;
63  	private String notifyAdress;
64  	private String number;
65  	private String owner;
66  	private int pageCount;
67  	private int pagesTransmitted;
68  	private int pageLength;
69  	private int pageWidth;
70  	private String permissions;
71  	private int priority;
72  	private int verticalResolution;
73  	private int horizontalResolution;
74  	private String result;
75  	private String sender;
76  	private Date sendTime;
77  	private State state = State.UNDEFINED;
78  	private int tag;
79  	private int triesAttempted;
80  	
81  	public int getDialsAttempted()
82  	{
83  		return dialsAttempted;
84  	}
85  		
86  	public int getID()
87  	{
88  		return ID;
89  	}
90  	
91  	public String getLastError()
92  	{
93  		return lastError;
94  	}
95  
96  	public int getMaxDials()
97  	{
98  		return maxDials;
99  	}
100 	
101 	public int getMaxTries()
102 	{
103 		return maxTries;
104 	}
105 	
106 	public String getNotify()
107 	{
108 		return notify;
109 	}
110 	
111 	public String getNotifyAdress()
112 	{
113 		return notifyAdress;
114 	}
115 	
116 	public String getNumber()
117 	{
118 		return number;
119 	}
120 	
121 	public String getOwner()
122 	{
123 		return owner;
124 	}
125 	
126 	public int getPageCount()
127 	{
128 		return pageCount;
129 	}
130 	
131 	public int getPagesTransmitted()
132 	{
133 		return pagesTransmitted;
134 	}
135 	
136 	public int getPageLength()
137 	{
138 		return pageLength;
139 	}
140 	
141 	public int getPageWidth()
142 	{
143 		return pageWidth;
144 	}
145 	
146 	public String getPermissions()
147 	{
148 		return permissions;
149 	}
150 	
151 	public int getPriority()
152 	{
153 		return priority;
154 	}
155 	
156 	public int getVerticalResolution()
157 	{
158 		return verticalResolution;
159 	}
160 	
161 	public String getResult()
162 	{
163 		return result;
164 	}
165 	
166 	public String getSender()
167 	{
168 		return sender;
169 	}
170 	
171 	public Date getSendTime()
172 	{
173 		return sendTime;
174 	}
175 	
176 	public State getState()
177 	{
178 		return state;
179 	}
180 	
181 	public int getTag()
182 	{
183 		return tag;
184 	}
185 	
186 	public int getTriesAttempted()
187 	{
188 		return triesAttempted;
189 	}
190 	
191 	public void setDialsAttempted(int dialsAttempted)
192 	{
193 		this.dialsAttempted = dialsAttempted;
194 	}
195 	
196 	public void setID(int id)
197 	{
198 		ID = id;
199 	}
200 	
201 	public void setLastError(String lastError)
202 	{
203 		this.lastError = lastError;
204 	}
205 	
206 	public void setMaxDials(int maxDials)
207 	{
208 		this.maxDials = maxDials;
209 	}
210 	
211 	public void setMaxTries(int maxTries)
212 	{
213 		this.maxTries = maxTries;
214 	}
215 	
216 	public void setNotify(String notify)
217 	{
218 		this.notify = notify;
219 	}
220 	
221 	public void setNotifyAdress(String notifyAdress)
222 	{
223 		this.notifyAdress = notifyAdress;
224 	}
225 	
226 	public void setNumber(String number)
227 	{
228 		this.number = number;
229 	}
230 	
231 	public void setOwner(String owner)
232 	{
233 		this.owner = owner;
234 	}
235 	
236 	public void setPageCount(int pageCount)
237 	{
238 		this.pageCount = pageCount;
239 	}
240 	
241 	public void setPagesTransmitted(int pagesTransmitted)
242 	{
243 		this.pagesTransmitted = pagesTransmitted;
244 	}
245 	
246 	public void setPageLength(int pageLength)
247 	{
248 		this.pageLength = pageLength;
249 	}
250 	
251 	public void setPageWidth(int pageWidth)
252 	{
253 		this.pageWidth = pageWidth;
254 	}
255 	
256 	public void setPermissions(String permissions)
257 	{
258 		this.permissions = permissions;
259 	}
260 	
261 	public void setPriority(int priority)
262 	{
263 		this.priority = priority;
264 	}
265 	
266 	public void setResolution(int resolution)
267 	{
268 		this.verticalResolution = resolution;
269 	}
270 	
271 	public void setResult(String result)
272 	{
273 		this.result = result;
274 	}
275 	
276 	public void setSender(String sender)
277 	{
278 		this.sender = sender;
279 	}
280 	
281 	public void setSendTime(Date sendTime)
282 	{
283 		this.sendTime = sendTime;
284 	}
285 
286 	public void setState(State state)
287 	{
288 		this.state = state;
289 	}
290 	
291 	public void setTag(int tag)
292 	{
293 		this.tag = tag;
294 	}
295 
296 	public void setTriesAttempted(int triesAttempted)
297 	{
298 		this.triesAttempted = triesAttempted;
299 	}
300 	
301 	public String getAssignedModem()
302 	{
303 		return assignedModem;
304 	}
305 	
306 	public double getChoppingThreshold()
307 	{
308 		return choppingThreshold;
309 	}
310 	
311 	public String getClientDialString()
312 	{
313 		return clientDialString;
314 	}
315 	
316 	public String getClientJobTag()
317 	{
318 		return clientJobTag;
319 	}
320 	
321 	public String getClientMachineName()
322 	{
323 		return clientMachineName;
324 	}
325 
326 	public int getClientMinimumSignallingRate()
327 	{
328 		return clientMinimumSignallingRate;
329 	}
330 
331 	public String getClientSchedulingPriority()
332 	{
333 		return clientSchedulingPriority;
334 	}
335 	
336 	public String getCommunicationIdentifier()
337 	{
338 		return communicationIdentifier;
339 	}
340 	
341 	public int getConsecutiveFailedDials()
342 	{
343 		return consecutiveFailedDials;
344 	}
345 
346 	public int getConsecutiveFailedTries()
347 	{
348 		return consecutiveFailedTries;
349 	}
350 
351 	public String getDesiredDataFormat()
352 	{
353 		return desiredDataFormat;
354 	}
355 	
356 	public String getDesiredECM()
357 	{
358 		return desiredECM;
359 	}
360 	
361 	public String getDesiredMinScanline()
362 	{
363 		return desiredMinScanline;
364 	}
365 	
366 	public String getDesiredSignallingRate()
367 	{
368 		return desiredSignallingRate;
369 	}
370 	
371 	public String getDestinationCompanyName()
372 	{
373 		return destinationCompanyName;
374 	}
375 
376 	public String getDestinationLocation()
377 	{
378 		return destinationLocation;
379 	}
380 	
381 	public String getDestinationPassword()
382 	{
383 		return destinationPassword;
384 	}
385 	
386 	public String getDestinationSubAddress()
387 	{
388 		return destinationSubAddress;
389 	}
390 	
391 	public int getGroupID()
392 	{
393 		return groupID;
394 	}
395 	
396 	public int getHorizontalResolution()
397 	{
398 		return horizontalResolution;
399 	}
400 	
401 	public String getJobDoneOperation()
402 	{
403 		return jobDoneOperation;
404 	}
405 	
406 	public JobType getJobType()
407 	{
408 		return jobType;
409 	}
410 
411 	
412 	public String getKillTime()
413 	{
414 		return killTime;
415 	}
416 	
417 	public PageChopping getPageChopping()
418 	{
419 		return pageChopping;
420 	}
421 
422 	
423 	public String getReceiver()
424 	{
425 		return receiver;
426 	}
427 
428 	
429 	public int getRetryTime()
430 	{
431 		return retryTime;
432 	}
433 
434 	public String getTaglineFormat()
435 	{
436 		return taglineFormat;
437 	}
438 	
439 	public boolean isUseContinuationCoverPage()
440 	{
441 		return useContinuationCoverPage;
442 	}
443 	
444 	public boolean isUsePrivateTagLine()
445 	{
446 		return usePrivateTagLine;
447 	}
448 	
449 	public void setAssignedModem(String assignedModem)
450 	{
451 		this.assignedModem = assignedModem;
452 	}
453 	
454 	public void setChoppingThreshold(double choppingThreshold)
455 	{
456 		this.choppingThreshold = choppingThreshold;
457 	}
458 	
459 	public void setClientDialString(String clientDialString)
460 	{
461 		this.clientDialString = clientDialString;
462 	}
463 	
464 	public void setClientJobTag(String clientJobTag)
465 	{
466 		this.clientJobTag = clientJobTag;
467 	}
468 	
469 	public void setClientMachineName(String clientMachineName)
470 	{
471 		this.clientMachineName = clientMachineName;
472 	}
473 	
474 	public void setClientMinimumSignallingRate(int clientMinimumSignallingRate)
475 	{
476 		this.clientMinimumSignallingRate = clientMinimumSignallingRate;
477 	}
478 	
479 	public void setClientSchedulingPriority(String clientSchedulingPriority)
480 	{
481 		this.clientSchedulingPriority = clientSchedulingPriority;
482 	}
483 	
484 	public void setCommunicationIdentifier(String communicationIdentifier)
485 	{
486 		this.communicationIdentifier = communicationIdentifier;
487 	}
488 	
489 	public void setConsecutiveFailedDials(int consecutiveFailedDials)
490 	{
491 		this.consecutiveFailedDials = consecutiveFailedDials;
492 	}
493 	
494 	public void setConsecutiveFailedTries(int consecutiveFailedTries)
495 	{
496 		this.consecutiveFailedTries = consecutiveFailedTries;
497 	}
498 	
499 	public void setDesiredDataFormat(String desiredDataFormat)
500 	{
501 		this.desiredDataFormat = desiredDataFormat;
502 	}
503 	
504 	public void setDesiredECM(String desiredECM)
505 	{
506 		this.desiredECM = desiredECM;
507 	}
508 	
509 	public void setDesiredMinScanline(String desiredMinScanline)
510 	{
511 		this.desiredMinScanline = desiredMinScanline;
512 	}
513 	
514 	public void setDesiredSignallingRate(String desiredSignallingRate)
515 	{
516 		this.desiredSignallingRate = desiredSignallingRate;
517 	}
518 	
519 	public void setDestinationCompanyName(String destinationCompanyName)
520 	{
521 		this.destinationCompanyName = destinationCompanyName;
522 	}
523 	
524 	public void setDestinationLocation(String destinationLocation)
525 	{
526 		this.destinationLocation = destinationLocation;
527 	}
528 	
529 	public void setDestinationPassword(String destinationPassword)
530 	{
531 		this.destinationPassword = destinationPassword;
532 	}
533 	
534 	public void setDestinationSubAddress(String destinationSubAddress)
535 	{
536 		this.destinationSubAddress = destinationSubAddress;
537 	}
538 	
539 	public void setGroupID(int groupID)
540 	{
541 		this.groupID = groupID;
542 	}
543 	
544 	public void setHorizontalResolution(int horizontalResolution)
545 	{
546 		this.horizontalResolution = horizontalResolution;
547 	}
548 	
549 	public void setJobDoneOperation(String jobDoneOperation)
550 	{
551 		this.jobDoneOperation = jobDoneOperation;
552 	}
553 	
554 	public void setJobType(JobType jobType)
555 	{
556 		this.jobType = jobType;
557 	}
558 	
559 	public void setKillTime(String killTime)
560 	{
561 		this.killTime = killTime;
562 	}
563 	
564 	public void setPageChopping(PageChopping pageChopping)
565 	{
566 		this.pageChopping = pageChopping;
567 	}
568 
569 	public void setReceiver(String receiver)
570 	{
571 		this.receiver = receiver;
572 	}
573 	
574 	public void setRetryTime(int retryTime)
575 	{
576 		this.retryTime = retryTime;
577 	}
578 	
579 	public void setTaglineFormat(String taglineFormat)
580 	{
581 		this.taglineFormat = taglineFormat;
582 	}
583 	
584 	public void setUseContinuationCoverPage(boolean useContinuationCoverPage)
585 	{
586 		this.useContinuationCoverPage = useContinuationCoverPage;
587 	}
588 	
589 	public void setUsePrivateTagLine(boolean usePrivateTagLine)
590 	{
591 		this.usePrivateTagLine = usePrivateTagLine;
592 	}
593 	
594 	public void setVerticalResolution(int verticalResolution)
595 	{
596 		this.verticalResolution = verticalResolution;
597 	}
598 	
599 	public enum State { 
600 		BLOCKED,
601 		DONE,
602 		FAILED,
603 		PENDING,
604 		RUNNING,
605 		SLEEPING,
606 		SUSPENDED,
607 		UNDEFINED,
608 		WAITING,
609 	}
610 
611 	public enum JobType { 
612 		FACSIMILE,
613 		PAGER,
614 	}
615 	
616 	public enum PageChopping {
617 		DISABLED,
618 		DEFAULT,
619 		ALL,
620 		LAST,
621 	}
622 
623 }