ePages 6.17.43 - DE_EPAGES/DHLIntraship/API/Object/ShippingLabelDHLIntraship.pm

Package DE_EPAGES::DHLIntraship::API::Object::ShippingLabelDHLIntraship

object interface for ShippingLabelDHLIntraship.

Base
DE_EPAGES::ExternalShipping::API::Object::ShippingLabel

Functions

className
clone
generateTrackingLink
isDefined
isValid
validateLabel

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $ShippingLabelDHLIntraship->className;
Return
$ClassName (String)
class name

clone

inherited function to fix an Issue which appears in combination between insert() and clone().

Syntax
clone( $hInfo, $Recursive );
Input
$hInfo (hash ref)
hash with mandatory attribute values.
  • ClassID - class id - int
  • Alias - alias - varchar(255)
  • ParentID - parent objectid - int
  • Inherit - (optional) inherit permissions from parent object - boolean
$Recursive (boolean)
clone child object too (optional, default is false)
Return
$Clone (object)
the new object

generateTrackingLink

Returns tracking link generated from template MBO/ShippingLabel/TrackingLink.txt

Syntax
$TrackingLink = $ShippingLabel->generateTrackingLink( $LangCode );
Return
$TrackingLink (string)
tracking link

isDefined

wrapping the isValid Function from PerlTools because in the external Shipping Frame work is a second Method with the same name

Syntax
isDefined( $Value );
Input
$Value (string)
a String
Return
$Valid (boolean)
parameter is simple valid

isValid

checks the existance of all mandatory input fields by calling $ShippingLabel->validate();

Syntax
$ShippingLabel->isValid();
Return
$IsValid - true if shipping label validates - boolean

validateLabel

Validates shipping label. Throws an error if mandatory values are missing.

Syntax
$ShippingLabel->validateLabel();