ePages 6.11.0 - DE_EPAGES/Order/API/Object/CustomerOrder.pm

Package DE_EPAGES::Order::API::Object::CustomerOrder

object interface for CustomerOrder.

Base
DE_EPAGES::Object::API::Object::Object

Functions

className
clone
container
dbPackage
exportXMLAttributes
getExtraExportableAttributes
insertLineItem
recalculate

className

Returns the class name, used for DAL access.

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

clone

Inserts a new order into the database as copy from old order.

Syntax
$Clone = $CustomerOrder->clone( $hInfo );
$Clone = $CustomerOrder->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

container

Returns lineitem container of order.

Syntax
$LineItemContainer = $CustomerOrder->container;

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $CustomerOrder->dbPackage;
Return
$DbPackage (String)
database package name

exportXMLAttributes

Returns plain attributes of object to XML export driver. This function removes bit attributes with value 0.

Syntax
$hAttributes = $Object->exportXMLAttributes( $Driver, $hAllAttributes );
Input
$Driver (object)
xml export driver with support function addObject
$hAllAttributes (ref.hash)
all attributes of object,
see $Object->exportableAttributes
Return
$hAttributes (ref.hash.string)
plain attributes

getExtraExportableAttributes

Returns names of attributes of object for XML export of orders.

Syntax
$aAttributes = $Object->getExtraExportableAttributes();
Return
$aAttributes (ref.array.string)
plain attributes

insertLineItem

Insert a lineItem in to container, see DE_EPAGES::Order::API::Object::LineItemContainer::insertLineItem.

Syntax
$CustomerOrder->insertLineItem;

recalculate

Recalculate lineitem container, see DE_EPAGES::Order::API::Object::LineItemContainer::recalculate.

Syntax
$CustomerOrder->recalculate;