FileDocCategorySizeDatePackage
PrintJob.javaAPI DocAndroid 5.1 API5954Thu Mar 12 22:22:10 GMT 2015android.print

PrintJob

public final class PrintJob extends Object
This class represents a print job from the perspective of an application. It contains behavior methods for performing operations on it as well as methods for querying its state. A snapshot of the print job state is represented by the {@link PrintJobInfo} class. The state of a print job may change over time. An application receives instances of this class when creating a print job or querying for its print jobs.

Fields Summary
private final PrintManager
mPrintManager
private PrintJobInfo
mCachedInfo
Constructors Summary
PrintJob(PrintJobInfo info, PrintManager printManager)

        mCachedInfo = info;
        mPrintManager = printManager;
    
Methods Summary
public voidcancel()
Cancels this print job. You can request cancellation of a queued, started, blocked, or failed print job.

see
#isQueued()
see
#isStarted()
see
#isBlocked()
see
#isFailed()

        final int state = getInfo().getState();
        if (state == PrintJobInfo.STATE_QUEUED
                || state == PrintJobInfo.STATE_STARTED
                || state == PrintJobInfo.STATE_BLOCKED
                || state == PrintJobInfo.STATE_FAILED) {
            mPrintManager.cancelPrintJob(mCachedInfo.getId());
        }
    
public booleanequals(java.lang.Object obj)

        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        PrintJob other = (PrintJob) obj;
        return mCachedInfo.getId().equals(other.mCachedInfo.getId());
    
public PrintJobIdgetId()
Gets the unique print job id.

return
The id.

        return mCachedInfo.getId();
    
public PrintJobInfogetInfo()
Gets the {@link 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.

return
The print job info.

        if (isInImmutableState()) {
            return mCachedInfo;
        }
        PrintJobInfo info = mPrintManager.getPrintJobInfo(mCachedInfo.getId());
        if (info != null) {
            mCachedInfo = info;
        }
        return mCachedInfo;
    
public inthashCode()

        return mCachedInfo.getId().hashCode();
    
public booleanisBlocked()
Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition. You can request a cancellation via {@link #cancel()}.

return
Whether the print job is blocked.
see
#cancel()

        return getInfo().getState() == PrintJobInfo.STATE_BLOCKED;
    
public booleanisCancelled()
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. You cannot restart such a print job.

return
Whether the print job is cancelled.

        return getInfo().getState() == PrintJobInfo.STATE_CANCELED;
    
public booleanisCompleted()
Gets whether this print job is completed. Such a print job is successfully printed. You can neither cancel nor restart such a print job.

return
Whether the print job is completed.

        return getInfo().getState() == PrintJobInfo.STATE_COMPLETED;
    
public booleanisFailed()
Gets whether this print job is failed. Such a print job is not successfully printed due to an error. You can request a restart via {@link #restart()} or cancel via {@link #cancel()}.

return
Whether the print job is failed.
see
#restart()
see
#cancel()

        return getInfo().getState() == PrintJobInfo.STATE_FAILED;
    
private booleanisInImmutableState()

        final int state = mCachedInfo.getState();
        return state == PrintJobInfo.STATE_COMPLETED
                || state == PrintJobInfo.STATE_CANCELED;
    
public booleanisQueued()
Gets whether this print job is queued. Such a print job is ready to be printed. You can request a cancellation via {@link #cancel()}.

return
Whether the print job is queued.
see
#cancel()

        return getInfo().getState() == PrintJobInfo.STATE_QUEUED;
    
public booleanisStarted()
Gets whether this print job is started. Such a print job is being printed. You can request a cancellation via {@link #cancel()}.

return
Whether the print job is started.
see
#cancel()

        return getInfo().getState() == PrintJobInfo.STATE_STARTED;
    
public voidrestart()
Restarts this print job. You can request restart of a failed print job.

see
#isFailed()

        if (isFailed()) {
            mPrintManager.restartPrintJob(mCachedInfo.getId());
        }