ePages 6.17.52 - DE_EPAGES/MeinPaket/API/OfferUploadResponseHandler.pm

Package DE_EPAGES::MeinPaket::API::OfferUploadResponseHandler

Provides functionallity to get offer based information from an MeinPaket upload response.

Functions

areAllProductsConfirmed
getConfirmedProductCount
getConfirmedProductCount
getConfirmedProducts
getMeinPaketId
getUnconfirmedProducts
new
wasProductConfirmed

areAllProductsConfirmed

Determines wether or not all uploaded products of the handled offer where confirmed with the handled response.

Syntax
areAllProductsConfirmed();
Return
(boolean)
1 - in case all uploaded products of the offer
where confirmed by the handled response
0 - otherwise

getConfirmedProductCount

Returns the amount of products that have been confirmed with the handled response

Syntax
getConfirmedProductCount();
Return
(integer)
Amount of confirmed products

getConfirmedProductCount

Returns the amount of uploaded products that haven't been confirmed with the handled response

Syntax
getConfirmedProductCount();
Return
(integer)
Amount of unconfirmed uploaded products

getConfirmedProducts

Returns a list of all products that have been confirmed with the handled response

Syntax
getConfirmedProducts();
Return
(refarray)
List of confirmed products

getMeinPaketId

Gets the MeinPaketId of the passed product or sub-product from the handled response. In case there is none undef is returned instead.

Syntax
getMeinPaketId( $ProductOrSubProduct );
Input
$ProductOrSubProduct (object)
product or sub-product to get id for
Return
(string)
MeinPaketId of the passed product

getUnconfirmedProducts

Returns a list of all uploaded products that haven't been confirmed with the handled response

Syntax
getUnconfirmedProducts();
Return
(refarray)
List of unconfirmed uploaded products

new

constructor

Syntax
new( $MeinPaketOffer, $MeinPaketUploadResponse );
Input
$MeinPaketOffer (DE_EPAGES::MeinPaket::API::Object::MeinPaketOffer)
Offer to operate on
$MeinPaketUploadResponse (DE_EPAGES::MeinPaket::API::DTO::UploadResponse)
Response to operate on
Return
$self (DE_EPAGES::MeinPaket::API::ResponseHandler)
self

wasProductConfirmed

Determines whether or not we received a confirmation for the passed product or sub-product with the response

Syntax
wasProductConfirmed( $ProductOrSubProduct );
Input
$ProductOrSubProduct (object)
product or sub-product to check
Return
(boolean)
1 - in case the response contains a conformation
for the passed product
0 - otherwise