Inherits IComplexCodetext.

Public Member Functions
None	__init__ (self)
	Create default instance of Mailmark2DCodetext class. More...

Generation.EncodeTypes	getBarcodeType (self)
	Gets barcode type. More...

str	getClass_ (self)
	Identifies the class of the item. More...

str	getConstructedCodetext (self)
	Construct codetext from Mailmark data. More...

str	getCustomerContent (self)
	Optional space for use by customer. More...

Generation.DataMatrixEncodeMode	getCustomerContentEncodeMode (self)
	Encode mode of Datamatrix barcode. More...

Mailmark2DType	getDataMatrixType (self)
	2D Mailmark Type defines size of Data Matrix barcode. More...

str	getDestinationPostCodeAndDPS (self)
	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. More...

str	getInformationTypeID (self)
	Identifies the Royal Mail Mailmark barcode payload for each product type. More...

int	getItemID (self)
	Every Mailmark barcode is required to carry an ID Max value: 99999999. More...

str	getReturnToSenderPostCode (self)
	Contains the Return to Sender Post Code but no DPS. More...

str	getRTSFlag (self)
	Flag which indicates what level of Return to Sender service is being requested. More...

int	getSupplyChainID (self)
	Identifies the unique group of customers involved in the mailing. More...

str	getUPUCountryID (self)
	Identifies the UPU Country ID.Max length: 4 characters. More...

str	getVersionID (self)
	Identifies the barcode version as relevant to each Information Type ID. More...

None	init (self)

None	initFromString (self, str constructedCodetext)
	Initializes Mailmark data from constructed codetext. More...

None	setClass_ (self, str value)
	Identifies the class of the item. More...

None	setCustomerContent (self, str value)
	Optional space for use by customer. More...

None	setCustomerContentEncodeMode (self, Generation.DataMatrixEncodeMode value)
	Encode mode of Datamatrix barcode. More...

None	setDataMatrixType (self, Mailmark2DType value)
	2D Mailmark Type defines size of Data Matrix barcode. More...

None	setDestinationPostCodeAndDPS (self, str value)
	Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. More...

None	setInformationTypeID (self, str value)
	Identifies the Royal Mail Mailmark barcode payload for each product type. More...

None	setItemID (self, int value)
	Identifies the unique item within the Supply Chain ID. More...

None	setReturnToSenderPostCode (self, str value)
	Contains the Return to Sender Post Code but no DPS. More...

None	setRTSFlag (self, str value)
	Flag which indicates what level of Return to Sender service is being requested. More...

None	setSupplyChainID (self, int value)
	Identifies the unique group of customers involved in the mailing. More...

None	setUPUCountryID (self, str value)
	Identifies the UPU Country ID.Max length: 4 characters. More...

None	setVersionID (self, str value)
	Identifies the barcode version as relevant to each Information Type ID. More...

Public Member Functions inherited from IComplexCodetext
def	__init__ (self, javaClass)

Public Member Functions inherited from BaseJavaClass
def	getJavaClass (self)

str	getJavaClassName (self)

bool	isNull (self)

None	printJavaClassName (self)

None	setJavaClass (self, javaClass)

Static Public Member Functions
Mailmark2DCodetext	construct (javaClass)

Public Attributes
	javaClass

Public Attributes inherited from BaseJavaClass
	javaClass

	javaClassName

Static Public Attributes
string	javaClassName = "com.aspose.mw.barcode.complexbarcode.MwMailmark2DCodetext"

Constructor & Destructor Documentation

◆ init()

None __init__ ( self )

Create default instance of Mailmark2DCodetext class.

Member Function Documentation

◆ construct()

Mailmark2DCodetext construct ( javaClass )

static

◆ getBarcodeType()

Generation.EncodeTypes getBarcodeType ( self )

Gets barcode type.

Returns: : Barcode type.

Reimplemented from IComplexCodetext.

◆ getClass_()

str 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()

str getConstructedCodetext ( self )

Construct codetext from Mailmark data.

Returns: : Constructed codetext

Reimplemented from IComplexCodetext.

◆ getCustomerContent()

str getCustomerContent ( self )

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

◆ getCustomerContentEncodeMode()

Generation.DataMatrixEncodeMode getCustomerContentEncodeMode ( self )

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40.

Returns: Encode mode of Datamatrix barcode.

◆ getDataMatrixType()

Mailmark2DType getDataMatrixType ( self )

2D Mailmark Type defines size of Data Matrix barcode.

Returns: : Size of Data Matrix barcode

◆ getDestinationPostCodeAndDPS()

str 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()

str 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()

int getItemID ( self )

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

Returns: : item within the Supply Chain ID

◆ getReturnToSenderPostCode()

str getReturnToSenderPostCode ( self )

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

◆ getRTSFlag()

str getRTSFlag ( self )

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

Returns: RTS Flag

◆ getSupplyChainID()

int getSupplyChainID ( self )

Identifies the unique group of customers involved in the mailing.

Max value: 9999999.

Returns: Supply chain ID

◆ getUPUCountryID()

str getUPUCountryID ( self )

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

Returns: Country ID

◆ getVersionID()

str 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()

None init ( self )

Reimplemented from BaseJavaClass.

◆ initFromString()

None initFromString	(		self,
		str	constructedCodetext
	)

Initializes Mailmark data from constructed codetext.

Parameters

constructedCodetext: constructedCodetext Constructed codetext.

Reimplemented from IComplexCodetext.

◆ setClass_()

None setClass_	(		self,
		str	value
	)

Identifies the class of the item.

Parameters

value 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

◆ setCustomerContent()

None setCustomerContent	(		self,
		str	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

◆ setCustomerContentEncodeMode()

None setCustomerContentEncodeMode	(		self,
		Generation.DataMatrixEncodeMode	value
	)

Encode mode of Datamatrix barcode.

Default value: DataMatrixEncodeMode.C40.

Parameters

value: Encode mode of Datamatrix barcode.

◆ setDataMatrixType()

None setDataMatrixType	(		self,
		Mailmark2DType	value
	)

2D Mailmark Type defines size of Data Matrix barcode.

Parameters

value: Size of Data Matrix barcode

◆ setDestinationPostCodeAndDPS()

None setDestinationPostCodeAndDPS	(		self,
		str	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

◆ setInformationTypeID()

None setInformationTypeID	(		self,
		str	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

◆ setItemID()

None setItemID	(		self,
		int	value
	)

Identifies the unique item within the Supply Chain ID.

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

◆ setReturnToSenderPostCode()

None setReturnToSenderPostCode	(		self,
		str	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

◆ setRTSFlag()

None setRTSFlag	(		self,
		str	value
	)

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

Parameters

value: RTS Flag

◆ setSupplyChainID()

None setSupplyChainID	(		self,
		int	value
	)

Identifies the unique group of customers involved in the mailing.

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

◆ setUPUCountryID()

None setUPUCountryID	(		self,
		str	value
	)

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

Parameters

value Country ID

◆ setVersionID()

None setVersionID	(		self,
		str	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

Member Data Documentation

◆ javaClass

javaClass

◆ javaClassName

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

static

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ construct()

◆ getBarcodeType()

◆ getClass_()

◆ getConstructedCodetext()

◆ getCustomerContent()

◆ getCustomerContentEncodeMode()

◆ getDataMatrixType()

◆ getDestinationPostCodeAndDPS()

◆ getInformationTypeID()

◆ getItemID()

◆ getReturnToSenderPostCode()

◆ getRTSFlag()

◆ getSupplyChainID()

◆ getUPUCountryID()

◆ getVersionID()

◆ init()

◆ initFromString()

◆ setClass_()

◆ setCustomerContent()

◆ setCustomerContentEncodeMode()

◆ setDataMatrixType()

◆ setDestinationPostCodeAndDPS()

◆ setInformationTypeID()

◆ setItemID()

◆ setReturnToSenderPostCode()

◆ setRTSFlag()

◆ setSupplyChainID()

◆ setUPUCountryID()

◆ setVersionID()

Member Data Documentation

◆ javaClass

◆ javaClassName

◆ init()