Class Price
- java.lang.Object
-
- com.priint.pubserver.plugin.entitydata.Price
-
- All Implemented Interfaces:
GetContext,GetIdentifier,GetSequence,EntityData,PersistentData,java.io.Serializable
@Entity public class Price extends java.lang.Object implements java.io.Serializable, GetIdentifier, GetContext, GetSequence, EntityData, PersistentData
Data object of entity type Price with amount, value and valid date.
A price manages all information relevant to prices like price, scaled price, purchase quantities, quantity units, packaging units, etc. A price is related to exactly one bucket.
- Since:
- 4.0.0, 4.0.5 origin attribute supported, added JPA annotations, getLanguage() and getCountry() are deprecated
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPrice.properties
-
Constructor Summary
Constructors Constructor Description Price()Default constructor.Price(java.lang.String identifier, java.lang.String entityPriceId, Context context, Bucket bucket, java.lang.String label, java.lang.String amount, java.lang.String price)Creates a price with necessary properties.Price(java.lang.String identifier, java.lang.String entityPriceId, Context context, java.lang.String bucketId, java.lang.String label, java.lang.String amount, java.lang.String price, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)Creates a price with extended properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAmount()AmountBucketgetBucket()java.lang.StringgetBucketId()ConnectorEntitygetConnectorEntity()java.util.List<ContentMetaData>getContentMetaData()ContextgetContext()Get the context for this element ornullif not set.java.lang.StringgetCreatedBy()java.util.DategetCreatedOn()java.lang.StringgetCurrency()EntityPricegetEntity()java.lang.StringgetEntityIdentifier()Identifier of an entity in the entity model where the current object refers to.java.lang.StringgetEntityPriceId()java.lang.StringgetGroupIdentifier()String key for grouping prices of the same type.java.lang.StringgetIdentifier()Get the string identifier of the price.java.lang.StringgetItemPrice()java.lang.StringgetLabel()Display label for the price.java.lang.StringgetListPrice()java.util.List<KeyValue>getMetaData()java.lang.StringgetMinOrderQuantity()java.lang.StringgetOldItemPrice()java.lang.StringgetOldPrice()java.lang.StringgetOrigin()java.lang.StringgetPackagingUnit()java.lang.StringgetPrice()Get a price object.java.lang.StringgetPriceUnit()java.lang.StringgetQuantityOfPackingUnit()intgetSequence()Get sequence number for the price as given in the content system.java.lang.StringgetTemplate()java.lang.StringgetTimestamp()Get timestamp from the content system.java.lang.StringgetUpdatedBy()java.util.DategetUpdatedOn()java.util.DategetValidFrom()java.util.DategetValidTo()java.lang.StringgetVersion()Version string from the content systemvoidsetAmount(java.lang.String amount)voidsetBucket(Bucket bucket)voidsetBucketId(java.lang.String bucketId)voidsetConnectorEntity(ConnectorEntity connectorEntity)voidsetContentMetaData(java.util.List<ContentMetaData> contentMetaData)voidsetContext(Context context)set the context of entity data objectvoidsetCreatedBy(java.lang.String createdBy)voidsetCreatedOn(java.util.Date createdOn)voidsetCurrency(java.lang.String currency)voidsetEntity(EntityPrice entityPrice)Sets entityPrice and entityPriceId.voidsetEntityIdentifier(java.lang.String entityIdentifier)Identifier of an entity in the entity model where the current object refers to.voidsetEntityPriceId(java.lang.String entityPriceId)Sets entityPriceId and eventually removes current entityPrice if it does not match the idvoidsetGroupIdentifier(java.lang.String groupIdentifier)voidsetIdentifier(java.lang.String identifier)voidsetItemPrice(java.lang.String itemPrice)voidsetLabel(java.lang.String label)voidsetListPrice(java.lang.String listPrice)voidsetMetaData(java.util.List<KeyValue> metaData)voidsetMinOrderQuantity(java.lang.String minOrderQuantity)voidsetOldItemPrice(java.lang.String oldItemPrice)voidsetOldPrice(java.lang.String oldPrice)voidsetOrigin(java.lang.String origin)voidsetPackagingUnit(java.lang.String packagingUnit)voidsetPrice(java.lang.String price)voidsetPriceUnit(java.lang.String priceUnit)voidsetQuantityOfPackingUnit(java.lang.String quantityOfPackingUnit)voidsetSequence(int sequence)voidsetTemplate(java.lang.String template)voidsetTimestamp(java.lang.String timestamp)voidsetUpdatedBy(java.lang.String updatedBy)voidsetUpdatedOn(java.util.Date updatedOn)voidsetValidFrom(java.util.Date validFrom)voidsetValidTo(java.util.Date validTo)voidsetVersion(java.lang.String version)java.lang.StringtoString()
-
-
-
Constructor Detail
-
Price
public Price()
Default constructor.
-
Price
public Price(java.lang.String identifier, java.lang.String entityPriceId, Context context, Bucket bucket, java.lang.String label, java.lang.String amount, java.lang.String price)Creates a price with necessary properties.- Parameters:
identifier-getIdentifier()entityPriceId-getEntityPriceId()context-getContext()bucket-getBucket()label-getLabel()amount-getAmount()price-getPrice()
-
Price
public Price(java.lang.String identifier, java.lang.String entityPriceId, Context context, java.lang.String bucketId, java.lang.String label, java.lang.String amount, java.lang.String price, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)Creates a price with extended properties.- Parameters:
identifier-getIdentifier()entityPriceId-getEntityPriceId()context-getContext()bucketId-getBucketId()label-getLabel()amount-getAmount()price-getPrice()createdBy-getCreatedBy()createdOn-getCreatedOn()updatedBy-getUpdatedBy()updatedOn-getUpdatedOn()
-
-
Method Detail
-
getIdentifier
public java.lang.String getIdentifier()
Get the string identifier of the price.- Specified by:
getIdentifierin interfaceEntityData- Specified by:
getIdentifierin interfaceGetIdentifier- Specified by:
getIdentifierin interfacePersistentData- Returns:
- identifier string or
nullif not set
-
setIdentifier
public void setIdentifier(java.lang.String identifier)
- Specified by:
setIdentifierin interfaceEntityData- Parameters:
identifier- seegetIdentifier()
-
getGroupIdentifier
public java.lang.String getGroupIdentifier()
String key for grouping prices of the same type.- Returns:
- group identifier string or
nullif not set
-
setGroupIdentifier
public void setGroupIdentifier(java.lang.String groupIdentifier)
- Parameters:
groupIdentifier- seegetGroupIdentifier()
-
getVersion
public java.lang.String getVersion()
Version string from the content system- Returns:
- version string or
nullif not set
-
setVersion
public void setVersion(java.lang.String version)
- Parameters:
version- seegetVersion()
-
getTemplate
public java.lang.String getTemplate()
- Returns:
- String identifier of the template to render this content.
-
setTemplate
public void setTemplate(java.lang.String template)
- Parameters:
template-getTemplate()
-
getTimestamp
public java.lang.String getTimestamp()
Get timestamp from the content system.Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.
- Returns:
- timestamp string
-
setTimestamp
public void setTimestamp(java.lang.String timestamp)
- Parameters:
timestamp- seegetTimestamp()
-
getEntity
public EntityPrice getEntity()
- Returns:
- Price entity object associated with the current price or
nullif not set.
-
setEntity
public void setEntity(EntityPrice entityPrice)
Sets entityPrice and entityPriceId.- Parameters:
entityPrice-getEntity()- See Also:
setEntityPriceId(String)
-
getSequence
public int getSequence()
Get sequence number for the price as given in the content system.This should reflect the position of the current price in the sorting of prices of its buckets.
- Specified by:
getSequencein interfaceGetSequence- Returns:
- ordered position within a list sequenceable objects
-
setSequence
public void setSequence(int sequence)
- Parameters:
sequence- seegetSequence()
-
getContext
public Context getContext()
Get the context for this element ornullif not set.- Specified by:
getContextin interfaceEntityData- Specified by:
getContextin interfaceGetContext- Returns:
- context
-
setContext
public void setContext(Context context)
Description copied from interface:EntityDataset the context of entity data object- Specified by:
setContextin interfaceEntityData- Parameters:
context-getContext()
-
getBucket
public Bucket getBucket()
- Returns:
- Parent bucket that this price is related to.
-
setBucket
public void setBucket(Bucket bucket)
- Parameters:
bucket-getBucket()
-
getLabel
public java.lang.String getLabel()
Display label for the price.- Returns:
- label or
nullif not set
-
setLabel
public void setLabel(java.lang.String label)
- Parameters:
label- seegetLabel()
-
getAmount
public java.lang.String getAmount()
AmountThere is not special format for amounts, because this can have very different representations.
- Returns:
- amount
-
setAmount
public void setAmount(java.lang.String amount)
- Parameters:
amount-getAmount()
-
getValidFrom
public java.util.Date getValidFrom()
- Returns:
- Price is valid from
-
setValidFrom
public void setValidFrom(java.util.Date validFrom)
- Parameters:
validFrom-getValidFrom()
-
getValidTo
public java.util.Date getValidTo()
- Returns:
- Price is valid to
-
setValidTo
public void setValidTo(java.util.Date validTo)
- Parameters:
validTo-getValidTo()
-
getConnectorEntity
public ConnectorEntity getConnectorEntity()
- Returns:
- connector entity object or
nullif not set
-
setConnectorEntity
public void setConnectorEntity(ConnectorEntity connectorEntity)
- Parameters:
connectorEntity- seegetConnectorEntity()
-
getEntityPriceId
public java.lang.String getEntityPriceId()
- Returns:
- Identifier of related entity in entity model.
-
setEntityPriceId
public void setEntityPriceId(java.lang.String entityPriceId)
Sets entityPriceId and eventually removes current entityPrice if it does not match the id- Parameters:
entityPriceId-getEntityPriceId()- Since:
- 4.0.0
-
getBucketId
public java.lang.String getBucketId()
- Returns:
- Identifier of parent bucket that this content element is related to. Is null for following methods:
EntityManagerRemote.getEntityPricesOfBucket(String, String, String, String, String, Context, String)EntityManagerRemote.getEntityPricesByIdentifier(String, String, String, String, Context, String)EntityManagerRemote.getEntityPricesOfPlanning(String, String, String, String, String, Context, String, String)EntityManagerRemote.getEntityPricesOfPlannedBucket(String, String, String, String, Context, String)
-
setBucketId
public void setBucketId(java.lang.String bucketId)
- Parameters:
bucketId-getBucketId()
-
getPrice
public java.lang.String getPrice()
Get a price object.There is not special format for prices, because this can have very different representations.
- Returns:
- Price
-
setPrice
public void setPrice(java.lang.String price)
- Parameters:
price-getPrice()
-
getCurrency
public java.lang.String getCurrency()
- Returns:
- Currency of Price
-
setCurrency
public void setCurrency(java.lang.String currency)
- Parameters:
currency-getCurrency()
-
getPriceUnit
public java.lang.String getPriceUnit()
- Returns:
- like Piece, Bottle, Meter,..
-
setPriceUnit
public void setPriceUnit(java.lang.String priceUnit)
- Parameters:
priceUnit-getPriceUnit()
-
getPackagingUnit
public java.lang.String getPackagingUnit()
- Returns:
- Packages like Box of Bottles: Box
-
setPackagingUnit
public void setPackagingUnit(java.lang.String packagingUnit)
- Parameters:
packagingUnit-getPackagingUnit()
-
getQuantityOfPackingUnit
public java.lang.String getQuantityOfPackingUnit()
- Returns:
- Number of units in a package like 6 Bottles in a Box: 6
-
setQuantityOfPackingUnit
public void setQuantityOfPackingUnit(java.lang.String quantityOfPackingUnit)
- Parameters:
quantityOfPackingUnit-getQuantityOfPackingUnit()
-
getItemPrice
public java.lang.String getItemPrice()
- Returns:
- Price of a priceUnit
-
setItemPrice
public void setItemPrice(java.lang.String itemPrice)
- Parameters:
itemPrice-getItemPrice()
-
getMinOrderQuantity
public java.lang.String getMinOrderQuantity()
- Returns:
- Minimal order quantity
-
setMinOrderQuantity
public void setMinOrderQuantity(java.lang.String minOrderQuantity)
- Parameters:
minOrderQuantity-getMinOrderQuantity()
-
getOldPrice
public java.lang.String getOldPrice()
- Returns:
- Old price
-
setOldPrice
public void setOldPrice(java.lang.String oldPrice)
- Parameters:
oldPrice-getOldPrice()
-
getOldItemPrice
public java.lang.String getOldItemPrice()
- Returns:
- Old price of an item
-
setOldItemPrice
public void setOldItemPrice(java.lang.String oldItemPrice)
- Parameters:
oldItemPrice-getOldItemPrice()
-
getListPrice
public java.lang.String getListPrice()
- Returns:
- list price
-
setListPrice
public void setListPrice(java.lang.String listPrice)
- Parameters:
listPrice-getListPrice()
-
getMetaData
public java.util.List<KeyValue> getMetaData()
- Returns:
- List of meta data related to the bucket or empty list.
List is LAZY loaded.
-
setMetaData
public void setMetaData(java.util.List<KeyValue> metaData)
- Parameters:
metaData- seegetMetaData()
-
getCreatedBy
public java.lang.String getCreatedBy()
- Returns:
- creation user or
nullif not set
-
setCreatedBy
public void setCreatedBy(java.lang.String createdBy)
- Parameters:
createdBy- seegetCreatedBy()
-
getCreatedOn
public java.util.Date getCreatedOn()
- Returns:
- creation date or
nullif not set
-
setCreatedOn
public void setCreatedOn(java.util.Date createdOn)
- Parameters:
createdOn- seegetCreatedOn()
-
getUpdatedBy
public java.lang.String getUpdatedBy()
- Returns:
- last modified user or
nullif not set
-
setUpdatedBy
public void setUpdatedBy(java.lang.String updatedBy)
- Parameters:
updatedBy- seegetUpdatedBy()
-
getUpdatedOn
public java.util.Date getUpdatedOn()
- Returns:
- last modified date or
nullif not set
-
setUpdatedOn
public void setUpdatedOn(java.util.Date updatedOn)
- Parameters:
updatedOn- seegetUpdatedOn()
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getOrigin
public java.lang.String getOrigin()
- Returns:
- Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return
null.
-
setOrigin
public void setOrigin(java.lang.String origin)
- Parameters:
origin-getOrigin()
-
getEntityIdentifier
public java.lang.String getEntityIdentifier()
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
getEntityIdentifierin interfaceEntityData- Returns:
- entity identifier as string
-
setEntityIdentifier
public void setEntityIdentifier(java.lang.String entityIdentifier)
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
setEntityIdentifierin interfaceEntityData
-
getContentMetaData
public java.util.List<ContentMetaData> getContentMetaData()
- Returns:
- List of ContentMetaData related to Price.
List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.
-
setContentMetaData
public void setContentMetaData(java.util.List<ContentMetaData> contentMetaData)
- Parameters:
contentMetaData-getContentMetaData()
-
-