com.starla.smb
Class SMBPrintJob

java.lang.Object
  |
  +--com.starla.smb.SMBPrintJob

public final class SMBPrintJob
extends java.lang.Object

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

Queued

public static final int Queued
Print queue entry is pending

Paused

public static final int Paused
Print queue entry is paused

Spooling

public static final int Spooling
Print queue entry is spooling

Printing

public static final 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.

StatusMask

public static final int StatusMask
Mask to extract the main print job status from the job status value. If the print job is in a printing state the remaining bits indicate extra detail about the job status.

Complete

public static final int Complete
Print job has completed

Intervention

public static final int Intervention
Print job requires user intervention, comment may contain extra information

Error

public static final int Error
Print job error

DestOffline

public static final int DestOffline
Destination print device is offline

DestPaused

public static final int DestPaused
Destination print device is paused

Notify

public static final int Notify
An alert has been raised

DestNoPaper

public static final int DestNoPaper
Destination print device is out of paper

DestFormChg

public static final int DestFormChg
Destination printer is waiting for a form change

DestCartChg

public static final int DestCartChg
Destination printer is waiting for a cartridge change

DestPenChg

public static final int DestPenChg
Destination printer is waiting for a pen change

PrintDel

public static final int PrintDel
The job has been deleted
Method Detail

getComment

public final java.lang.String getComment()
Return the print job comment
Returns:
Print job comment string

getJobNumber

public final int getJobNumber()
Return the print server assigned file number.
Returns:
Print server assigned file number.

getPrintPosition

public final int getPrintPosition()
Return the print jobs queue position
Returns:
Print job queue position

getPrintStatus

public final int getPrintStatus()
Return the extra status bits that are set when a job is in a printing state
Returns:
Extra status bits if the job is in a printing state, else zero

getPriority

public final int getPriority()
Return theprint job priority, where 1 is the lowest priority and 99 is the highest priority.
Returns:
Print job priority

getQueuedDateTime

public final java.util.Date getQueuedDateTime()
Return the date/time that the print job was submitted
Returns:
Date/time that the print job was submitted

getSpoolDocument

public final java.lang.String getSpoolDocument()
Return the spool document name.
Returns:
Spool document name string.

getSpoolFileSize

public final int getSpoolFileSize()
Return the spool file size, in bytes.
Returns:
Spool file size in bytes.

getStatusString

public final java.lang.String getStatusString()
Return the print job status string
Returns:
Print job status string

getUserName

public final java.lang.String getUserName()
Return the name of the user who submitted the print request.
Returns:
User name string

isPaused

public final boolean isPaused()
Determine if the print job is in a paused state
Returns:
true if the print job is in a paused state, else false

isPrinting

public final boolean isPrinting()
Determine if the print job is in a printing state
Returns:
true is the print job is in a printing state, else false

isQueued

public final boolean isQueued()
Determine if the print job is in a queued state
Returns:
true if the print job is in a queued state, else false

isSpooling

public final boolean isSpooling()
Determine if the print job is in a spooling state
Returns:
true is the print job is in a spooling state, else false

toString

public final java.lang.String toString()
Return the print job information as a string
Returns:
Print job information string
Overrides:
toString in class java.lang.Object