Interface ProductInterface

Direct known implementers

GXEngineProduct, StoredProductInterface

Indirect known implementers

StoredProduct

Package: Product\Interfaces
Category: System
Located at Services/Core/Product/Entities/Interfaces/ProductInterface.inc.php

Methods summary

`public boolean`	# `isActive( )` Is Active Is Active Checks if a product is active. Returns boolean
`public integer`	# `getSortOrder( )` Get Sort Order Get Sort Order Returns an integer which represents a specific sort order. Returns integer The sort order.
`public DateTime`	# `getAvailableDateTime( )` Get Available Date Time Get Available Date Time Returns the available date time of the product. Returns DateTime The available date time.
`public DateTime`	# `getAddedDateTime( )` Get Added Date Time Get Added Date Time Returns the added date time of the product. Returns DateTime The added date time.
`public DateTime`	# `getLastModifiedDateTime( )` Get Last Modified Date Time Get Last Modified Date Time Returns the last modified date time. Returns DateTime The last modified date time.
`public integer`	# `getViewedCount( LanguageCode $language )` Get View Count Get View Count Returns the current view count of the product, depending on the provided language code. Parameters `$language` The language code of the language to be returned. Returns integer The current view count. Throws InvalidArgumentException
`public integer`	# `getOrderedCount( )` Get Ordered Count Get Ordered Count Returns the ordered count of the product. Returns integer The ordered count.
`public ProductSettingsInterface`	# `getSettings( )` Get Product Settings. Get Product Settings. Returns the product settings. Returns `ProductSettingsInterface`
`public string`	# `getName( LanguageCode $language )` Get Name Get Name Returns the name of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The name of the product.
`public string`	# `getDescription( LanguageCode $language )` Get Description Get Description Returns the description of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The description of the product.
`public string`	# `getShortDescription( LanguageCode $language )` Get Short Description Get Short Description Returns the short description of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The short description of the product.
`public string`	# `getKeywords( LanguageCode $language )` Get Keywords Get Keywords Returns the keywords of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The keywords of the product.
`public string`	# `getMetaTitle( LanguageCode $language )` Get Meta Title Get Meta Title Returns the meta title of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The meta title of the product.
`public string`	# `getMetaDescription( LanguageCode $language )` Get Meta Description Get Meta Description Returns the meta description of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The meta description of the product.
`public string`	# `getMetaKeywords( LanguageCode $language )` Get Meta Keywords Get Meta Keywords Returns the meta keywords of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The meta keywords of the product.
`public string`	# `getUrl( LanguageCode $language )` Get Url Get Url Returns the URL of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string Product URL Throws InvalidArgumentException
`public string`	# `getUrlKeywords( LanguageCode $language )` Get URL Keywords Get URL Keywords Returns the URL keywords of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The URL keywords of the product.
`public UrlRewrite`	# `getUrlRewrite( LanguageCode $language )` Get URL rewrite Get URL rewrite Returns the URL rewrite of the product, depending on the provided language code. Parameters `$language` The language code of the URL rewrite to be return. Returns `UrlRewrite` The URL rewrite of the product. Throws InvalidArgumentException if the language code is not valid.
`public UrlRewriteCollection`	# `getUrlRewrites( )` Get URL rewrites Get URL rewrites Returns the URL rewrites of the product. Returns `UrlRewriteCollection` The URL rewrites of the product.
`public string`	# `getCheckoutInformation( LanguageCode $language )` Get Checkout Information Get Checkout Information Returns the checkout information of the product, depending on the provided language code. Parameters `$language` The language code of the language to return. Returns string The checkout information of the product.
`public string`	# `getProductModel( )` Get Product Model Get Product Model Returns the product model. Returns string The product model.
`public string`	# `getEan( )` Get EAN Get EAN Returns the EAN of the product. Returns string The EAN of the product.
`public float`	# `getPrice( )` Get Price Get Price Returns the price of a product. Returns float The price of the product.
`public integer`	# `getTaxClassId( )` Get Tax Class ID Get Tax Class ID Returns the tax class ID of the product. Returns integer The tax class ID.
`public float`	# `getQuantity( )` Get Quantity Get Quantity Returns the quantity of the product. Returns float The quantity of the product.
`public float`	# `getWeight( )` Get Weight Get Weight Returns the weight of the product. Returns float The weight of the product.
`public float`	# `getDiscountAllowed( )` Get Discount Allowed Get Discount Allowed Returns the allowed discount. Returns float The allowed discount.
`public float`	# `getShippingCosts( )` Get Shipping Costs Get Shipping Costs Returns the shipping cost of the product. Returns float The shipping costs of the product.
`public integer`	# `getShippingTimeId( )` Get Shipping Time ID Get Shipping Time ID Returns the shipping time ID of the product. Returns integer The shipping time ID.
`public integer`	# `getProductTypeId( )` Get Product Type ID. Get Product Type ID. Returns the product type ID. Returns integer The product type ID.
`public integer`	# `getManufacturerId( )` Get Manufacturer ID Get Manufacturer ID Returns the manufacturer ID. Returns integer The manufacturer ID.
`public boolean`	# `isFsk18( )` Is FSK 18 Is FSK 18 Checks if the product is only available for FSK 18. Returns boolean Is the product FSK18?
`public boolean`	# `isVpeActive( )` Is VPE Active Is VPE Active Checks if VPE is active on the product. Returns boolean Is VPE active on the product?
`public integer`	# `getVpeId( )` Get VPE ID. Get VPE ID. Returns the VPE ID. Returns integer VPE ID.
`public float`	# `getVpeValue( )` Get VPE Value Get VPE Value Returns the VPE value. Returns float The VPE value.
`public string`	# `getAddonValue( StringType $key )` Get Addon Value Get Addon Value Returns the addon value of a product, depending on the provided key. Parameters `$key` The key of the addon value to return. Returns string The addon value.
`public KeyValueCollection`	# `getAddonValues( )` Get Addon Values Get Addon Values Returns a key value collection of the product. Returns `KeyValueCollection` The key value collection.
`public ProductInterface`	# `setActive( BoolType $status )` Set Active Set Active Activates or deactivates a product status. Parameters `$status` Should the product status be activated? Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setSortOrder( IntType $sortOrder )` Set Sort Order Set Sort Order Sets the sort order of the product. Parameters `$sortOrder` The sort order. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setAvailableDateTime( DateTime $date )` Set Available Date Time Set Available Date Time Sets an available date time. Parameters `$date` The date time to add. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setLastModifiedDateTime( DateTime $date )` Set Last Modified Date Time Set Last Modified Date Time Sets the last modified date time. Parameters `$date` The last modified date time. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setViewedCount( IntType $count, LanguageCode $language )` Set Viewed Count Set Viewed Count Sets the viewed count of a product. Parameters `$count` The amount of views. `$language` The language code for the product name. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setOrderedCount( IntType $count )` Set Ordered Count Set Ordered Count Sets the ordered count. Parameters `$count` The ordered count. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setImageContainer( ProductImageContainerInterface $images )` Set Image Container Set Image Container Sets the image container of a product. Parameters `$images` Product image container to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setSettings( ProductSettingsInterface $productSettings )` Sets the settings of the product. Sets the settings of the product. Parameters `$productSettings` The settings of the product. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setName( StringType $text, LanguageCode $language )` Set Name Set Name Sets the products name. Parameters `$text` The name of the product. `$language` The language code for the product name. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setDescription( StringType $text, LanguageCode $language )` Set Description Set Description Sets the products description. Parameters `$text` The description. `$language` The language code for the description. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setShortDescription( StringType $text, LanguageCode $language )` Set Short Description Set Short Description Sets the products short description. Parameters `$text` Short description to set. `$language` The language code for the short description. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setKeywords( StringType $text, LanguageCode $language )` Set Keywords Set Keywords Sets the products keywords. Parameters `$text` The keywords. `$language` The language code for the keywords. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setMetaTitle( StringType $text, LanguageCode $language )` Set Meta title. Set Meta title. Sets the meta title. Parameters `$text` Meta title to set. `$language` Language code of the meta title. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setMetaDescription( StringType $text, LanguageCode $language )` Set Meta description. Set Meta description. Sets the products meta description. Parameters `$text` Meta description to set. `$language` Language code for the meta description. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setMetaKeywords( StringType $text, LanguageCode $language )` Set Meta Keywords Set Meta Keywords Sets the products meta keywords. Parameters `$text` The meta keywords. `$language` The language code for the meta keywords. Returns `ProductInterface` Same instance for chained method calls.
`public GXEngineProduct`	# `setUrl( StringType $url, LanguageCode $language )` Set URL Set URL Sets the products URL. Parameters `$url` The URL to set. `$language` The language code for the URL keywords. Returns `GXEngineProduct` Same instance for chained method calls.
`public ProductInterface`	# `setUrlKeywords( StringType $text, LanguageCode $language )` Set URL Keywords Set URL Keywords Sets the products URL Keywords. Parameters `$text` The URL. `$language` The language code for the URL keywords. Returns `ProductInterface` Same instance for chained method calls.
`public GXEngineProduct`	# `setUrlRewrite( UrlRewrite $urlRewrite, LanguageCode $language )` Set URL rewrite Set URL rewrite Sets the products URL rewrite for the provided language code. Parameters `$urlRewrite` The URL rewrite instance. `$language` The language code for the URL keywords. Returns `GXEngineProduct` Same instance for chained method calls.
`public GXEngineProduct`	# `setUrlRewrites( UrlRewriteCollection $urlRewrites )` Set URL rewrites Set URL rewrites Sets the products URL rewrites. Parameters `$urlRewrites` The URL rewrites. Returns `GXEngineProduct` Same instance for chained method calls.
`public ProductInterface`	# `setCheckoutInformation( StringType $text, LanguageCode $language )` Set Checkout Information Set Checkout Information Sets the checkout information. Parameters `$text` The checkout information. `$language` The language code for the checkout information. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setProductModel( StringType $model )` Set Product Model Set Product Model Set the product model. Parameters `$model` The product model. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setEan( StringType $ean )` Set EAN Set EAN Sets a EAN for the product. Parameters `$ean` The EAN to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setPrice( DecimalType $price )` Set Price Set Price Sets a price of the product. Parameters `$price` The price to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setTaxClassId( IdType $id )` Set Tax Class ID Set Tax Class ID Sets a tax class ID for the product. Parameters `$id` The tax class ID to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setQuantity( DecimalType $quantity )` Set Quantity Set Quantity Sets a quantity for the product. Parameters `$quantity` The quantity to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setWeight( DecimalType $weight )` Set Weight Set Weight Sets the weight of a product. Parameters `$weight` The weight to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setDiscountAllowed( DecimalType $discount )` Set Discount Allowed Set Discount Allowed Sets the allowed discount of a product. Parameters `$discount` The discount to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setShippingCosts( DecimalType $price )` Set Shipping Costs Set Shipping Costs Sets the shipping costs of a product. Parameters `$price` The shipping costs to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setShippingTimeId( IdType $id )` Set Shipping Time ID Set Shipping Time ID Sets the shipping time ID of a product. Parameters `$id` The shipping time ID to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setProductTypeId( IdType $id )` Set Product Type ID. Set Product Type ID. Sets the product type ID of the product. Parameters `$id` Product type ID to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setManufacturerId( IdType $id )` Set Manufacturer ID Set Manufacturer ID Sets the manufacturer ID of a product. Parameters `$id` The manufacturer ID to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setFsk18( BoolType $status )` Set FSK 18 Set FSK 18 Activates or deactivates FSK18 for a product. Parameters `$status` Should FSK be activated? Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setVpeActive( BoolType $status )` Set VPE Active Set VPE Active Activates or deactivates VPE for a product. Parameters `$status` Should VPE be activated? Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setVpeId( IdType $id )` Set VPE ID Set VPE ID Sets the VPE ID of a product. Parameters `$id` The VPE ID to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setVpeValue( DecimalType $vpeValue )` Set VPE Value Set VPE Value Sets the VPE value of a product. Parameters `$vpeValue` The VPE value to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setAddonValue( StringType $key, StringType $value )` Set Addon Value Set Addon Value Sets the addon value of a product. Parameters `$key` The key for the addon value. `$value` The value for the addon. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `setAddedDateTime( DateTime $date )` Sets the added date time. Sets the added date time. Parameters `$date` Added date time to set. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `addAddonValues( KeyValueCollection $keyValueCollection )` Add Addon Values Add Addon Values Adds a key value collection to a product. Parameters `$keyValueCollection` The key value collection to add. Returns `ProductInterface` Same instance for chained method calls.
`public ProductInterface`	# `deleteAddonValue( StringType $key )` Delete Addon Value Delete Addon Value Deletes a addon value of a product. Parameters `$key` The key of the addon value to delete. Returns `ProductInterface` Same instance for chained method calls.
`public ProductImageContainer`	# `getImageContainer( )` Returns the image container of the product. Returns the image container of the product. Returns `ProductImageContainer` Product image container.
`public ProductImage`	# `getPrimaryImage( )` Returns a product's primary image. Returns a product's primary image. Returns `ProductImage`
`public ProductImageCollection`	# `getAdditionalImages( )` Returns a product's additional images. Returns a product's additional images. Returns `ProductImageCollection`

Packages

Interfaces

Interface ProductInterface

Direct known implementers

Indirect known implementers

Methods summary

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Returns

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