Mailmark2DCodetext Class Reference

Inherits IComplexCodetext.

Public Member Functions
	getUPUCountryID ()
	setUPUCountryID (string $value)
	getInformationTypeID ()
	setInformationTypeID (string $value)
	getVersionID ()
	setVersionID (string $value)
	getclass ()
	setclass (string $value)
	getSupplyChainID ()
	setSupplyChainID (int $value)
	getItemID ()
	setItemID (int $value)
	getDestinationPostCodeAndDPS ()
	setDestinationPostCodeAndDPS (string $value)
	getRTSFlag ()
	setRTSFlag (string $value)
	getReturnToSenderPostCode ()
	setReturnToSenderPostCode (string $value)
	getCustomerContent ()
	setCustomerContent (string $value)
	getCustomerContentEncodeMode ()
	setCustomerContentEncodeMode (int $value)
	getDataMatrixType ()
	setDataMatrixType (int $value)
	__construct ()
	init ()
	getConstructedCodetext ()
	initFromString ($constructedCodetext)
	getBarcodeType ()
	initFromString (string $constructedCodetext)
	getJavaClass ()
	getJavaClassName ()
	isNull ()
	printJavaClassName ()

Static Public Member Functions
static	construct ($javaClass)

Protected Member Functions
	setJavaClass ($javaClass)

Detailed Description

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.

Constructor & Destructor Documentation

__construct()

Mailmark2DCodetext::__construct

(

)

Create default instance of Mailmark2DCodetext class.

Member Function Documentation

construct()

static Mailmark2DCodetext::construct (   $javaClass )

static

getBarcodeType()

Mailmark2DCodetext::getBarcodeType

(

)

Gets barcode type.

Returns

‪int Barcode type.

Reimplemented from IComplexCodetext.

getclass()

Mailmark2DCodetext::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

‪string class of the item

getConstructedCodetext()

Mailmark2DCodetext::getConstructedCodetext

(

)

Construct codetext from Mailmark data.

Returns

‪string Constructed codetext

Reimplemented from IComplexCodetext.

getCustomerContent()

Mailmark2DCodetext::getCustomerContent

(

)

Optional space for use by customer.

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

Returns

‪string Customer content

getCustomerContentEncodeMode()

Mailmark2DCodetext::getCustomerContentEncodeMode

(

)

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

Returns

‪int Encode mode of Datamatrix barcode.

getDataMatrixType()

Mailmark2DCodetext::getDataMatrixType

(

)

2D Mailmark Type defines size of Data Matrix barcode.

Returns

‪int Size of Data Matrix barcode

getDestinationPostCodeAndDPS()

Mailmark2DCodetext::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

‪string the Postcode of the Delivery Address with DPS

getInformationTypeID()

Mailmark2DCodetext::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

‪string Information type ID

getItemID()

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

getJavaClass()

BaseJavaClass::getJavaClass ( )

inherited

getJavaClassName()

BaseJavaClass::getJavaClassName ( )

inherited

getReturnToSenderPostCode()

Mailmark2DCodetext::getReturnToSenderPostCode

(

)

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

Returns

‪string Return to Sender Post Code but no DPS

getRTSFlag()

Mailmark2DCodetext::getRTSFlag

(

)

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

Returns

‪string RTS Flag

getSupplyChainID()

Mailmark2DCodetext::getSupplyChainID

(

)

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

Returns

‪int Supply chain ID

getUPUCountryID()

Mailmark2DCodetext::getUPUCountryID

(

)

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

Returns

‪string Country ID

getVersionID()

Mailmark2DCodetext::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

‪string Version ID

init()

Mailmark2DCodetext::init

(

)

Reimplemented from BaseJavaClass.

initFromString() [1/2]

Mailmark2DCodetext::initFromString

(

$constructedCodetext

)

Initializes Mailmark data from constructed codetext.

Parameters

string

$constructedCodetext

‪Constructed codetext.

initFromString() [2/2]

IComplexCodetext::initFromString ( string  $constructedCodetext )

abstractinherited

Initializes instance with constructed codetext.

Parameters

string

$constructedCodetext

‪Constructed codetext.

isNull()

BaseJavaClass::isNull ( )

inherited

printJavaClassName()

BaseJavaClass::printJavaClassName ( )

inherited

setclass()

Mailmark2DCodetext::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

string

$value

‪class of the item

setCustomerContent()

Mailmark2DCodetext::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

string

$value

‪Customer content

setCustomerContentEncodeMode()

Mailmark2DCodetext::setCustomerContentEncodeMode

(

int

$value

)

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

Parameters

int

$value

‪Encode mode of Datamatrix barcode.

setDataMatrixType()

Mailmark2DCodetext::setDataMatrixType

(

int

$value

)

2D Mailmark Type defines size of Data Matrix barcode.

Parameters

int

$value

‪Size of Data Matrix barcode

setDestinationPostCodeAndDPS()

Mailmark2DCodetext::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

string

$value

‪the Postcode of the Delivery Address with DPS

setInformationTypeID()

Mailmark2DCodetext::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

string

$value

‪Information type ID

setItemID()

Mailmark2DCodetext::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

int

$value

‪item within the Supply Chain ID

setJavaClass()

BaseJavaClass::setJavaClass (   $javaClass )

protectedinherited

setReturnToSenderPostCode()

Mailmark2DCodetext::setReturnToSenderPostCode

(

string

$value

)

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

Parameters

string

$value

‪Return to Sender Post Code but no DPS

setRTSFlag()

Mailmark2DCodetext::setRTSFlag

(

string

$value

)

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

Parameters

string

$value

‪RTS Flag

setSupplyChainID()

Mailmark2DCodetext::setSupplyChainID

(

int

$value

)

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

Parameters

int

$value

‪Supply chain ID

setUPUCountryID()

Mailmark2DCodetext::setUPUCountryID

(

string

$value

)

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

Parameters

string

$value

‪Country ID

setVersionID()

Mailmark2DCodetext::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

string

$value

‪Version ID