com.groupdocs.signature.domain.extensions.mailmark2d

Class Mailmark2D

java.lang.Object

com.groupdocs.signature.domain.extensions.mailmark2d.Mailmark2D

public class Mailmark2D
extends Object

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark

Constructor Summary

Constructors

Constructor and Description
Mailmark2D() Creates Royal Mail Mailmark combined data with default primary and secondary data values.

Method Summary

Modifier and Type	Method and Description
Object	deepClone() Gets a copy of this object.
String	getClass_() Identifies the class of the item.
String	getCustomerContent() Optional space for use by customer.
int	getCustomerContentEncodeMode() Encode mode of DataMatrix barcode.
int	getDataMatrixType() 2D Mailmark Type defines size of Data Matrix barcode.
String	getDestinationPostCodeAndDPS() Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters.
String	getInformationTypeID() Identifies the Royal Mail Mailmark barcode payload for each product type.
int	getItemID() Identifies the unique item within the Supply Chain ID.
String	getReturnToSenderPostCode() Contains the Return to Sender Post Code but no DPS.
String	getRTSFlag() Flag which indicates what level of Return to Sender service is being requested.
int	getSupplyChainID() Identifies the unique group of customers involved in the mailing.
String	getUPUCountryID() Identifies the UPU Country ID.Max length: 4 characters.
String	getVersionID() Identifies the barcode version as relevant to each Information Type ID.
void	setClass(String value) Identifies the class of the item.
void	setCustomerContent(String value) Optional space for use by customer.
void	setCustomerContentEncodeMode(int value) Encode mode of DataMatrix barcode.
void	setDataMatrixType(int value) 2D Mailmark Type defines size of Data Matrix barcode.
void	setDestinationPostCodeAndDPS(String value) Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters.
void	setInformationTypeID(String value) Identifies the Royal Mail Mailmark barcode payload for each product type.
void	setItemID(int value) Identifies the unique item within the Supply Chain ID.
void	setReturnToSenderPostCode(String value) Contains the Return to Sender Post Code but no DPS.
void	setRTSFlag(String value) Flag which indicates what level of Return to Sender service is being requested.
void	setSupplyChainID(int value) Identifies the unique group of customers involved in the mailing.
void	setUPUCountryID(String value) Identifies the UPU Country ID.Max length: 4 characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mailmark2D

public Mailmark2D()

Creates Royal Mail Mailmark combined data with default primary and secondary data values.

Method Detail

deepClone

public final Object deepClone()

Gets a copy of this object.

getClass_

public final String getClass_()

Identifies the class of the item.

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

getCustomerContent

public final String getCustomerContent()

Optional space for use by customer.

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

getCustomerContentEncodeMode

public final int getCustomerContentEncodeMode()

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

getDataMatrixType

public final int getDataMatrixType()

2D Mailmark Type defines size of Data Matrix barcode.

getDestinationPostCodeAndDPS

public final String getDestinationPostCodeAndDPS()

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

getInformationTypeID

public final String getInformationTypeID()

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

getItemID

public final int getItemID()

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

getReturnToSenderPostCode

public final String getReturnToSenderPostCode()

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

getRTSFlag

public final String getRTSFlag()

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

getSupplyChainID

public final int getSupplyChainID()

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

getUPUCountryID

public final String getUPUCountryID()

Identifies the UPU Country ID.Max length: 4 characters.

getVersionID

public final String getVersionID()

Identifies the barcode version as relevant to each Information Type ID.

Valid Values: "1" - currently used only this value (default) "0" and "2" to "9" and "A" to "Z" spare reserved for potential future use.

setClass

public final void setClass(String value)

Identifies the class of the item.

Valid Values: "1" - 1C (Retail) "2" - 2C(Retail) "3" - Economy(Retail) "5" - Deferred(Retail) "8" - Premium(Network Access) "9" - Standard(Network Access)

setCustomerContent

public final void setCustomerContent(String value)

Optional space for use by customer.

Max length by Type Mailmark2DType: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters

setCustomerContentEncodeMode

public final void setCustomerContentEncodeMode(int value)

Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode

setDataMatrixType

public final void setDataMatrixType(int value)

2D Mailmark Type defines size of Data Matrix barcode.

setDestinationPostCodeAndDPS

public final void setDestinationPostCodeAndDPS(String value)

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. Max length is 9.

setInformationTypeID

public final void setInformationTypeID(String value)

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values: "0" - Domestic Sorted and Unsorted "A" - On-line Postage "B" - Franking "C" - Consolidation

setItemID

public final void setItemID(int value)

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

setReturnToSenderPostCode

public final void setReturnToSenderPostCode(String value)

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

setRTSFlag

public final void setRTSFlag(String value)

Flag which indicates what level of Return to Sender service is being requested. Max length is 1

setSupplyChainID

public final void setSupplyChainID(int value)

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

setUPUCountryID

public final void setUPUCountryID(String value)

Identifies the UPU Country ID.Max length: 4 characters.