org.opencrx.kernel.product1.cci
Interface PriceLevel

All Superinterfaces:

AbstractFilter, AbstractFilterAccount, AbstractFilterProduct, AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, ViewCapable, XmlExporter

All Known Implementing Classes:

PriceLevelImpl

public interface PriceLevel
extends AbstractFilterAccount, CrxObject, AbstractFilterProduct

Method Summary

void	addAssignedAccount(AccountAssignment newValue)
void	addAssignedAccount(String id, AccountAssignment newValue)
void	addPriceModifier(PriceModifier newValue)
void	addPriceModifier(String id, PriceModifier newValue)
ProcessPricesResult	calculatePrices(CalculatePricesParams params)
ProcessPricesResult	calculatePrices(Short processingMode)
ProcessPricesResult	clonePriceLevel(ClonePriceLevelParams params)
ProcessPricesResult	clonePriceLevel(String nameReplacementRegex, String nameReplacementValue, Short processingMode, Date validFrom, Date validTo)
ProcessPricesResult	createInitialPrices(CreateInitialPricesParams params)
ProcessPricesResult	createInitialPrices(Uom priceUom, short processingMode)
Collection	getAssignedAccount() Retrieves a collection containing all the elements for the reference assignedAccount.
List	getAssignedAccount(AccountAssignmentFilter filter) Retrieves the value for the reference assignedAccount for the specified filter.
List	getAssignedAccount(AccountAssignmentQuery query) Retrieves the value for the reference assignedAccount for the specified query.
AccountAssignment	getAssignedAccount(String id) Retrieves the value for the reference assignedAccount for the specified qualifier attribute value.
PriceLevel	getBasedOn() Retrieves the value for the optional reference basedOn.
String	getDescription()
String	getName() Retrieves the value for the attribute name.
List	getPaymentMethod()
short	getPaymentMethod(int index)
short	getPriceCurrency() Retrieves the value for the attribute priceCurrency.
Collection	getPriceListEntry() Retrieves a collection containing all the elements for the reference priceListEntry.
List	getPriceListEntry(PriceListEntryFilter filter) Retrieves the value for the reference priceListEntry for the specified filter.
List	getPriceListEntry(PriceListEntryQuery query) Retrieves the value for the reference priceListEntry for the specified query.
PriceListEntry	getPriceListEntry(String id) Retrieves the value for the reference priceListEntry for the specified qualifier attribute value.
Collection	getPriceModifier() Retrieves a collection containing all the elements for the reference priceModifier.
List	getPriceModifier(PriceModifierFilter filter) Retrieves the value for the reference priceModifier for the specified filter.
List	getPriceModifier(PriceModifierQuery query) Retrieves the value for the reference priceModifier for the specified query.
PriceModifier	getPriceModifier(String id) Retrieves the value for the reference priceModifier for the specified qualifier attribute value.
List	getPriceUsage()
short	getPriceUsage(int index)
List	getShippingMethod()
short	getShippingMethod(int index)
Date	getValidFrom()
Date	getValidTo()
Boolean	isFinal()
void	removeAssignedAccount(String id)
void	removeBasedOn() Removes the value for the optional reference basedOn.
ProcessPricesResult	removePriceLevels(RemovePriceLevelsParams params)
ProcessPricesResult	removePriceLevels(short processingMode)
void	removePriceModifier(String id)
ProcessPricesResult	removePrices(RemovePricesParams params)
ProcessPricesResult	removePrices(Short processingMode)
void	setBasedOn(PriceLevel newValue) Sets a new value for the reference basedOn.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setFinal_(Boolean newValue) Sets a new value for the attribute isFinal.
void	setName(String newValue) Sets a new value for the attribute name.
void	setPaymentMethod(List newValue)
void	setPaymentMethod(short[] newValue)
void	setPriceCurrency(short newValue) Sets a new value for the attribute priceCurrency.
void	setPriceUsage(List newValue)
void	setPriceUsage(short[] newValue)
void	setShippingMethod(List newValue)
void	setShippingMethod(short[] newValue)
void	setValidFrom(Date newValue) Sets a new value for the attribute validFrom.
void	setValidTo(Date newValue) Sets a new value for the attribute validTo.

Methods inherited from interface org.opencrx.kernel.account1.cci.AbstractFilterAccount

addAccountFilterProperty, addAccountFilterProperty, countFilteredAccount, countFilteredAccount, getAccountFilterProperty, getAccountFilterProperty, getAccountFilterProperty, getAccountFilterProperty, getFilteredAccount, getFilteredAccount, getFilteredAccount, getFilteredAccount, removeAccountFilterProperty

Methods inherited from interface org.opencrx.kernel.generic.cci.CrxObject

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getCategory, getDisabledReason, getExternalLink, getExternalLink, getMedia, getMedia, getMedia, getMedia, getNote, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, isUserBoolean4, isUserBoolean4, removeAdditionalExternalLink, removeAttachedDocument, removeMedia, removeNote, removePropertySet, removeRating, setCategory, setCategory, setDisabled, setDisabledReason, setExternalLink, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci.AlertSender

sendAlert, sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci.Auditee

getAudit, getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci.Cloneable

clone_, clone_

Methods inherited from interface org.opencrx.kernel.base.cci.Importer

importItem, importItem

Methods inherited from interface org.opencrx.kernel.base.cci.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci.SecureObject

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.SubscriptionTarget

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

Methods inherited from interface org.opencrx.kernel.base.cci.XmlExporter

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface org.opencrx.kernel.product1.cci.AbstractFilterProduct

addProductFilterProperty, addProductFilterProperty, countFilteredProduct, countFilteredProduct, getFilteredProduct, getFilteredProduct, getFilteredProduct, getFilteredProduct, getProductFilterProperty, getProductFilterProperty, getProductFilterProperty, getProductFilterProperty, removeProductFilterProperty

Method Detail

getAssignedAccount

AccountAssignment getAssignedAccount(String id)

Retrieves the value for the reference assignedAccount for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedAccount

Collection getAssignedAccount()

Retrieves a collection containing all the elements for the reference assignedAccount.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAssignedAccount

List getAssignedAccount(AccountAssignmentFilter filter)

Retrieves the value for the reference assignedAccount for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAssignedAccount

List getAssignedAccount(AccountAssignmentQuery query)

Retrieves the value for the reference assignedAccount for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAssignedAccount

void addAssignedAccount(String id,
                        AccountAssignment newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAssignedAccount

void addAssignedAccount(AccountAssignment newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAssignedAccount

void removeAssignedAccount(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getBasedOn

PriceLevel getBasedOn()

Retrieves the value for the optional reference basedOn.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setBasedOn

void setBasedOn(PriceLevel newValue)

Sets a new value for the reference basedOn.

Parameters:

newValue - The non-null new value for this reference.

Throws:

JmiException - If the value cannot be set for some reason.

removeBasedOn

void removeBasedOn()

Removes the value for the optional reference basedOn.

Throws:

JmiException - If the value cannot be removed for some reason.

calculatePrices

ProcessPricesResult calculatePrices(CalculatePricesParams params)
                                    throws RefException

Throws:

RefException

calculatePrices

ProcessPricesResult calculatePrices(Short processingMode)
                                    throws RefException

Throws:

RefException

clonePriceLevel

ProcessPricesResult clonePriceLevel(ClonePriceLevelParams params)
                                    throws RefException

Throws:

RefException

clonePriceLevel

ProcessPricesResult clonePriceLevel(String nameReplacementRegex,
                                    String nameReplacementValue,
                                    Short processingMode,
                                    Date validFrom,
                                    Date validTo)
                                    throws RefException

Throws:

RefException

createInitialPrices

ProcessPricesResult createInitialPrices(CreateInitialPricesParams params)
                                        throws RefException

Throws:

RefException

createInitialPrices

ProcessPricesResult createInitialPrices(Uom priceUom,
                                        short processingMode)
                                        throws RefException

Throws:

RefException

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

JmiException - If the value cannot be set for some reason.

isFinal

Boolean isFinal()

Returns:

The possibly null value for attribute isFinal.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setFinal_

void setFinal_(Boolean newValue)

Sets a new value for the attribute isFinal.

Parameters:

newValue - The possibly null new value for attribute isFinal.

Throws:

JmiException - If the value cannot be set for some reason.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setName

void setName(String newValue)

Sets a new value for the attribute name.

Parameters:

newValue - The non-null new value for attribute name.

Throws:

JmiException - If the value cannot be set for some reason.

getPaymentMethod

List getPaymentMethod()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPaymentMethod

short getPaymentMethod(int index)

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPaymentMethod

void setPaymentMethod(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setPaymentMethod

void setPaymentMethod(short[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getPriceCurrency

short getPriceCurrency()

Retrieves the value for the attribute priceCurrency.

Returns:

The non-null value for attribute priceCurrency.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPriceCurrency

void setPriceCurrency(short newValue)

Sets a new value for the attribute priceCurrency.

Parameters:

newValue - The non-null new value for attribute priceCurrency.

Throws:

JmiException - If the value cannot be set for some reason.

getPriceListEntry

PriceListEntry getPriceListEntry(String id)

Retrieves the value for the reference priceListEntry for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPriceListEntry

Collection getPriceListEntry()

Retrieves a collection containing all the elements for the reference priceListEntry.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPriceListEntry

List getPriceListEntry(PriceListEntryFilter filter)

Retrieves the value for the reference priceListEntry for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPriceListEntry

List getPriceListEntry(PriceListEntryQuery query)

Retrieves the value for the reference priceListEntry for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPriceModifier

PriceModifier getPriceModifier(String id)

Retrieves the value for the reference priceModifier for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPriceModifier

Collection getPriceModifier()

Retrieves a collection containing all the elements for the reference priceModifier.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPriceModifier

List getPriceModifier(PriceModifierFilter filter)

Retrieves the value for the reference priceModifier for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPriceModifier

List getPriceModifier(PriceModifierQuery query)

Retrieves the value for the reference priceModifier for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addPriceModifier

void addPriceModifier(String id,
                      PriceModifier newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addPriceModifier

void addPriceModifier(PriceModifier newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removePriceModifier

void removePriceModifier(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getPriceUsage

List getPriceUsage()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPriceUsage

short getPriceUsage(int index)

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPriceUsage

void setPriceUsage(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setPriceUsage

void setPriceUsage(short[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

removePriceLevels

ProcessPricesResult removePriceLevels(RemovePriceLevelsParams params)
                                      throws RefException

Throws:

RefException

removePriceLevels

ProcessPricesResult removePriceLevels(short processingMode)
                                      throws RefException

Throws:

RefException

removePrices

ProcessPricesResult removePrices(RemovePricesParams params)
                                 throws RefException

Throws:

RefException

removePrices

ProcessPricesResult removePrices(Short processingMode)
                                 throws RefException

Throws:

RefException

getShippingMethod

List getShippingMethod()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getShippingMethod

short getShippingMethod(int index)

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setShippingMethod

void setShippingMethod(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setShippingMethod

void setShippingMethod(short[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getValidFrom

Date getValidFrom()

Returns:

The possibly null value for attribute validFrom.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setValidFrom

void setValidFrom(Date newValue)

Sets a new value for the attribute validFrom.

Parameters:

newValue - The possibly null new value for attribute validFrom.

Throws:

JmiException - If the value cannot be set for some reason.

getValidTo

Date getValidTo()

Returns:

The possibly null value for attribute validTo.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setValidTo

void setValidTo(Date newValue)

Sets a new value for the attribute validTo.

Parameters:

newValue - The possibly null new value for attribute validTo.

Throws:

JmiException - If the value cannot be set for some reason.