pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::IBasketArticleItem Class Reference

Basket Article Item. More...

Inheritance diagram for X3g::Plugin::IBasketArticleItem:
Inheritance graph
[legend]

Public Member Functions

System::String^ GetManufacturerName (System::String^ pLanguage)
 Returns the manufacturer name in the given language. More...
 
System::String^ GetSeriesName (System::String^ pLanguage)
 Returns the series name in the given language. More...
 
System::String^ GetArticleNumber (BasketArtNumType pType)
 Returns the article number. More...
 
System::String^ GetDescription (BasketArtDescrType pType, System::String^ pLanguage)
 Returns the article description in the given language. More...
 
ReadOnlyCollection
< IBasketArticleFeature^ >^ 
GetFeatures (System::String^ pLanguage)
 Returns a list of article features in the given language. More...
 
- Public Member Functions inherited from X3g::Plugin::IBasketItem
System::String^ GetLabel (System::String^ pLanguage)
 Returns the item's label in the given language. More...
 

Properties

System::String^  ManufacturerId [get]
 The article's manufacturer id. More...
 
System::String^  SeriesId [get]
 The article's series id. More...
 
System::String^  CatalogImage [get]
 URI to the article's catalog image. More...
 
System::String^  GeneratedImage [get]
 URI to the article's generated image. More...
 
System::String^  ArticleImage [get]
 Returnes an URI to the default article image. More...
 
ReadOnlyCollection
< IBasketArticleTextField^ >^ 
TextFields [get]
 A list of optional text fields. More...
 
IBasketArticleCalculation^  Calculation [get]
 The article's calculation. More...
 
ReadOnlyCollection< IBasketItem^ >^ SubArticles [get]
 The sub-articles belonging to this article. More...
 
bool IsAlternatePosition [get]
 Returns if article item is an alternate position. More...
 
- Properties inherited from X3g::Plugin::IBasketItem
System::String^  Id [get]
 The item id. More...
 
BasketItemType Type [get]
 The item type More...
 
System::String^  ReferenceNumber [get]
 The item's reference number. More...
 
System::String^  Position [get]
 The item's position inside the basket. More...
 
IBasketItem^  Parent [get]
 The item's parent. More...
 
ReadOnlyCollection< IBasketItem^ >^ Children [get]
 The item's children. More...
 

Detailed Description

Basket Article Item.

Member Function Documentation

System::String X3g::Plugin::IBasketArticleItem::GetArticleNumber ( BasketArtNumType  pType)

Returns the article number.

System::String X3g::Plugin::IBasketArticleItem::GetDescription ( BasketArtDescrType  pType,
System::String^  pLanguage 
)

Returns the article description in the given language.

"" can be used as a fallback language. A fallback description is returned in this case.

ReadOnlyCollection< X3g::Plugin::IBasketArticleFeature^ > X3g::Plugin::IBasketArticleItem::GetFeatures ( System::String^  pLanguage)

Returns a list of article features in the given language.

"" can be used as a fallback language.

System::String X3g::Plugin::IBasketArticleItem::GetManufacturerName ( System::String^  pLanguage)

Returns the manufacturer name in the given language.

"" can be used as a fallback language. A fallback name is returned in this case.

System::String X3g::Plugin::IBasketArticleItem::GetSeriesName ( System::String^  pLanguage)

Returns the series name in the given language.

"" can be used as a fallback language. A fallback name is returned in this case.

Property Documentation

System:: String^ X3g::Plugin::IBasketArticleItem::ArticleImage
get

Returnes an URI to the default article image.

Depending on the product data settings and the used BasketGenerationFlags the CatalogImage or the GeneratedImage will be returned.

IBasketArticleCalculation^ X3g::Plugin::IBasketArticleItem::Calculation
get

The article's calculation.

System:: String^ X3g::Plugin::IBasketArticleItem::CatalogImage
get

URI to the article's catalog image.

System:: String^ X3g::Plugin::IBasketArticleItem::GeneratedImage
get

URI to the article's generated image.

bool X3g::Plugin::IBasketArticleItem::IsAlternatePosition
get

Returns if article item is an alternate position.

Alternate positions are excluded from total price calculation.

System:: String^ X3g::Plugin::IBasketArticleItem::ManufacturerId
get

The article's manufacturer id.

System:: String^ X3g::Plugin::IBasketArticleItem::SeriesId
get

The article's series id.

ReadOnlyCollection< IBasketItem^>^ X3g::Plugin::IBasketArticleItem::SubArticles
get

The sub-articles belonging to this article.

The returned articles may not be real childs (hierarchically) of this article.

ReadOnlyCollection< IBasketArticleTextField^>^ X3g::Plugin::IBasketArticleItem::TextFields
get

A list of optional text fields.