PrintJob

block

boolean block (String reason)

Blocks the print job. You should call this method if isStarted() returns true and you need to block the print job. For example, the user has to add some paper to continue printing. To resume the print job call start(). To change the reason call setStatus(CharSequence).

cancel

boolean cancel ()

Cancels the print job. You should call this method if isQueued() or or #isBlocked() returns true and you canceled the print job as a response to a call to onRequestCancelPrintJob(PrintJob).

complete

boolean complete ()

Completes the print job. You should call this method if isStarted() returns true and you are done printing.

equals

boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

fail

boolean fail (String error)

Fails the print job. You should call this method if isQueued() or isStarted() or isBlocked() returns true you failed while printing.

getAdvancedIntOption

int getAdvancedIntOption (String key)

Gets the value of an advanced (printer specific) print option.

getAdvancedStringOption

String getAdvancedStringOption (String key)

Gets the value of an advanced (printer specific) print option.

getDocument

PrintDocument getDocument ()

Gets the printed document.

getId

PrintJobId getId ()

Gets the unique print job id.

getInfo

PrintJobInfo getInfo ()

Gets the PrintJobInfo that describes this job.

Node:The returned info object is a snapshot of the current print job state. Every call to this method returns a fresh info object that reflects the current print job state.

getTag

String getTag ()

Gets the print job tag.

hasAdvancedOption

boolean hasAdvancedOption (String key)

Gets whether this job has a given advanced (printer specific) print option.

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

isBlocked

boolean isBlocked ()

Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition and can be started or canceled or failed.

isCancelled

boolean isCancelled ()

Gets whether this print job is cancelled. Such a print job was cancelled as a result of a user request. This is a final state.

isCompleted

boolean isCompleted ()

Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.

isFailed

boolean isFailed ()

Gets whether this print job is failed. Such a print job is not successfully printed due to an error. This is a final state.

isQueued

boolean isQueued ()

Gets whether this print job is queued. Such a print job is ready to be printed and can be started or cancelled.

isStarted

boolean isStarted ()

Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.

setProgress

void setProgress (float progress)

Sets the progress of this print job as a fraction of 1.

setStatus

void setStatus (CharSequence status)

Sets the status of this print job. This should be a human readable, short, and translated description of the current state of the print job.

This overrides any previously set status set via setStatus(CharSequence), setStatus(int), block(String), or fail(String),

setStatus

void setStatus (int statusResId)

Sets the status of this print job as a string resource.

This overrides any previously set status set via setStatus(CharSequence), setStatus(int), block(String), or fail(String),

setTag

boolean setTag (String tag)

Sets a tag that is valid in the context of a PrintService and is not interpreted by the system. For example, a print service may set as a tag the key of the print job returned by a remote print server, if the printing is off handed to a cloud based service.

start

boolean start ()

Starts the print job. You should call this method if isQueued() or isBlocked() returns true and you started resumed printing.

This resets the print status to null. Set the new status by using setStatus(int).