Aspose.Barcode for Python via Java Generation and Recognition API docs
asposebarcode.ComplexBarcode.Mailmark2DCodetext Class Reference

Inherits asposebarcode.ComplexBarcode.IComplexCodetext.

Public Member Functions

def getUPUCountryID (self)
 Identifies the UPU Country ID.Max length: 4 characters. More...
 
def setUPUCountryID (self, value)
 Identifies the UPU Country ID.Max length: 4 characters. More...
 
def getInformationTypeID (self)
 Identifies the Royal Mail Mailmark barcode payload for each product type. More...
 
def setInformationTypeID (self, value)
 Identifies the Royal Mail Mailmark barcode payload for each product type. More...
 
def getVersionID (self)
 Identifies the barcode version as relevant to each Information Type ID. More...
 
def setVersionID (self, value)
 Identifies the barcode version as relevant to each Information Type ID. More...
 
def getclass (self)
 Identifies the class of the item. More...
 
def setclass (self, value)
 Identifies the class of the item. More...
 
def getSupplyChainID (self)
 Identifies the unique group of customers involved in the mailing. More...
 
def setSupplyChainID (self, value)
 Identifies the unique group of customers involved in the mailing. More...
 
def getItemID (self)
 Every Mailmark barcode is required to carry an ID Max value: 99999999. More...
 
def setItemID (self, value)
 Identifies the unique item within the Supply Chain ID. More...
 
def getDestinationPostCodeAndDPS (self)
 Contains the Postcode of the Delivery Address with DPS. More...
 
def setDestinationPostCodeAndDPS (self, value)
 Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. More...
 
def getRTSFlag (self)
 Flag which indicates what level of Return to Sender service is being requested. More...
 
def setRTSFlag (self, value)
 Flag which indicates what level of Return to Sender service is being requested. More...
 
def getReturnToSenderPostCode (self)
 Contains the Return to Sender Post Code but no DPS. More...
 
def setReturnToSenderPostCode (self, value)
 Contains the Return to Sender Post Code but no DPS. More...
 
def getCustomerContent (self)
 Optional space for use by customer. More...
 
def setCustomerContent (self, value)
 Optional space for use by customer. More...
 
def getCustomerContentEncodeMode (self)
 Encode mode of Datamatrix barcode. More...
 
def setCustomerContentEncodeMode (self, value)
 Encode mode of Datamatrix barcode. More...
 
def getDataMatrixType (self)
 2D Mailmark Type defines size of Data Matrix barcode. More...
 
def setDataMatrixType (self, value)
 2D Mailmark Type defines size of Data Matrix barcode. More...
 
def __init__ (self)
 Create default instance of Mailmark2DCodetext class. More...
 
def init (self)
 
def getConstructedCodetext (self)
 Construct codetext from Mailmark data. More...
 
def initFromString (self, constructedCodetext)
 Initializes Mailmark data from constructed codetext. More...
 
def getBarcodeType (self)
 Gets barcode type. More...
 
- Public Member Functions inherited from asposebarcode.ComplexBarcode.IComplexCodetext
def __init__ (self, javaClass)
 
- Public Member Functions inherited from asposebarcode.Assist.BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Static Public Member Functions

def construct (javaClass)
 

Public Attributes

 javaClass
 
- Public Attributes inherited from asposebarcode.Assist.BaseJavaClass
 javaClass
 
 javaClassName
 

Static Public Attributes

string javaClassName = "com.aspose.mw.barcode.complexbarcode.MwMailmark2DCodetext"
 

Constructor & Destructor Documentation

◆ __init__()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.__init__ (   self)

Create default instance of Mailmark2DCodetext class.

Member Function Documentation

◆ construct()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.construct (   javaClass)
static

◆ getBarcodeType()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getBarcodeType (   self)

Gets barcode type.

:return: Barcode type.

Reimplemented from asposebarcode.ComplexBarcode.IComplexCodetext.

◆ getclass()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getclass (   self)

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

◆ getConstructedCodetext()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getConstructedCodetext (   self)

Construct codetext from Mailmark data.

:return: Constructed codetext

Reimplemented from asposebarcode.ComplexBarcode.IComplexCodetext.

◆ getCustomerContent()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getCustomerContent (   self)

Optional space for use by customer.

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

:return: Customer content

◆ getCustomerContentEncodeMode()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getCustomerContentEncodeMode (   self)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40.

Returns
Encode mode of Datamatrix barcode.

◆ getDataMatrixType()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getDataMatrixType (   self)

2D Mailmark Type defines size of Data Matrix barcode.

:return: Size of Data Matrix barcode

◆ getDestinationPostCodeAndDPS()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getDestinationPostCodeAndDPS (   self)

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

◆ getInformationTypeID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getInformationTypeID (   self)

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

◆ getItemID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getItemID (   self)

Every Mailmark barcode is required to carry an ID Max value: 99999999.

:return: item within the Supply Chain ID

◆ getReturnToSenderPostCode()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getReturnToSenderPostCode (   self)

Contains the Return to Sender Post Code but no DPS.

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

◆ getRTSFlag()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getRTSFlag (   self)

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

Returns
RTS Flag

◆ getSupplyChainID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getSupplyChainID (   self)

Identifies the unique group of customers involved in the mailing.

Max value: 9999999.

Returns
Supply chain ID

◆ getUPUCountryID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getUPUCountryID (   self)

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

Returns
Country ID

◆ getVersionID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.getVersionID (   self)

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

◆ init()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.init (   self)

◆ initFromString()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.initFromString (   self,
  constructedCodetext 
)

Initializes Mailmark data from constructed codetext.

:param constructedCodetext: constructedCodetext Constructed codetext.

Reimplemented from asposebarcode.ComplexBarcode.IComplexCodetext.

◆ setclass()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setclass (   self,
  value 
)

Identifies the class of the item.

:param value: Valid Values: “1” - 1C (Retail) “2” - 2C (Retail) “3” - Economy (Retail) “5” - Deffered (Retail) “8” - Premium (Network Access) “9” - Standard (Network Access) :return: class of the item

◆ setCustomerContent()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setCustomerContent (   self,
  value 
)

Optional space for use by customer.

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

Parameters
valueCustomer content

◆ setCustomerContentEncodeMode()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setCustomerContentEncodeMode (   self,
  value 
)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40. :param value: Encode mode of Datamatrix barcode.

◆ setDataMatrixType()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setDataMatrixType (   self,
  value 
)

2D Mailmark Type defines size of Data Matrix barcode.

:param value: Size of Data Matrix barcode

◆ setDestinationPostCodeAndDPS()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setDestinationPostCodeAndDPS (   self,
  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. :param value: the Postcode of the Delivery Address with DPS

◆ setInformationTypeID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setInformationTypeID (   self,
  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
valueInformation type ID

◆ setItemID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setItemID (   self,
  value 
)

Identifies the unique item within the Supply Chain ID.

Every Mailmark barcode is required to carry an ID Max value: 99999999.

◆ setReturnToSenderPostCode()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setReturnToSenderPostCode (   self,
  value 
)

Contains the Return to Sender Post Code but no DPS.

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

◆ setRTSFlag()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setRTSFlag (   self,
  value 
)

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

:param value: RTS Flag

◆ setSupplyChainID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setSupplyChainID (   self,
  value 
)

Identifies the unique group of customers involved in the mailing.

Max value: 9999999. :param value: Supply chain ID

◆ setUPUCountryID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setUPUCountryID (   self,
  value 
)

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

Parameters
valueCountry ID

◆ setVersionID()

def asposebarcode.ComplexBarcode.Mailmark2DCodetext.setVersionID (   self,
  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
valueVersion ID

Member Data Documentation

◆ javaClass

asposebarcode.ComplexBarcode.Mailmark2DCodetext.javaClass

◆ javaClassName

string asposebarcode.ComplexBarcode.Mailmark2DCodetext.javaClassName = "com.aspose.mw.barcode.complexbarcode.MwMailmark2DCodetext"
static