1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.printservice;
import android.os.RemoteException;
import android.print.PrintJobInfo;
import android.util.Log;
/**
* 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.
*/
public final class PrintJob {
private static final String LOG_TAG = "PrintJob";
private final IPrintServiceClient mPrintServiceClient;
private final PrintDocument mDocument;
private PrintJobInfo mCachedInfo;
PrintJob(PrintJobInfo jobInfo, IPrintServiceClient client) {
mCachedInfo = jobInfo;
mPrintServiceClient = client;
mDocument = new PrintDocument(mCachedInfo.getId(), client, jobInfo.getDocumentInfo());
}
/**
* Gets the unique print job id.
*
* @return The id.
*/
public int getId() {
return mCachedInfo.getId();
}
/**
* Gets the {@link PrintJobInfo} that describes this job.
* <p>
* <strong>Node:</strong>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.
* </p>
*
* @return The print job info.
*/
public PrintJobInfo getInfo() {
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;
}
/**
* Gets the document of this print job.
*
* @return The document.
*/
public PrintDocument getDocument() {
return mDocument;
}
/**
* Gets whether this print job is queued. Such a print job is
* ready to be printed and can be started.
*
* @return Whether the print job is queued.
*
* @see #start()
*/
public boolean isQueued() {
return getInfo().getState() == PrintJobInfo.STATE_QUEUED;
}
/**
* 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)
*/
public boolean isStarted() {
return getInfo().getState() == PrintJobInfo.STATE_STARTED;
}
/**
* Starts the print job. You should call this method if {@link
* #isQueued()} returns true and you started printing.
*
* @return Whether the job as started.
*
* @see #isQueued()
*/
public boolean start() {
if (isQueued()) {
return setState(PrintJobInfo.STATE_STARTED);
}
return false;
}
/**
* 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()
*/
public boolean complete() {
if (isStarted()) {
return setState(PrintJobInfo.STATE_COMPLETED);
}
return false;
}
/**
* Fails the print job. You should call this method if {@link
* #isStarted()} returns true you filed while printing.
*
* @param error The reason for the failure.
* @return Whether the job was failed.
*
* @see #isStarted()
*/
public boolean fail(CharSequence error) {
// TODO: Propagate the error message to the UI.
if (isStarted()) {
return setState(PrintJobInfo.STATE_FAILED);
}
return false;
}
/**
* Cancels the print job. You should call this method if {@link
* #isStarted()} returns true and you canceled the print job as a
* response to a call to {@link PrintService#onRequestCancelPrintJob(
* PrintJob)}.
*
* @return Whether the job as canceled.
*
* @see #isStarted()
*/
public boolean cancel() {
if (isStarted()) {
return setState(PrintJobInfo.STATE_CANCELED);
}
return false;
}
/**
* 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.
*/
public boolean setTag(String tag) {
try {
return mPrintServiceClient.setPrintJobTag(mCachedInfo.getId(), tag);
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error setting tag for job: " + mCachedInfo.getId(), re);
}
return false;
}
@Override
public boolean equals(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() == other.mCachedInfo.getId());
}
@Override
public int hashCode() {
return mCachedInfo.getId();
}
private boolean setState(int state) {
try {
if (mPrintServiceClient.setPrintJobState(mCachedInfo.getId(), state)) {
// 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);
return true;
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error setting the state of job: " + mCachedInfo.getId(), re);
}
return false;
}
}
|
