Interface OrderInterface

Interface OrderInterface

Direct known implementers

GXEngineOrder

Package: Order\Interfaces
Category: System
Located at Services/Core/Order/Entities/Interfaces/OrderInterface.inc.php

Methods summary

public getOrderId( void ) : integer

Returns the order ID.

public getOrderHash( void ) : string

Returns the unique order hash.

public getCustomerId( void ) : integer

Returns the associated customer ID.

public getCustomerEmail( void ) : string

Returns the associated customer email address.

public getCustomerTelephone( void ) : string

Returns the associated customer telephone number.

public getStatusId( void ) : integer

Returns the order status ID.

public setCustomerNumber( StringType $customerNumber ) : OrderInterface

Sets customer number of Order

public getCustomerNumber( void ) : string

Returns the customer number.

public setVatIdNumber( StringType $vatIdNumber ) : OrderInterface

Sets the VAT ID Number.

public getVatIdNumber( void ) : string

Returns the VAT ID number.

public setCustomerStatusInformation( CustomerStatusInformation $customerStatusInformation )

Sets the customer status information.

public getCustomerStatusInformation( void ) : CustomerStatusInformation

Returns the Customer status information.

public getCustomerAddress( void ) : AddressBlockInterface

Returns the customer address.

public getBillingAddress( void ) : AddressBlockInterface

Returns the billing address.

public getDeliveryAddress( void ) : AddressBlockInterface

Returns the delivery address.

public getOrderItems( void ) : OrderItemCollection

Returns the order items collection.

public getOrderTotals( void ) : OrderTotalCollection

Returns the order totals collection.

public getShippingType( void ) : OrderShippingType

Returns the order shipping type.

public getPaymentType( void ) : OrderPaymentType

Returns the order payment type.

public getCurrencyCode( void ) : CurrencyCode

Returns the order currency code.

public getLanguageCode( void ) : LanguageCode

Returns the order language code.

public getPurchaseDateTime( void ) : DateTime

Returns the order purchase datetime.

public getLastModifiedDateTime( void ) : DateTime

Returns the datetime of last modification.

public getStatusHistory( void ) : OrderStatusHistoryListItemCollection

Returns the order status history.

public getComment( void ) : string

Returns the order comment.

public getAddonValue( StringType $key ) : string

Returns the order addon key value from collection.

public getAddonValues( void ) : EditableKeyValueCollection

Returns the order addon value collection.

public setOrderId( IdType $id ) : OrderInterface

Sets the order ID.

public setOrderHash( NonEmptyStringType $orderHash ) : GXEngineOrder

Sets the unique order hash.

public setCustomerId( IdType $id ) : OrderInterface

Sets the associated customer ID.

public setCustomerEmail( EmailStringType $email ) : OrderInterface

Sets the customer email address.

public setCustomerTelephone( StringType $telephone ) : OrderInterface

Sets the customer telephone number.

public setStatusId( IntType $id ) : OrderInterface

Sets the order status ID.

public setCustomerAddress( AddressBlockInterface $address ) : OrderInterface

Sets the customer address.

public setBillingAddress( AddressBlockInterface $address ) : OrderInterface

Sets the billing address.

public setDeliveryAddress( AddressBlockInterface $address ) : OrderInterface

Sets the delivery address.

public setOrderItems( OrderItemCollection $collection ) : OrderInterface

Sets the order items collection.

public setOrderTotals( OrderTotalCollection $collection ) : OrderInterface

Sets the order total collection.

public setShippingType( OrderShippingType $shippingType ) : OrderInterface

Sets the order shipping type.

public setPaymentType( OrderPaymentType $paymentType ) : OrderInterface

Sets the order payment type.

public setCurrencyCode( CurrencyCode $currencyCode ) : OrderInterface

Sets the order currency code.

public setLanguageCode( LanguageCode $languageCode ) : OrderInterface

Sets the order language code.

public setPurchaseDateTime( DateTime $dateTime ) : OrderInterface

Sets the order purchase date time.

public setLastModifiedDateTime( DateTime $lastModifiedDateTime ) : OrderInterface

Sets the date time of last modification.

public setComment( StringType $comment ) : OrderInterface

Sets the order comment.

public getTotalWeight( void ) : float

Returns the total weight of the ordered products.

public setTotalWeight( DecimalType $totalWeight ) :

Sets the total weight of the ordered products.

public setAddonValue( StringType $key, StringType $value ) : OrderInterface

Adds/updates a key value in the addon value collection.

public addAddonValues( KeyValueCollection $addonCollection ) : OrderInterface

Adds an addon collection to the existing one.