FileDocCategorySizeDatePackage
PrintJob.javaAPI DocAndroid 5.1 API12191Thu Mar 12 22:22:10 GMT 2015android.printservice

PrintJob

public final class PrintJob extends Object
This class represents a print job from the perspective of a print service. It provides APIs for observing the print job state and performing operations on the print job.

Note: All methods of this class must be invoked on the main application thread.

Fields Summary
private static final String
LOG_TAG
private final IPrintServiceClient
mPrintServiceClient
private final PrintDocument
mDocument
private android.print.PrintJobInfo
mCachedInfo
Constructors Summary
PrintJob(android.print.PrintJobInfo jobInfo, IPrintServiceClient client)


        
        mCachedInfo = jobInfo;
        mPrintServiceClient = client;
        mDocument = new PrintDocument(mCachedInfo.getId(), client,
                jobInfo.getDocumentInfo());
Methods Summary
public booleanblock(java.lang.String reason)
Blocks the print job. You should call this method if {@link #isStarted()} or {@link #isBlocked()} 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 {@link #start()}.

return
Whether the job was blocked.
see
#isStarted()
see
#isBlocked()

        PrintService.throwIfNotCalledOnMainThread();
        PrintJobInfo info = getInfo();
        final int state = info.getState();
        if (state == PrintJobInfo.STATE_STARTED
                || (state == PrintJobInfo.STATE_BLOCKED
                        && !TextUtils.equals(info.getStateReason(), reason))) {
            return setState(PrintJobInfo.STATE_BLOCKED, reason);
        }
        return false;
public booleancancel()
Cancels the print job. You should call this method if {@link #isQueued()} or {@link #isStarted() or #isBlocked()} returns true and you canceled the print job as a response to a call to {@link PrintService#onRequestCancelPrintJob(PrintJob)}.

return
Whether the job is canceled.
see
#isStarted()
see
#isQueued()
see
#isBlocked()

        PrintService.throwIfNotCalledOnMainThread();
        if (!isInImmutableState()) {
            return setState(PrintJobInfo.STATE_CANCELED, null);
        }
        return false;
public booleancomplete()
Completes the print job. You should call this method if {@link #isStarted()} returns true and you are done printing.

return
Whether the job as completed.
see
#isStarted()

        PrintService.throwIfNotCalledOnMainThread();
        if (isStarted()) {
            return setState(PrintJobInfo.STATE_COMPLETED, null);
        }
        return false;
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 booleanfail(java.lang.String error)
Fails the print job. You should call this method if {@link #isQueued()} or {@link #isStarted()} or {@link #isBlocked()} returns true you failed while printing.

param
error The human readable, short, and translated reason for the failure.
return
Whether the job was failed.
see
#isQueued()
see
#isStarted()
see
#isBlocked()

        PrintService.throwIfNotCalledOnMainThread();
        if (!isInImmutableState()) {
            return setState(PrintJobInfo.STATE_FAILED, error);
        }
        return false;
public intgetAdvancedIntOption(java.lang.String key)
Gets the value of an advanced (printer specific) print option.

param
key The option key.
return
The option value.

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getAdvancedIntOption(key);
public java.lang.StringgetAdvancedStringOption(java.lang.String key)
Gets the value of an advanced (printer specific) print option.

param
key The option key.
return
The option value.

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getAdvancedStringOption(key);
public PrintDocumentgetDocument()
Gets the printed document.

return
The document.

        PrintService.throwIfNotCalledOnMainThread();
        return mDocument;
public android.print.PrintJobIdgetId()
Gets the unique print job id.

return
The id.

        PrintService.throwIfNotCalledOnMainThread();
        return mCachedInfo.getId();
public android.print.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.

        PrintService.throwIfNotCalledOnMainThread();
        if (isInImmutableState()) {
            return mCachedInfo;
        }
        PrintJobInfo info = null;
        try {
            info = mPrintServiceClient.getPrintJobInfo(mCachedInfo.getId());
        } catch (RemoteException re) {
            Log.e(LOG_TAG, "Couldn't get info for job: " + mCachedInfo.getId(), re);
        }
        if (info != null) {
            mCachedInfo = info;
        }
        return mCachedInfo;
public java.lang.StringgetTag()
Gets the print job tag.

return
The tag or null.
see
#setTag(String)

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getTag();
public booleanhasAdvancedOption(java.lang.String key)
Gets whether this job has a given advanced (printer specific) print option.

param
key The option key.
return
Whether the option is present.

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().hasAdvancedOption(key);
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 and can be started or canceled or failed.

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

        PrintService.throwIfNotCalledOnMainThread();
        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.

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

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getState() == PrintJobInfo.STATE_CANCELED;
public booleanisCompleted()
Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.

return
Whether the print job is completed.
see
#complete()

        PrintService.throwIfNotCalledOnMainThread();
        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. This is a final state.

return
Whether the print job is failed.
see
#fail(CharSequence)

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

        final int state = mCachedInfo.getState();
        return state == PrintJobInfo.STATE_COMPLETED
                || state == PrintJobInfo.STATE_CANCELED
                || state == PrintJobInfo.STATE_FAILED;
public booleanisQueued()
Gets whether this print job is queued. Such a print job is ready to be printed and can be started or cancelled.

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

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getState() == PrintJobInfo.STATE_QUEUED;
public booleanisStarted()
Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.

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

        PrintService.throwIfNotCalledOnMainThread();
        return getInfo().getState() == PrintJobInfo.STATE_STARTED;
private booleansetState(int state, java.lang.String error)

        try {
            if (mPrintServiceClient.setPrintJobState(mCachedInfo.getId(), state, error)) {
                // Best effort - update the state of the cached info since
                // we may not be able to re-fetch it later if the job gets
                // removed from the spooler as a result of the state change.
                mCachedInfo.setState(state);
                mCachedInfo.setStateReason(error);
                return true;
            }
        } catch (RemoteException re) {
            Log.e(LOG_TAG, "Error setting the state of job: " + mCachedInfo.getId(), re);
        }
        return false;
public booleansetTag(java.lang.String tag)
Sets a tag that is valid in the context of a {@link 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.

param
tag The tag.
return
True if the tag was set, false otherwise.

        PrintService.throwIfNotCalledOnMainThread();
        if (isInImmutableState()) {
            return false;
        }
        try {
            return mPrintServiceClient.setPrintJobTag(mCachedInfo.getId(), tag);
        } catch (RemoteException re) {
            Log.e(LOG_TAG, "Error setting tag for job: " + mCachedInfo.getId(), re);
        }
        return false;
public booleanstart()
Starts the print job. You should call this method if {@link #isQueued()} or {@link #isBlocked()} returns true and you started resumed printing.

return
Whether the job was started.
see
#isQueued()
see
#isBlocked()

        PrintService.throwIfNotCalledOnMainThread();
        final int state = getInfo().getState();
        if (state == PrintJobInfo.STATE_QUEUED
                || state == PrintJobInfo.STATE_BLOCKED) {
            return setState(PrintJobInfo.STATE_STARTED, null);
        }
        return false;