|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.starla.smb.SMBPrintJob
SMB print queue entry class
The SMBPrintJob class contains the details of a remote print server job.
A list of print jobs is returned by the SMBAdminSession.getPrintJobs () method. The returned print jobs can then be used to pause/continue or delete print jobs using the SMBAdminSession PausePrintJob (), ContinuePrintJob () and DeletePrintJob () methods.
Field Summary | |
static int |
Complete
Print job has completed |
static int |
DestCartChg
Destination printer is waiting for a cartridge change |
static int |
DestFormChg
Destination printer is waiting for a form change |
static int |
DestNoPaper
Destination print device is out of paper |
static int |
DestOffline
Destination print device is offline |
static int |
DestPaused
Destination print device is paused |
static int |
DestPenChg
Destination printer is waiting for a pen change |
static int |
Error
Print job error |
static int |
Intervention
Print job requires user intervention, comment may contain extra information |
static int |
Notify
An alert has been raised |
static int |
Paused
Print queue entry is paused |
static int |
PrintDel
The job has been deleted |
static int |
Printing
Print queue entry is currently printing If the print job is in a printing state the remaining bits indicate extra detail about the job status. |
static int |
Queued
Print queue entry is pending |
static int |
Spooling
Print queue entry is spooling |
static int |
StatusMask
Mask to extract the main print job status from the job status value. |
Method Summary | |
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 |
java.lang.String |
toString()
Return the print job information as a string |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
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
Method Detail |
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 java.lang.String toString()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |