Mailmark2D
Inheritance: java.lang.Object
public class Mailmark2D
Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark
Constructors
| Constructor | Description |
|---|---|
| Mailmark2D() | Creates Royal Mail Mailmark combined data with default primary and secondary data values. |
Methods
| Method | Description |
|---|---|
| getUPUCountryID() | Identifies the UPU Country ID.Max length: 4 characters. |
| setUPUCountryID(String value) | Identifies the UPU Country ID.Max length: 4 characters. |
| getInformationTypeID() | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| setInformationTypeID(String value) | Identifies the Royal Mail Mailmark barcode payload for each product type. |
| getVersionID() | Identifies the barcode version as relevant to each Information Type ID. |
| getClass_() | Identifies the class of the item. |
| setClass(String value) | Identifies the class of the item. |
| getSupplyChainID() | Identifies the unique group of customers involved in the mailing. |
| setSupplyChainID(int value) | Identifies the unique group of customers involved in the mailing. |
| getItemID() | Identifies the unique item within the Supply Chain ID. |
| setItemID(int value) | Identifies the unique item within the Supply Chain ID. |
| getDestinationPostCodeAndDPS() | Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. |
| setDestinationPostCodeAndDPS(String value) | Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. |
| getRTSFlag() | Flag which indicates what level of Return to Sender service is being requested. |
| setRTSFlag(String value) | Flag which indicates what level of Return to Sender service is being requested. |
| getReturnToSenderPostCode() | Contains the Return to Sender Post Code but no DPS. |
| setReturnToSenderPostCode(String value) | Contains the Return to Sender Post Code but no DPS. |
| getCustomerContent() | Optional space for use by customer. |
| setCustomerContent(String value) | Optional space for use by customer. |
| getCustomerContentEncodeMode() | Encode mode of DataMatrix barcode. |
| setCustomerContentEncodeMode(int value) | Encode mode of DataMatrix barcode. |
| getDataMatrixType() | 2D Mailmark Type defines size of Data Matrix barcode. |
| setDataMatrixType(int value) | 2D Mailmark Type defines size of Data Matrix barcode. |
| deepClone() | Gets a copy of this object. |
Mailmark2D()
public Mailmark2D()
Creates Royal Mail Mailmark combined data with default primary and secondary data values.
getUPUCountryID()
public final String getUPUCountryID()
Identifies the UPU Country ID.Max length: 4 characters.
Returns: java.lang.String
setUPUCountryID(String value)
public final void setUPUCountryID(String value)
Identifies the UPU Country ID.Max length: 4 characters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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
Returns: java.lang.String
setInformationTypeID(String value)
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
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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.
Returns: java.lang.String
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)
Returns: java.lang.String
setClass(String value)
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)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getSupplyChainID()
public final int getSupplyChainID()
Identifies the unique group of customers involved in the mailing. Max value: 9999999.
Returns: int
setSupplyChainID(int value)
public final void setSupplyChainID(int value)
Identifies the unique group of customers involved in the mailing. Max value: 9999999.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
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.
Returns: int
setItemID(int value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
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.
Returns: java.lang.String
setDestinationPostCodeAndDPS(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getRTSFlag()
public final String getRTSFlag()
Flag which indicates what level of Return to Sender service is being requested. Max length is 1
Returns: java.lang.String
setRTSFlag(String value)
public final void setRTSFlag(String value)
Flag which indicates what level of Return to Sender service is being requested. Max length is 1
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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.
Returns: java.lang.String
setReturnToSenderPostCode(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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
Returns: java.lang.String
setCustomerContent(String value)
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
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getCustomerContentEncodeMode()
public final int getCustomerContentEncodeMode()
Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode
Returns: int
setCustomerContentEncodeMode(int value)
public final void setCustomerContentEncodeMode(int value)
Encode mode of DataMatrix barcode. Default value: DataMatrixEncodeMode.C40. DataMatrixEncodeMode
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getDataMatrixType()
public final int getDataMatrixType()
2D Mailmark Type defines size of Data Matrix barcode.
Returns: int
setDataMatrixType(int value)
public final void setDataMatrixType(int value)
2D Mailmark Type defines size of Data Matrix barcode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
deepClone()
public final Object deepClone()
Gets a copy of this object.
Returns: java.lang.Object