Package com.aspose.barcode.complexbarcode

Class Mailmark2DCodetext

java.lang.Object
com.aspose.barcode.complexbarcode.Mailmark2DCodetext
All Implemented Interfaces:
IComplexCodetext
public class Mailmark2DCodetext extends Object implements IComplexCodetext
Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.

  • Constructor Details

    • Mailmark2DCodetext

      public Mailmark2DCodetext()
      Create default instance of Mailmark2DCodetext class.

  • Method Details

    • getUPUCountryID

      public String getUPUCountryID()
      Identifies the UPU Country ID.Max length: 4 characters.
      Returns:
      Country ID

    • setUPUCountryID

      public void setUPUCountryID(String value)
      Identifies the UPU Country ID.Max length: 4 characters.
      Parameters:
      value - Country ID

    • getInformationTypeID

      public String getInformationTypeID()
      Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: '0' - Domestic Sorted & Unsorted 'A' - Online Postage 'B' - Franking 'C' - Consolidation
      Returns:
      Information type ID

    • setInformationTypeID

      public void setInformationTypeID(String value)
      Identifies the Royal Mail Mailmark barcode payload for each product type. Valid Values: '0' - Domestic Sorted & Unsorted 'A' - Online Postage 'B' - Franking 'C' - Consolidation
      Parameters:
      value - Information type ID

    • getVersionID

      public String getVersionID()
      Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently '1'. '0' & '2' to '9' and 'A' to 'Z' spare reserved for potential future use.
      Returns:
      Version ID

    • setVersionID

      public void setVersionID(String value)
      Identifies the barcode version as relevant to each Information Type ID. Valid Values: Currently '1'. '0' & '2' to '9' and 'A' to 'Z' spare reserved for potential future use.
      Parameters:
      value - Version ID

    • getclass

      public String getclass()
      Identifies the class of the item. Valid Values: '1' - 1C (Retail) '2' - 2C (Retail) '3' - Economy (Retail) '5' - Deffered (Retail) '8' - Premium (Network Access) '9' - Standard (Network Access)
      Returns:
      class of the item

    • setclass

      public void setclass(String value)
      Identifies the class of the item. Valid Values: '1' - 1C (Retail) '2' - 2C (Retail) '3' - Economy (Retail) '5' - Deffered (Retail) '8' - Premium (Network Access) '9' - Standard (Network Access)
      Parameters:
      value - class of the item

    • getSupplyChainID

      public int getSupplyChainID()
      Identifies the unique group of customers involved in the mailing. Max value: 9999999.
      Returns:
      Supply chain ID

    • setSupplyChainID

      public void setSupplyChainID(int value)
      Identifies the unique group of customers involved in the mailing. Max value: 9999999.
      Parameters:
      value - Supply chain ID

    • getItemID

      public 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:
      item within the Supply Chain ID

    • setItemID

      public 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:
      value - item within the Supply Chain ID

    • getDestinationPostCodeAndDPS

      public 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.
      Returns:
      the Postcode of the Delivery Address with DPS

    • setDestinationPostCodeAndDPS

      public 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.
      Parameters:
      value - the Postcode of the Delivery Address with DPS

    • getRTSFlag

      public String getRTSFlag()
      Flag which indicates what level of Return to Sender service is being requested.
      Returns:
      RTS Flag

    • setRTSFlag

      public void setRTSFlag(String value)
      Flag which indicates what level of Return to Sender service is being requested.

    • getReturnToSenderPostCode

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

    • setReturnToSenderPostCode

      public 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:
      value - Return to Sender Post Code but no DPS

    • getCustomerContent

      public String getCustomerContent()
      Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters
      Returns:
      Customer content

    • setCustomerContent

      public void setCustomerContent(String value)
      Optional space for use by customer. Max length by Type: Type 7: 6 characters Type 9: 45 characters Type 29: 25 characters
      Parameters:
      value - Customer content

    • getCustomerContentEncodeMode

      public DataMatrixEncodeMode getCustomerContentEncodeMode()
      Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.
      Returns:
      Encode mode of Datamatrix barcode.

    • setCustomerContentEncodeMode

      public void setCustomerContentEncodeMode(DataMatrixEncodeMode value)
      Encode mode of Datamatrix barcode. Default value: EncodeMode.C40.
      Parameters:
      value - Encode mode of Datamatrix barcode.

    • getDataMatrixType

      public Mailmark2DType getDataMatrixType()
      2D Mailmark Type defines size of Data Matrix barcode.
      Returns:
      Size of Data Matrix barcode

    • setDataMatrixType

      public void setDataMatrixType(Mailmark2DType value)
      2D Mailmark Type defines size of Data Matrix barcode.
      Parameters:
      value - Size of Data Matrix barcode

    • getConstructedCodetext

      public String getConstructedCodetext()
      Construct codetext from Mailmark data.
      Specified by:
      getConstructedCodetext in interface IComplexCodetext
      Returns:
      Constructed codetext

    • initFromString

      public void initFromString(String constructedCodetext)
      Initializes Mailmark data from constructed codetext.
      Specified by:
      initFromString in interface IComplexCodetext
      Parameters:
      constructedCodetext - Constructed codetext.

    • getBarcodeType

      public BaseEncodeType getBarcodeType()
      Gets barcode type.
      Specified by:
      getBarcodeType in interface IComplexCodetext
      Returns:
      Barcode type.