com.clover.sdk.v1.printer.job

Class PrintJob

java.lang.Object

com.clover.sdk.v1.printer.job.PrintJob

All Implemented Interfaces:

Parcelable

Direct Known Subclasses:

BalanceInquiryPrintJob, GiftCardPrintJob, ImagePrintJob, ImagePrintJob2, MultipleImagePrintJob, StaticOrderBasedPrintJob, TestFiscalPrintJob, TestOrderPrintJob, TestReceiptPrintJob, TextPrintJob, TokenRequestBasedPrintJob, ViewPrintJob

public abstract class PrintJob
extends Object
implements Parcelable

Base class for print jobs. Flags may be added to a PrintJob to alter the results. Subclasses may automatically add some flags. Some flags are incompatible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrintJob.Builder

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_BILL Indicate this print out is a bill of sale, transaction such as payments will not print out
static int	FLAG_CUSTOMER Print receipt for the customer with appropriate verbiage and without signature line
static int	FLAG_EXPEDITOR When this flag is set on a print job for an order receipt it will print subtitle "Expo Receipt" or localized version of it.
static int	FLAG_FORCE_SIGNATURE Force customer signature line on print out even if normally not required
static int	FLAG_FORCE_TIP Force customer tip line on print out even if normally not required
static int	FLAG_MERCHANT Print receipt for the merchant with signature line if required
static int	FLAG_NO_SIGNATURE Do not show customer signature line on print out even if normally required
static int	FLAG_NO_TIP
static int	FLAG_NONE
static int	FLAG_REFUND Indicate this print job is for a refund, additional refund information will be included on print out
static int	FLAG_REPRINT Indicate this is a reprint on the print out
static int	FLAG_SALE Deprecated.
static int	FLAG_UNLABELED_ITEMS When this flag is set on a print job for an order receipt it will print subtitle "Unlabeled Items" or localized version of it.
static int	FLAG_USE_PRINT_GROUP Enable the printing of print groups for the receipt.
int	flags
boolean	printToAny Indicate that this job should be printed to any available printer in case the default is not available.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrintJob(int flags) Deprecated.
protected	PrintJob(Parcel in)
protected	PrintJob(PrintJob.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	cancel()
int	describeContents()
abstract Category	getPrinterCategory()
void	print(Context context, Account account) Send this PrintJob to the default printer.
void	print(Context context, Account account, Printer printer) Send this PrintJob to the specified printer.
void	writeToParcel(Parcel dest, int f)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_NONE

public static final int FLAG_NONE

See Also:

Constant Field Values

FLAG_REPRINT

public static final int FLAG_REPRINT

Indicate this is a reprint on the print out

See Also:

Constant Field Values

FLAG_BILL

public static final int FLAG_BILL

Indicate this print out is a bill of sale, transaction such as payments will not print out

See Also:

Constant Field Values

FLAG_SALE

@Deprecated
public static final int FLAG_SALE

Deprecated.

See Also:

Constant Field Values

FLAG_REFUND

public static final int FLAG_REFUND

Indicate this print job is for a refund, additional refund information will be included on print out

See Also:

Constant Field Values

FLAG_NO_SIGNATURE

public static final int FLAG_NO_SIGNATURE

Do not show customer signature line on print out even if normally required

See Also:

Constant Field Values

FLAG_FORCE_SIGNATURE

public static final int FLAG_FORCE_SIGNATURE

Force customer signature line on print out even if normally not required

See Also:

Constant Field Values

FLAG_CUSTOMER

public static final int FLAG_CUSTOMER

Print receipt for the customer with appropriate verbiage and without signature line

See Also:

Constant Field Values

FLAG_MERCHANT

public static final int FLAG_MERCHANT

Print receipt for the merchant with signature line if required

See Also:

Constant Field Values

FLAG_USE_PRINT_GROUP

public static final int FLAG_USE_PRINT_GROUP

Enable the printing of print groups for the receipt. Equivalent to the builder method.

See Also:

PrintJob.Builder.includePrintGroups(boolean), Constant Field Values

FLAG_EXPEDITOR

public static final int FLAG_EXPEDITOR

When this flag is set on a print job for an order receipt it will print subtitle "Expo Receipt" or localized version of it. Also, please make sure you are printing whole order when you are setting this flag. The title "Expo Receipt" will help expeditor at restaurant to quickly identify this is a whole order receipt and he/she can assemble the order without missing a single item

Note : you can either set this flag FLAG_EXPEDITOR or FLAG_UNLABELED_ITEMS but not both on a same print job

See Also:

Constant Field Values

FLAG_UNLABELED_ITEMS

public static final int FLAG_UNLABELED_ITEMS

When this flag is set on a print job for an order receipt it will print subtitle "Unlabeled Items" or localized version of it. Please, make sure when you are setting this flag on a print job for an order receipt, print only unlabeled items, you can use StaticOrderPrintJob.Builder.itemIds(ArrayList) to pass list of unlabeled line item ids.

you can either set this flag or FLAG_UNLABELED_ITEMS FLAG_EXPEDITOR but not both on a same print job

See Also:

Constant Field Values

FLAG_NO_TIP

public static final int FLAG_NO_TIP

See Also:

Constant Field Values

FLAG_FORCE_TIP

public static final int FLAG_FORCE_TIP

Force customer tip line on print out even if normally not required

See Also:

Constant Field Values

flags

public final int flags

printToAny

public final boolean printToAny

Indicate that this job should be printed to any available printer in case the default is not available. Defaults to false.

Constructor Detail

PrintJob

@Deprecated
protected PrintJob(int flags)

Deprecated.

PrintJob

protected PrintJob(PrintJob.Builder builder)

PrintJob

protected PrintJob(Parcel in)

Method Detail

getPrinterCategory

public abstract Category getPrinterCategory()

print

public void print(Context context,
                  Account account)

Send this PrintJob to the default printer.

print

public void print(Context context,
                  Account account,
                  Printer printer)

Send this PrintJob to the specified printer.

cancel

public void cancel()

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int f)

Specified by:

writeToParcel in interface Parcelable