domain

package
v3.0.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 2, 2019 License: OSL-3.0 Imports: 8 Imported by: 35

Documentation

Index

Constants

View Source 
const (
	MediaUsageList      = "list"
	MediaUsageDetail    = "detail"
	MediaUsageThumbnail = "thumbnail"
)

Media usage constants

View Source 
const (
	// TypeConfigurable denotes configurable products
	TypeConfigurable = "configurable"

	// TypeConfigurableWithActiveVariant denotes configurable products that has a variant selected
	TypeConfigurableWithActiveVariant = "configurable_with_activevariant"
)
View Source 
const (
	// Area Units
	SQUARE_MILLIMETER = "SQUARE_MILLIMETER"
	SQUARE_CENTIMETER = "SQUARE_CENTIMETER"
	SQUARE_DECIMETER  = "SQUARE_DECIMETER"
	SQUARE_METER      = "SQUARE_METER"
	CENTIARE          = "CENTIARE"
	SQUARE_DEKAMETER  = "SQUARE_DEKAMETER"
	ARE               = "ARE"
	SQUARE_HECTOMETER = "SQUARE_HECTOMETER"
	HECTARE           = "HECTARE"
	SQUARE_KILOMETER  = "SQUARE_KILOMETER"
	SQUARE_MIL        = "SQUARE_MIL"
	SQUARE_INCH       = "SQUARE_INCH"
	SQUARE_FOOT       = "SQUARE_FOOT"
	SQUARE_YARD       = "SQUARE_YARD"
	ARPENT            = "ARPENT"
	ACRE              = "ACRE"
	SQUARE_FURLONG    = "SQUARE_FURLONG"
	SQUARE_MILE       = "SQUARE_MILE"

	// Binary Units
	BIT      = "BIT"
	BYTE     = "BYTE"
	KILOBYTE = "KILOBYTE"
	MEGABYTE = "MEGABYTE"
	GIGABYTE = "GIGABYTE"
	TERABYTE = "TERABYTE"

	// Loudness Units
	DECIBEL = "DECIBEL"

	// Frequency Units
	HERTZ     = "HERTZ"
	KILOHERTZ = "KILOHERTZ"
	MEGAHERTZ = "MEGAHERTZ"
	GIGAHERTZ = "GIGAHERTZ"
	TERAHERTZ = "TERAHERTZ"

	// Length Unit
	MILLIMETER = "MILLIMETER"
	CENTIMETER = "CENTIMETER"
	DECIMETER  = "DECIMETER"
	METER      = "METER"
	DEKAMETER  = "DEKAMETER"
	HECTOMETER = "HECTOMETER"
	KILOMETER  = "KILOMETER"
	MIL        = "MIL"
	INCH       = "INCH"
	FEET       = "FEET"
	YARD       = "YARD"
	CHAIN      = "CHAIN"
	FURLONG    = "FURLONG"
	MILE       = "MILE"

	// Power Units
	WATT     = "WATT"
	KILOWATT = "KILOWATT"
	MEGAWATT = "MEGAWATT"
	GIGAWATT = "GIGAWATT"
	TERAWATT = "TERAWATT"

	// Voltage Units
	MILLIVOLT = "MILLIVOLT"
	CENTIVOLT = "CENTIVOLT"
	DECIVOLT  = "DECIVOLT"
	VOLT      = "VOLT"
	DEKAVOLT  = "DEKAVOLT"
	HECTOVOLT = "HECTOVOLT"
	KILOVOLT  = "KILOVOLT"

	// Intensity
	MILLIAMPERE = "MILLIAMPERE"
	CENTIAMPERE = "CENTIAMPERE"
	DECIAMPERE  = "DECIAMPERE"
	AMPERE      = "AMPERE"
	DEKAMPERE   = "DEKAMPERE"
	HECTOAMPERE = "HECTOAMPERE"
	KILOAMPERE  = "KILOAMPERE"

	// Resistance
	MILLIOHM = "MILLIOHM"
	CENTIOHM = "CENTIOHM"
	DECIOHM  = "DECIOHM"
	OHM      = "OHM"
	DEKAOHM  = "DEKAOHM"
	HECTOHM  = "HECTOHM"
	KILOHM   = "KILOHM"
	MEGOHM   = "MEGOHM"

	// Speed
	METER_PER_SECOND   = "METER_PER_SECOND"
	METER_PER_MINUTE   = "METER_PER_MINUTE"
	METER_PER_HOUR     = "METER_PER_HOUR"
	KILOMETER_PER_HOUR = "KILOMETER_PER_HOUR"
	FOOT_PER_SECOND    = "FOOT_PER_SECOND"
	FOOT_PER_HOUR      = "FOOT_PER_HOUR"
	YARD_PER_HOUR      = "YARD_PER_HOUR"
	MILE_PER_HOUR      = "MILE_PER_HOUR"

	// Electric Charge
	MILLIAMPEREHOUR = "MILLIAMPEREHOUR"
	AMPEREHOUR      = "AMPEREHOUR"
	MILLICOULOMB    = "MILLICOULOMB"
	CENTICOULOMB    = "CENTICOULOMB"
	DECICOULOMB     = "DECICOULOMB"
	COULOMB         = "COULOMB"
	DEKACOULOMB     = "DEKACOULOMB"
	HECTOCOULOMB    = "HECTOCOULOMB"
	KILOCOULOMB     = "KILOCOULOMB"

	// Duration
	MILLISECOND = "MILLISECOND"
	SECOND      = "SECOND"
	MINUTE      = "MINUTE"
	HOUR        = "HOUR"
	DAY         = "DAY"
	WEEK        = "WEEK"
	MONTH       = "MONTH"
	YEAR        = "YEAR"

	// Temperature
	CELSIUS    = "CELSIUS"
	FAHRENHEIT = "FAHRENHEIT"
	KELVIN     = "KELVIN"
	RANKINE    = "RANKINE"
	REAUMUR    = "REAUMUR"

	// Volume Units
	CUBIC_MILLIMETER = "CUBIC_MILLIMETER"
	CUBIC_CENTIMETER = "CUBIC_CENTIMETER"
	MILLILITER       = "MILLILITER"
	CENTILITER       = "CENTILITER"
	DECILITER        = "DECILITER"
	CUBIC_DECIMETER  = "CUBIC_DECIMETER"
	LITER            = "LITER"
	CUBIC_METER      = "CUBIC_METER"
	OUNCE            = "OUNCE"
	PINT             = "PINT"
	BARREL           = "BARREL"
	GALLON           = "GALLON"
	CUBIC_FOOT       = "CUBIC_FOOT"
	CUBIC_INCH       = "CUBIC_INCH"
	CUBIC_YARD       = "CUBIC_YARD"

	// Weigt Units
	MILLIGRAM = "MILLIGRAM"
	GRAM      = "GRAM"
	KILOGRAM  = "KILOGRAM"
	TON       = "TON"
	GRAIN     = "GRAIN"
	DENIER    = "DENIER"
	POUND     = "POUND"
	MARC      = "MARC"
	LIVRE     = "LIVRE"

	// Pressure
	BAR         = "BAR"
	PASCAL      = "PASCAL"
	HECTOPASCAL = "HECTOPASCAL"
	MILLIBAR    = "MILLIBAR"
	ATM         = "ATM"
	PSI         = "PSI"
	TORR        = "TORR"
	MMHG        = "MMHG"

	// Energy
	JOULE       = "JOULE"
	CALORIE     = "CALORIE"
	KILOCALORIE = "KILOCALORIE"
	KILOJOULE   = "KILOJOULE"

	// Piece / CaseBox Units
	PCS   = "PCS"
	PIECE = "PIECE"
	DOZEN = "DOZEN"
)

Constants of the unit codes See also the PIM unit codes on which these are based (and no other will get into this system)

View Source 
const (
	// TypeSimple denotes simple products
	TypeSimple = "simple"
)

Variables

View Source 
var Units = map[string]Unit{}/* 140 elements not displayed */

Units provides the unit map

Functions

This section is empty.

Types

type Attribute 

type Attribute struct {
	Code     string
	Label    string
	RawValue interface{}
	UnitCode string
}

Attribute for product attributes

func (Attribute) GetUnit 

func (at Attribute) GetUnit() Unit

GetUnit returns the unit on an attribute

func (Attribute) HasMultipleValues 

func (at Attribute) HasMultipleValues() bool

HasMultipleValues checks for multiple raw values

func (Attribute) HasUnitCode 

func (at Attribute) HasUnitCode() bool

HasUnitCode checks if a unit code is set on the attribute

func (Attribute) IsDisabledValue 

func (at Attribute) IsDisabledValue() bool

IsDisabledValue returns true if the value can be seen as a disable toggle/swicth value

func (Attribute) IsEnabledValue 

func (at Attribute) IsEnabledValue() bool

IsEnabledValue returns true if the value can be seen as a toogle and is enabled

func (Attribute) Value 

func (at Attribute) Value() string

Value returns the raw value

func (Attribute) Values 

func (at Attribute) Values() []string

Values builds a list of product attribute values

type Attributes 

type Attributes map[string]Attribute

Attributes describe a product attributes map

type BasicProduct 

type BasicProduct interface {
	BaseData() BasicProductData
	TeaserData() TeaserData
	GetSpecifications() Specifications
	//IsSaleable - indicates if that product type can be purchased
	IsSaleable() bool
	SaleableData() Saleable
	Type() string
	GetIdentifier() string
	HasMedia(group string, usage string) bool
	GetMedia(group string, usage string) Media
}

BasicProduct interface - Need to be implements by all Product Types!

type BasicProductData 

type BasicProductData struct {
	Title            string
	Attributes       Attributes
	ShortDescription string
	Description      string
	Media            []Media

	MarketPlaceCode string
	RetailerCode    string
	RetailerSku     string
	RetailerName    string

	CreatedAt   time.Time
	UpdatedAt   time.Time
	VisibleFrom time.Time
	VisibleTo   time.Time

	Categories   []CategoryTeaser
	MainCategory CategoryTeaser

	CategoryToCodeMapping []string

	StockLevel string

	Keywords []string
	IsNew    bool
}

BasicProductData is the basic product model

func (BasicProductData) GetListMedia 

func (bpd BasicProductData) GetListMedia() Media

GetListMedia returns the product media for listing

func (BasicProductData) GetMedia 

func (bpd BasicProductData) GetMedia(usage string) Media

GetMedia returns the FIRST found product media by usage

func (BasicProductData) GetSpecifications 

func (bpd BasicProductData) GetSpecifications() Specifications

GetSpecifications getter

func (BasicProductData) HasAttribute 

func (bpd BasicProductData) HasAttribute(key string) bool

HasAttribute check

func (BasicProductData) IsInStock 

func (bpd BasicProductData) IsInStock() bool

IsInStock returns information if current product whether in stock or not

type CategoryTeaser 

type CategoryTeaser struct {
	//Code the idendifier of the Category
	Code string
	//The Path (root to leaf) for this Category - seperated by "/"
	Path string
	//Name - speaking name of the category
	Name string
}

CategoryTeaser - Represents some Teaser infos for Category

type Charges 

type Charges struct {
	// contains filtered or unexported fields
}

Charges - Represents the Charges the product need to be payed with

func (Charges) GetByType 

func (c Charges) GetByType(ctype string) (priceDomain.Charge, bool)

GetByType - returns a charge of given type. If it was not found a Zero amount is returned and the second return value is false

type ConfigurableProduct 

type ConfigurableProduct struct {
	Identifier string
	BasicProductData
	Teaser                            TeaserData
	VariantVariationAttributes        []string
	Variants                          []Variant
	VariantVariationAttributesSorting map[string][]string
}

ConfigurableProduct - A product that can be teasered and that has Sellable Variants Aggregated

func (ConfigurableProduct) BaseData 

func (p ConfigurableProduct) BaseData() BasicProductData

BaseData interface implementation for ConfigurableProduct

func (ConfigurableProduct) GetConfigurableWithActiveVariant 

func (p ConfigurableProduct) GetConfigurableWithActiveVariant(variantMarketplaceCode string) (ConfigurableProductWithActiveVariant, error)

GetConfigurableWithActiveVariant getter

func (ConfigurableProduct) GetDefaultVariant 

func (p ConfigurableProduct) GetDefaultVariant() (*Variant, error)

GetDefaultVariant getter

func (ConfigurableProduct) GetIdentifier 

func (p ConfigurableProduct) GetIdentifier() string

GetIdentifier interface implementation for SimpleProduct

func (ConfigurableProduct) GetMedia 

func (p ConfigurableProduct) GetMedia(group string, usage string) Media

GetMedia for ConfigurableProduct

func (ConfigurableProduct) HasMedia 

func (p ConfigurableProduct) HasMedia(group string, usage string) bool

HasMedia for ConfigurableProduct

func (ConfigurableProduct) HasVariant 

func (p ConfigurableProduct) HasVariant(variantMarketplaceCode string) bool

HasVariant for ConfigurableProduct

func (ConfigurableProduct) IsSaleable 

func (p ConfigurableProduct) IsSaleable() bool

IsSaleable defaults to false

func (ConfigurableProduct) SaleableData 

func (p ConfigurableProduct) SaleableData() Saleable

SaleableData getter for ConfigurableProduct - Configurable is NOT Salable

func (ConfigurableProduct) TeaserData 

func (p ConfigurableProduct) TeaserData() TeaserData

TeaserData interface implementation for SimpleProduct

func (ConfigurableProduct) Type 

func (p ConfigurableProduct) Type() string

Type interface implementation for SimpleProduct

func (ConfigurableProduct) Variant 

func (p ConfigurableProduct) Variant(variantMarketplaceCode string) (*Variant, error)

Variant getter for ConfigurableProduct Variant is retrieved via marketplaceCode of the variant

type ConfigurableProductWithActiveVariant 

type ConfigurableProductWithActiveVariant struct {
	Identifier string
	BasicProductData
	Teaser                     TeaserData
	VariantVariationAttributes []string
	Variants                   []Variant
	ActiveVariant              Variant
}

ConfigurableProductWithActiveVariant - A product that can be teasered and that has Sellable Variants Aggregated, One Variant is Active

func (ConfigurableProductWithActiveVariant) BaseData 

func (p ConfigurableProductWithActiveVariant) BaseData() BasicProductData

BaseData returns only BaseData for Active Variant. If you need the BaseData of the Configurable - use ConfigurableBaseData()

func (ConfigurableProductWithActiveVariant) ConfigurableBaseData 

func (p ConfigurableProductWithActiveVariant) ConfigurableBaseData() BasicProductData

ConfigurableBaseData getter

func (ConfigurableProductWithActiveVariant) GetDefaultVariant 

func (p ConfigurableProductWithActiveVariant) GetDefaultVariant() (*Variant, error)

GetDefaultVariant getter

func (ConfigurableProductWithActiveVariant) GetIdentifier 

func (p ConfigurableProductWithActiveVariant) GetIdentifier() string

GetIdentifier getter

func (ConfigurableProductWithActiveVariant) GetMedia 

func (p ConfigurableProductWithActiveVariant) GetMedia(group string, usage string) Media

GetMedia for ConfigurableProduct

func (ConfigurableProductWithActiveVariant) HasMedia 

func (p ConfigurableProductWithActiveVariant) HasMedia(group string, usage string) bool

HasMedia for ConfigurableProduct

func (ConfigurableProductWithActiveVariant) HasVariant 

func (p ConfigurableProductWithActiveVariant) HasVariant(variantMarketplaceCode string) bool

HasVariant for ConfigurableProduct

func (ConfigurableProductWithActiveVariant) IsSaleable 

func (p ConfigurableProductWithActiveVariant) IsSaleable() bool

IsSaleable is true

func (ConfigurableProductWithActiveVariant) SaleableData 

func (p ConfigurableProductWithActiveVariant) SaleableData() Saleable

SaleableData getter for ConfigurableProduct Gets either the first or the active variants saleableData

func (ConfigurableProductWithActiveVariant) TeaserData 

func (p ConfigurableProductWithActiveVariant) TeaserData() TeaserData

TeaserData interface implementation for SimpleProduct

func (ConfigurableProductWithActiveVariant) Type 

func (p ConfigurableProductWithActiveVariant) Type() string

Type getter

func (ConfigurableProductWithActiveVariant) Variant 

func (p ConfigurableProductWithActiveVariant) Variant(variantMarketplaceCode string) (*Variant, error)

Variant getter for ConfigurableProduct Variant is retrieved via marketplaceCode of the variant

type LoyaltyPriceInfo 

type LoyaltyPriceInfo struct {
	//Type - Name( or Type) of the Loyalty program
	Type             string
	PointPrice       priceDomain.Price
	MinPointsToSpent big.Float
	MaxPointsToSpent big.Float
}

LoyaltyPriceInfo - contains info used for product with

func (LoyaltyPriceInfo) GetAmountToSpend 

func (l LoyaltyPriceInfo) GetAmountToSpend(wishedAmount *big.Float) big.Float

GetAmountToSpend - takes the whishedamaount and evaluates min and max and returns the points that need to be payed.

func (LoyaltyPriceInfo) GetRate 

func (l LoyaltyPriceInfo) GetRate(valuedPrice priceDomain.Price) big.Float

GetRate - get the currency conversion rate of the current loyaltyprice in relation to the passed value

type Media 

type Media struct {
	Type      string
	MimeType  string
	Usage     string
	Title     string
	Reference string
}

Media holds product media information

type PriceContext 

type PriceContext struct {
	CustomerGroup string
	ChannelCode   string
	Locale        string
}

PriceContext defines the scope in which the price was calculated

type PriceInfo 

type PriceInfo struct {
	Default           priceDomain.Price
	Discounted        priceDomain.Price
	DiscountText      string
	ActiveBase        big.Float
	ActiveBaseAmount  big.Float
	ActiveBaseUnit    string
	IsDiscounted      bool
	CampaignRules     []string
	DenyMoreDiscounts bool
	Context           PriceContext
	TaxClass          string
}

PriceInfo holds product price information

func (PriceInfo) GetFinalPrice 

func (p PriceInfo) GetFinalPrice() priceDomain.Price

GetFinalPrice getter for price that should be used in calculations (either discounted or default)

type ProductNotFound 

type ProductNotFound struct {
	MarketplaceCode string
}

ProductNotFound is an error

func (ProductNotFound) Error 

func (err ProductNotFound) Error() string

Error implements the error interface

type ProductService 

type ProductService interface {
	// Get a product
	Get(ctx context.Context, marketplaceCode string) (BasicProduct, error)
}

ProductService interface

type Saleable 

type Saleable struct {
	IsSaleable      bool
	SaleableFrom    time.Time
	SaleableTo      time.Time
	ActivePrice     PriceInfo
	AvailablePrices []PriceInfo
	//LoyaltyPrices - Optional infos for products that can be payed in a loyalty program
	LoyaltyPrices []LoyaltyPriceInfo
}

Saleable are properties required for being selled

func (Saleable) GetChargesToPay 

func (p Saleable) GetChargesToPay(wishedToPay *WishedToPay) Charges

GetChargesToPay Gets the Charges that need to be payed by type

func (Saleable) IsSaleableNow 

func (p Saleable) IsSaleableNow() bool

IsSaleableNow checks flag and time

type SearchResult 

type SearchResult struct {
	searchDomain.Result
	Hits []BasicProduct
}

SearchResult returns product hits

type SearchService 

type SearchService interface {
	//Search returns Products based on given Filters
	Search(ctx context.Context, filter ...searchDomain.Filter) (SearchResult, error)
	// SearchBy returns Products prefiltered by the given attribute (also based on additional given Filters)
	// e.g. SearchBy(ctx,"brandCode","apple")
	SearchBy(ctx context.Context, attribute string, values []string, filter ...searchDomain.Filter) (SearchResult, error)
}

SearchService is a typed search for products

type SimpleProduct 

type SimpleProduct struct {
	Identifier string
	BasicProductData
	Saleable
	Teaser TeaserData
}

SimpleProduct - A product without Variants that can be teasered and being sold

func (SimpleProduct) BaseData 

func (p SimpleProduct) BaseData() BasicProductData

BaseData interface implementation for SimpleProduct

func (SimpleProduct) GetIdentifier 

func (p SimpleProduct) GetIdentifier() string

GetIdentifier interface implementation for SimpleProduct

func (SimpleProduct) GetMedia 

func (p SimpleProduct) GetMedia(group string, usage string) Media

GetMedia for SimpleProduct

func (SimpleProduct) HasMedia 

func (p SimpleProduct) HasMedia(group string, usage string) bool

HasMedia for SimpleProduct

func (SimpleProduct) IsSaleable 

func (p SimpleProduct) IsSaleable() bool

IsSaleable is true

func (SimpleProduct) SaleableData 

func (p SimpleProduct) SaleableData() Saleable

SaleableData getter for SimpleProduct

func (SimpleProduct) TeaserData 

func (p SimpleProduct) TeaserData() TeaserData

TeaserData interface implementation for SimpleProduct

func (SimpleProduct) Type 

func (p SimpleProduct) Type() string

Type interface implementation for SimpleProduct

type SpecificationEntry 

type SpecificationEntry struct {
	Label  string
	Values []string
}

SpecificationEntry data

type SpecificationGroup 

type SpecificationGroup struct {
	Title   string
	Entries []SpecificationEntry
}

SpecificationGroup groups specifications

type Specifications 

type Specifications struct {
	Groups []SpecificationGroup
}

Specifications of a product

type TeaserData 

type TeaserData struct {
	ShortTitle       string
	ShortDescription string
	//TeaserPrice is the price that should be shown in teasers (listview)
	TeaserPrice PriceInfo
	//TeaserPriceIsFromPrice - is set to true in cases where a product might have different prices (e.g. configurable)
	TeaserPriceIsFromPrice bool
	//PreSelectedVariantSku - might be set for configurables to give a hint to link to a variant of a configurable (That might be the case if a user filters for an attribute and in the teaser the variant with that attribute is shown)
	PreSelectedVariantSku string
	//Media
	Media []Media
	//The sku that should be used to link from Teasers
	MarketPlaceCode       string
	TeaserAvailablePrices []PriceInfo
}

TeaserData is the teaser-information for product previews

type Unit 

type Unit struct {
	Code   string
	Symbol string
}

Unit describes a unit on an attribute

type Variant 

type Variant struct {
	BasicProductData
	Saleable
}

Variant is a concrete kind of a product

func (Variant) BaseData 

func (v Variant) BaseData() BasicProductData

BaseData getter for BasicProductData

func (Variant) SaleableData 

func (v Variant) SaleableData() Saleable

SaleableData getter for Saleable

type WishedToPay 

type WishedToPay struct {
	// contains filtered or unexported fields
}

WishedToPay - list of prices by type

func NewWishedToPay 

func NewWishedToPay() WishedToPay

NewWishedToPay - factory to get new WishedToPay struct

func (WishedToPay) Add 

func (w WishedToPay) Add(ctype string, price priceDomain.Price) WishedToPay

Add - returns new WishedToPay instance with the given whish added

func (WishedToPay) GetByType 

func (w WishedToPay) GetByType(ctype string) *priceDomain.Price

GetByType - returns the wihsed price for the given type or nil

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.