MailmarkCodetext Class Reference

Class for encoding and decoding the text embedded in the 4-state Royal Mailmark code. More...

Inherits IComplexCodetext.

Public Member Functions
None	__init__ (self)
	Initializes a new instance of the MailmarkCodetext class. More...
EncodeTypes	barcode_type (self)
	Gets barcode type. More...
str	class_ (self)
None	class_ (self, str value)
	"0" - None or Test "1" - 1C (Retail) "2" - 2C (Retail) "3" - 3C (Retail) "4" - Premium (RetailPublishing Mail) (for potential future use) "5" - Deferred (Retail) "6" - Air (Retail) (for potential future use) "7" - Surface (Retail) (for potential future use) "8" - Premium (Network Access) "9" - Standard (Network Access) More...
Optional[str]	constructed_codetext (self)
	Construct codetext from Mailmark data. More...
str	destination_post_code_plus_dps (self)
	The PC and DP must comply with a PAF format. More...
None	destination_post_code_plus_dps (self, str value)
	The PC and DP must comply with a PAF format. More...
int	format (self)
	"0" – None or Test "1" – Letter "2" – Large Letter More...
None	format (self, int value)
	"0" – None or Test "1" – LetterN "2" – Large Letter More...
None	init_from_string (self, str constructed_codetext)
	Initializes Mailmark data from constructed codetext. More...
int	item_id (self)
	Maximum value is 99999999. More...
None	item_id (self, int value)
	Maximum value is 99999999. More...
int	supplychain_id (self)
	Maximum values are 99 for Barcode C and 999999 for Barcode L. More...
None	supplychain_id (self, int value)
	Maximum values are 99 for Barcode C and 999999 for Barcode L. More...
int	version_id (self)
	Currently "1" – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use) More...
None	version_id (self, int value)
	Currently "1" – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use) More...
Public Member Functions inherited from IComplexCodetext
def	__init__ (self, _java_class)

Detailed Description

Class for encoding and decoding the text embedded in the 4-state Royal Mailmark code.

Constructor & Destructor Documentation

__init__()

None __init__

(

self

)

Initializes a new instance of the MailmarkCodetext class.

Parameters

mailmarkCodetext:

Member Function Documentation

barcode_type()

EncodeTypes barcode_type

(

self

)

Gets barcode type.

Returns

: Barcode type.

Reimplemented from IComplexCodetext.

class_() [1/2]

str class_

(

self

)

'0' None/Test; '1' 1C (Retail); '2' 2C (Retail); '3' 3C (Retail);
'4' Premium (RetailPublishing, future); '5' Deferred (Retail);
'6' Air (Retail, future); '7' Surface (Retail, future);
'8' Premium (Network Access); '9' Standard (Network Access).

class_() [2/2]

None class_	(		self,
		str	value
	)

"0" - None or Test "1" - 1C (Retail) "2" - 2C (Retail) "3" - 3C (Retail) "4" - Premium (RetailPublishing Mail) (for potential future use) "5" - Deferred (Retail) "6" - Air (Retail) (for potential future use) "7" - Surface (Retail) (for potential future use) "8" - Premium (Network Access) "9" - Standard (Network Access)

constructed_codetext()

Optional[str] constructed_codetext

(

self

)

Construct codetext from Mailmark data.

Returns

: Constructed codetext

Reimplemented from IComplexCodetext.

destination_post_code_plus_dps() [1/2]

str destination_post_code_plus_dps

(

self

)

The PC and DP must comply with a PAF format.

Nine character string denoting international "XY11 " (note the 5 trailing spaces) or a pattern of characters denoting a domestic sorting code. A domestic sorting code consists of an outward postcode, an inward postcode, and a Delivery Point Suffix.

Returns

:

destination_post_code_plus_dps() [2/2]

None destination_post_code_plus_dps	(		self,
		str	value
	)

The PC and DP must comply with a PAF format.

Nine character string denoting international "XY11 " (note the 5 trailing spaces) or a pattern of characters denoting a domestic sorting code. A domestic sorting code consists of an outward postcode, an inward postcode, and a Delivery Point Suffix.

Parameters

value:

format() [1/2]

int format

(

self

)

"0" – None or Test "1" – Letter "2" – Large Letter

format() [2/2]

None format	(		self,
		int	value
	)

"0" – None or Test "1" – LetterN "2" – Large Letter

init_from_string()

None init_from_string	(		self,
		str	constructed_codetext
	)

Initializes Mailmark data from constructed codetext.

Parameters

constructedCodetext: Constructed codetext

Returns

:

Reimplemented from IComplexCodetext.

item_id() [1/2]

int item_id

(

self

)

Maximum value is 99999999.

Returns

:

item_id() [2/2]

None item_id	(		self,
		int	value
	)

Maximum value is 99999999.

Parameters

value:

supplychain_id() [1/2]

int supplychain_id

(

self

)

Maximum values are 99 for Barcode C and 999999 for Barcode L.

Returns

:

supplychain_id() [2/2]

None supplychain_id	(		self,
		int	value
	)

Maximum values are 99 for Barcode C and 999999 for Barcode L.

Parameters

value:

Returns

:

version_id() [1/2]

int version_id

(

self

)

Currently "1" – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use)

Returns

:

version_id() [2/2]

None version_id	(		self,
		int	value
	)

Currently "1" – For Mailmark barcode (0 and 2 to 9 and A to Z spare for future use)