public final class PrintJob
extends java.lang.Object
implements java.io.Serializable
The PrintJob class contains the details of a remote print server job.
A list of print jobs is returned by the AdminSession.getPrintJobs () method. The returned print jobs can then be used to pause/continue or delete print jobs using the AdminSession PausePrintJob(), ContinuePrintJob() and DeletePrintJob() methods.
Modifier and Type | Field and Description |
---|---|
static int |
Complete |
static int |
DestCartChg |
static int |
DestFormChg |
static int |
DestNoPaper |
static int |
DestOffline |
static int |
DestPaused |
static int |
DestPenChg |
static int |
Error |
static int |
Intervention |
static int |
Notify |
static int |
Paused |
static int |
PrintDel |
static int |
Printing |
static int |
Queued |
static int |
Spooling |
static int |
StatusMask |
Constructor and Description |
---|
PrintJob(int id)
Class constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getComment()
Return the print job comment
|
int |
getJobNumber()
Return the print server assigned file number.
|
int |
getPrintPosition()
Return the print jobs queue position
|
int |
getPrintStatus()
Return the extra status bits that are set when a job is in a printing state
|
int |
getPriority()
Return theprint job priority, where 1 is the lowest priority and 99 is the highest priority.
|
java.util.Date |
getQueuedDateTime()
Return the date/time that the print job was submitted
|
java.lang.String |
getSpoolDocument()
Return the spool document name.
|
int |
getSpoolFileSize()
Return the spool file size, in bytes.
|
java.lang.String |
getStatusString()
Return the print job status string
|
java.lang.String |
getUserName()
Return the name of the user who submitted the print request.
|
boolean |
isPaused()
Determine if the print job is in a paused state
|
boolean |
isPrinting()
Determine if the print job is in a printing state
|
boolean |
isQueued()
Determine if the print job is in a queued state
|
boolean |
isSpooling()
Determine if the print job is in a spooling state
|
void |
setComment(java.lang.String comm)
Set the print jobs comment
|
void |
setDocument(java.lang.String doc)
Set the print job document name
|
void |
setJobNumber(int id)
Set the print job id
|
void |
setPrintPosition(int pos)
Set the jobs print position
|
void |
setPriority(int pri)
Set the print job priority
|
void |
setQueuedDateTime(java.util.Date dattim)
Set the submitted print job date/time
|
void |
setSpoolFileSize(int siz)
Set the print job file size
|
void |
setStatus(int sts)
Set the print job status bits
|
void |
setUserName(java.lang.String usr)
Set the job user name
|
java.lang.String |
toString()
Return the print job information as a string
|
public static final int Queued
public static final int Paused
public static final int Spooling
public static final int Printing
public static final int StatusMask
public static final int Complete
public static final int Intervention
public static final int Error
public static final int DestOffline
public static final int DestPaused
public static final int Notify
public static final int DestNoPaper
public static final int DestFormChg
public static final int DestCartChg
public static final int DestPenChg
public static final int PrintDel
public final java.lang.String getComment()
public final int getJobNumber()
public final int getPrintPosition()
public final int getPrintStatus()
public final int getPriority()
public final java.util.Date getQueuedDateTime()
public final java.lang.String getSpoolDocument()
public final int getSpoolFileSize()
public final java.lang.String getStatusString()
public final java.lang.String getUserName()
public final boolean isPaused()
public final boolean isPrinting()
public final boolean isQueued()
public final boolean isSpooling()
public final void setComment(java.lang.String comm)
comm
- Print job comment stringpublic final void setDocument(java.lang.String doc)
doc
- Document namepublic final void setJobNumber(int id)
id
- Print job idpublic final void setPrintPosition(int pos)
pos
- Print positionpublic final void setPriority(int pri)
pri
- Print job prioritypublic final void setQueuedDateTime(java.util.Date dattim)
dattim
- Date/time that the job was submittedpublic final void setSpoolFileSize(int siz)
siz
- Spool file sizepublic final void setStatus(int sts)
sts
- Print job status bitspublic final void setUserName(java.lang.String usr)
usr
- Job owner user namepublic final java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.