Interface OrderInterface

Direct known implementers

GXEngineOrder

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

Methods summary

`public integer`	# `getOrderId( )` Returns the order ID. Returns the order ID. Returns integer Order ID.
`public string`	# `getOrderHash( )` Returns the unique order hash. Returns the unique order hash. Returns string Unique order hash.
`public integer`	# `getCustomerId( )` Returns the associated customer ID. Returns the associated customer ID. Returns integer Associated customer ID.
`public string`	# `getCustomerEmail( )` Returns the associated customer email address. Returns the associated customer email address. Returns string Associated customer email address.
`public string`	# `getCustomerTelephone( )` Returns the associated customer telephone number. Returns the associated customer telephone number. Returns string Associated customer telephone number.
`public integer`	# `getStatusId( )` Returns the order status ID. Returns the order status ID. Returns integer Order status ID.
`public OrderInterface`	# `setCustomerNumber( StringType $customerNumber )` Sets customer number of Order Sets customer number of Order Parameters `$customerNumber` Customer number. Returns `OrderInterface` Same instance for method chaining.
`public string`	# `getCustomerNumber( )` Returns the customer number. Returns the customer number. Returns string Customer number.
`public OrderInterface`	# `setVatIdNumber( StringType $vatIdNumber )` Sets the VAT ID Number. Sets the VAT ID Number. Parameters `$vatIdNumber` VAT ID number. Returns `OrderInterface` Same instance for method chaining.
`public string`	# `getVatIdNumber( )` Returns the VAT ID number. Returns the VAT ID number. Returns string VAT ID number.
`public`	# `setCustomerStatusInformation( CustomerStatusInformation $customerStatusInformation )` Sets the customer status information. Sets the customer status information. Parameters `$customerStatusInformation` Customer status information.
`public CustomerStatusInformation`	# `getCustomerStatusInformation( )` Returns the Customer status information. Returns the Customer status information. Returns `CustomerStatusInformation` Customer status information.
`public AddressBlockInterface`	# `getCustomerAddress( )` Returns the customer address. Returns the customer address. Returns `AddressBlockInterface` Customer address.
`public AddressBlockInterface`	# `getBillingAddress( )` Returns the billing address. Returns the billing address. Returns `AddressBlockInterface` Billing address.
`public AddressBlockInterface`	# `getDeliveryAddress( )` Returns the delivery address. Returns the delivery address. Returns `AddressBlockInterface` Delivery address.
`public OrderItemCollection`	# `getOrderItems( )` Returns the order items collection. Returns the order items collection. Returns `OrderItemCollection` Order items collection.
`public OrderTotalCollection`	# `getOrderTotals( )` Returns the order totals collection. Returns the order totals collection. Returns `OrderTotalCollection` Order totals collection.
`public OrderShippingType`	# `getShippingType( )` Returns the order shipping type. Returns the order shipping type. Returns `OrderShippingType` Order shipping type.
`public OrderPaymentType`	# `getPaymentType( )` Returns the order payment type. Returns the order payment type. Returns `OrderPaymentType` Order payment type.
`public CurrencyCode`	# `getCurrencyCode( )` Returns the order currency code. Returns the order currency code. Returns `CurrencyCode` Order currency code.
`public LanguageCode`	# `getLanguageCode( )` Returns the order language code. Returns the order language code. Returns `LanguageCode` Order language code.
`public DateTime`	# `getPurchaseDateTime( )` Returns the order purchase datetime. Returns the order purchase datetime. Returns DateTime Order purchase datetime.
`public DateTime`	# `getLastModifiedDateTime( )` Returns the datetime of last modification. Returns the datetime of last modification. Returns DateTime Datetime of last modification.
`public OrderStatusHistoryListItemCollection`	# `getStatusHistory( )` Returns the order status history. Returns the order status history. Returns `OrderStatusHistoryListItemCollection` Order status history.
`public string`	# `getComment( )` Returns the order comment. Returns the order comment. Returns string Order comment.
`public string`	# `getAddonValue( StringType $key )` Returns the order addon key value from collection. Returns the order addon key value from collection. Parameters `$key` Addon key. Returns string Addon value.
`public EditableKeyValueCollection`	# `getAddonValues( )` Returns the order addon value collection. Returns the order addon value collection. Returns `EditableKeyValueCollection` Order addon value collection.
`public OrderInterface`	# `setOrderId( IdType $id )` Sets the order ID. Sets the order ID. Parameters `$id` Order ID. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setCustomerId( IdType $id )` Sets the associated customer ID. Sets the associated customer ID. Parameters `$id` Customer ID. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setCustomerEmail( EmailStringType $email )` Sets the customer email address. Sets the customer email address. Parameters `$email` Customer email address. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setCustomerTelephone( StringType $telephone )` Sets the customer telephone number. Sets the customer telephone number. Parameters `$telephone` Customer telephone number. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setStatusId( IdType $id )` Sets the order status ID. Sets the order status ID. Parameters `$id` Status ID. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setCustomerAddress( AddressBlockInterface $address )` Sets the customer address. Sets the customer address. Parameters `$address` Customer address. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setBillingAddress( AddressBlockInterface $address )` Sets the billing address. Sets the billing address. Parameters `$address` Billing address. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setDeliveryAddress( AddressBlockInterface $address )` Sets the delivery address. Sets the delivery address. Parameters `$address` Delivery address. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setOrderItems( OrderItemCollection $collection )` Sets the order items collection. Sets the order items collection. Parameters `$collection` Items collection. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setOrderTotals( OrderTotalCollection $collection )` Sets the order total collection. Sets the order total collection. Parameters `$collection` Total collection. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setShippingType( OrderShippingType $shippingType )` Sets the order shipping type. Sets the order shipping type. Parameters `$shippingType` Shipping type. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setPaymentType( OrderPaymentType $paymentType )` Sets the order payment type. Sets the order payment type. Parameters `$paymentType` Payment type. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setCurrencyCode( CurrencyCode $currencyCode )` Sets the order currency code. Sets the order currency code. Parameters `$currencyCode` Currency code. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setLanguageCode( LanguageCode $languageCode )` Sets the order language code. Sets the order language code. Parameters `$languageCode` Language code. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setPurchaseDateTime( DateTime $dateTime )` Sets the order purchase date time. Sets the order purchase date time. Parameters `$dateTime` Purchase date time. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setLastModifiedDateTime( DateTime $lastModifiedDateTime )` Sets the date time of last modification. Sets the date time of last modification. Parameters `$lastModifiedDateTime` Last modification date time Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setComment( StringType $comment )` Sets the order comment. Sets the order comment. Parameters `$comment` Comment. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `setAddonValue( StringType $key, StringType $value )` Adds/updates a key value in the addon value collection. Adds/updates a key value in the addon value collection. Parameters `$key` Addon key. `$value` Addon value. Returns `OrderInterface` Same instance for method chaining.
`public OrderInterface`	# `addAddonValues( KeyValueCollection $addonCollection )` Adds an addon collection to the existing one. Adds an addon collection to the existing one. Parameters `$addonCollection` Addon collection. Returns `OrderInterface` Same instance for method chaining.

Packages

Interfaces

Interface OrderInterface

Direct known implementers

Methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns