org.opencrx.kernel.contract1.cci2
Interface ContractPosition

All Superinterfaces:

AddressContainer, BookingOrigin, DeliveryRequestContainer, DepotReferenceHolder, ShippingDetail

All Known Subinterfaces:

AbstractInvoicePosition, AbstractInvoicePosition, AbstractOpportunityPosition, AbstractOpportunityPosition, AbstractQuotePosition, AbstractQuotePosition, AbstractRemovedPosition, AbstractRemovedPosition, AbstractSalesOrderPosition, AbstractSalesOrderPosition, ContractPosition, InvoicePosition, InvoicePosition, OpportunityPosition, OpportunityPosition, QuotePosition, QuotePosition, RemovedPosition, RemovedPosition, SalesOrderPosition, SalesOrderPosition

All Known Implementing Classes:

AbstractInvoicePosition, AbstractOpportunityPosition, AbstractQuotePosition, AbstractRemovedPosition, AbstractSalesOrderPosition, InvoicePosition, OpportunityPosition, QuotePosition, RemovedPosition, SalesOrderPosition

public interface ContractPosition
extends AddressContainer, DeliveryRequestContainer, ShippingDetail, BookingOrigin, DepotReferenceHolder

Abstract class ContractPosition

Method Summary

void	addDeliveryInformation(boolean idIsPersistent, String id, DeliveryInformation deliveryInformation) Adds the specified element to the set of the values for the reference deliveryInformation.
void	addProductApplication(boolean idIsPersistent, String id, ProductApplication productApplication) Adds the specified element to the set of the values for the reference productApplication.
BigDecimal	getAmount() Retrieves the possibly null value for the optional attribute amount.
BigDecimal	getBaseAmount() Retrieves the possibly null value for the optional attribute baseAmount.
CalculationRule	getCalcRule() Retrieves the value for the reference calcRule.
<T extends Account> List<T>	getContact() Retrieves the Collection of objects referenced by contact.
short	getContractPositionState() Retrieves the value for the attribute contractPositionState.
<T extends DeliveryInformation> Collection<T>	getDeliveryInformation() Retrieves a set containing all the elements for the reference deliveryInformation.
DeliveryInformation	getDeliveryInformation(boolean idIsPersistent, String id) Retrieves the value for the reference deliveryInformation for the specified qualifier attribute value.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
BigDecimal	getDiscount() Retrieves the possibly null value for the optional attribute discount.
BigDecimal	getDiscountAmount() Retrieves the possibly null value for the optional attribute discountAmount.
String	getDiscountDescription() Retrieves the possibly null value for the optional attribute discountDescription.
long	getLineItemNumber() Retrieves the value for the attribute lineItemNumber.
ProductBasePrice	getListPrice() Retrieves the value for the reference listPrice.
BigDecimal	getMaxQuantity() Retrieves the possibly null value for the optional attribute maxQuantity.
short	getMinMaxQuantityHandling() Retrieves the value for the attribute minMaxQuantityHandling.
BigDecimal	getMinQuantity() Retrieves the possibly null value for the optional attribute minQuantity.
String	getName() Retrieves the value for the attribute name.
BigDecimal	getOffsetQuantity() Retrieves the possibly null value for the optional attribute offsetQuantity.
<T extends PositionModification> Collection<T>	getPositionModification() Retrieves a set containing all the elements for the reference positionModification.
PositionModification	getPositionModification(boolean idIsPersistent, String id) Retrieves the value for the reference positionModification for the specified qualifier attribute value.
String	getPositionNumber() Retrieves the value for the attribute positionNumber.
AbstractPriceLevel	getPriceLevel() Retrieves the value for the reference priceLevel.
BigDecimal	getPricePerUnit() Retrieves the possibly null value for the optional attribute pricePerUnit.
Uom	getPriceUom() Retrieves the value for the reference priceUom.
String	getPriceUomDescription() Retrieves the possibly null value for the optional attribute priceUomDescription.
String	getPriceUomDetailedDescription() Retrieves the possibly null value for the optional attribute priceUomDetailedDescription.
Date	getPricingDate() Retrieves the possibly null value for the optional attribute pricingDate.
PricingRule	getPricingRule() Retrieves the value for the reference pricingRule.
short	getPricingState() Retrieves the value for the attribute pricingState.
<T extends ProductApplication> Collection<T>	getProductApplication() Retrieves a set containing all the elements for the reference productApplication.
ProductApplication	getProductApplication(boolean idIsPersistent, String id) Retrieves the value for the reference productApplication for the specified qualifier attribute value.
String	getProductDescription() Retrieves the possibly null value for the optional attribute productDescription.
String	getProductDetailedDescription() Retrieves the possibly null value for the optional attribute productDetailedDescription.
BigDecimal	getQuantity() Retrieves the possibly null value for the optional attribute quantity.
BigDecimal	getQuantityBackOrdered() Retrieves the possibly null value for the optional attribute quantityBackOrdered.
BigDecimal	getQuantityShipped() Retrieves the possibly null value for the optional attribute quantityShipped.
BigDecimal	getSalesCommission() Retrieves the possibly null value for the optional attribute salesCommission.
SalesTaxType	getSalesTaxType() Retrieves the value for the reference salesTaxType.
String	getSalesTaxTypeDescription() Retrieves the possibly null value for the optional attribute salesTaxTypeDescription.
String	getSalesTaxTypeDetailedDescription() Retrieves the possibly null value for the optional attribute salesTaxTypeDetailedDescription.
BigDecimal	getTaxAmount() Retrieves the possibly null value for the optional attribute taxAmount.
Uom	getUom() Retrieves the value for the reference uom.
String	getUomDescription() Retrieves the possibly null value for the optional attribute uomDescription.
String	getUomDetailedDescription() Retrieves the possibly null value for the optional attribute uomDetailedDescription.
Boolean	isDiscountIsPercentage() Retrieves the possibly null value for the optional attribute discountIsPercentage.
Boolean	isSalesCommissionIsPercentage() Retrieves the possibly null value for the optional attribute salesCommissionIsPercentage.
org.openmdx.base.cci2.Void	reprice()
void	setCalcRule(CalculationRule calcRule) Sets a new value for the reference calcRule.
void	setContractPositionState(short contractPositionState) Sets a new value for the attribute contractPositionState.
void	setDescription(String description) Sets a new value for the attribute description.
void	setDiscount(BigDecimal discount) Sets a new value for the attribute discount.
void	setDiscountDescription(String discountDescription) Sets a new value for the attribute discountDescription.
void	setDiscountIsPercentage(Boolean discountIsPercentage) Sets a new value for the attribute discountIsPercentage.
void	setListPrice(ProductBasePrice listPrice) Sets a new value for the reference listPrice.
void	setMaxQuantity(BigDecimal maxQuantity) Sets a new value for the attribute maxQuantity.
void	setMinMaxQuantityHandling(short minMaxQuantityHandling) Sets a new value for the attribute minMaxQuantityHandling.
void	setMinQuantity(BigDecimal minQuantity) Sets a new value for the attribute minQuantity.
void	setName(String name) Sets a new value for the attribute name.
void	setOffsetQuantity(BigDecimal offsetQuantity) Sets a new value for the attribute offsetQuantity.
void	setPositionNumber(String positionNumber) Sets a new value for the attribute positionNumber.
void	setPriceLevel(AbstractPriceLevel priceLevel) Sets a new value for the reference priceLevel.
void	setPricePerUnit(BigDecimal pricePerUnit) Sets a new value for the attribute pricePerUnit.
void	setPriceUom(Uom priceUom) Sets a new value for the reference priceUom.
void	setPricingDate(Date pricingDate) Sets a new value for the attribute pricingDate.
void	setPricingRule(PricingRule pricingRule) Sets a new value for the reference pricingRule.
void	setPricingState(short pricingState) Sets a new value for the attribute pricingState.
void	setQuantity(BigDecimal quantity) Sets a new value for the attribute quantity.
void	setSalesCommission(BigDecimal salesCommission) Sets a new value for the attribute salesCommission.
void	setSalesCommissionIsPercentage(Boolean salesCommissionIsPercentage) Sets a new value for the attribute salesCommissionIsPercentage.
void	setSalesTaxType(SalesTaxType salesTaxType) Sets a new value for the reference salesTaxType.
void	setUom(Uom uom) Sets a new value for the reference uom.

Methods inherited from interface org.opencrx.kernel.contract1.cci2.AddressContainer

addAddress, getAddress, getAddress

Methods inherited from interface org.opencrx.kernel.contract1.cci2.DeliveryRequestContainer

addDeliveryRequest, getDeliveryRequest, getDeliveryRequest

Methods inherited from interface org.opencrx.kernel.contract1.cci2.ShippingDetail

getCarrier, getGiftMessage, getShippingInstructions, getShippingMethod, getShippingTrackingNumber, isGift, setCarrier, setGift, setGiftMessage, setShippingInstructions, setShippingMethod, setShippingTrackingNumber

Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotReferenceHolder

addDepotReference, getDepotReference, getDepotReference

Method Detail

getAmount

BigDecimal getAmount()

Retrieves the possibly null value for the optional attribute amount.

Returns:

The possibly null value for attribute amount.

getBaseAmount

BigDecimal getBaseAmount()

Retrieves the possibly null value for the optional attribute baseAmount.

Returns:

The possibly null value for attribute baseAmount.

getCalcRule

CalculationRule getCalcRule()

Retrieves the value for the reference calcRule.

Returns:

The – possibly null – value for this reference.

setCalcRule

void setCalcRule(CalculationRule calcRule)

Sets a new value for the reference calcRule.

Parameters:

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

getContact

<T extends Account> List<T> getContact()

Retrieves the Collection of objects referenced by contact.

Returns:

The Collection of referenced objects.

getContractPositionState

short getContractPositionState()

Retrieves the value for the attribute contractPositionState.

Returns:

The non-null value for attribute contractPositionState.

setContractPositionState

void setContractPositionState(short contractPositionState)

Sets a new value for the attribute contractPositionState.

Parameters:

contractPositionState - The non-null new value for attribute contractPositionState.

getDeliveryInformation

<T extends DeliveryInformation> Collection<T> getDeliveryInformation()

Retrieves a set containing all the elements for the reference deliveryInformation.

Returns:

A set containing all the elements for this reference.

getDeliveryInformation

DeliveryInformation getDeliveryInformation(boolean idIsPersistent,
                                           String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

addDeliveryInformation

void addDeliveryInformation(boolean idIsPersistent,
                            String id,
                            DeliveryInformation deliveryInformation)

Adds the specified element to the set of the values for the reference deliveryInformation.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

deliveryInformation - The element to be appended.

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getDiscount

BigDecimal getDiscount()

Retrieves the possibly null value for the optional attribute discount.

Returns:

The possibly null value for attribute discount.

setDiscount

void setDiscount(BigDecimal discount)

Sets a new value for the attribute discount.

Parameters:

discount - The possibly null new value for attribute discount.

getDiscountAmount

BigDecimal getDiscountAmount()

Retrieves the possibly null value for the optional attribute discountAmount.

Returns:

The possibly null value for attribute discountAmount.

getDiscountDescription

String getDiscountDescription()

Retrieves the possibly null value for the optional attribute discountDescription.

Returns:

The possibly null value for attribute discountDescription.

setDiscountDescription

void setDiscountDescription(String discountDescription)

Sets a new value for the attribute discountDescription.

Parameters:

discountDescription - The possibly null new value for attribute discountDescription.

isDiscountIsPercentage

Boolean isDiscountIsPercentage()

Retrieves the possibly null value for the optional attribute discountIsPercentage.

Returns:

The possibly null value for attribute discountIsPercentage.

setDiscountIsPercentage

void setDiscountIsPercentage(Boolean discountIsPercentage)

Sets a new value for the attribute discountIsPercentage.

Parameters:

discountIsPercentage - The possibly null new value for attribute discountIsPercentage.

getLineItemNumber

long getLineItemNumber()

Retrieves the value for the attribute lineItemNumber.

Returns:

The non-null value for attribute lineItemNumber.

getListPrice

ProductBasePrice getListPrice()

Retrieves the value for the reference listPrice.

Returns:

The – possibly null – value for this reference.

setListPrice

void setListPrice(ProductBasePrice listPrice)

Sets a new value for the reference listPrice.

Parameters:

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

getMaxQuantity

BigDecimal getMaxQuantity()

Retrieves the possibly null value for the optional attribute maxQuantity.

Returns:

The possibly null value for attribute maxQuantity.

setMaxQuantity

void setMaxQuantity(BigDecimal maxQuantity)

Sets a new value for the attribute maxQuantity.

Parameters:

maxQuantity - The possibly null new value for attribute maxQuantity.

getMinMaxQuantityHandling

short getMinMaxQuantityHandling()

Retrieves the value for the attribute minMaxQuantityHandling.

Returns:

The non-null value for attribute minMaxQuantityHandling.

setMinMaxQuantityHandling

void setMinMaxQuantityHandling(short minMaxQuantityHandling)

Sets a new value for the attribute minMaxQuantityHandling.

Parameters:

minMaxQuantityHandling - The non-null new value for attribute minMaxQuantityHandling.

getMinQuantity

BigDecimal getMinQuantity()

Retrieves the possibly null value for the optional attribute minQuantity.

Returns:

The possibly null value for attribute minQuantity.

setMinQuantity

void setMinQuantity(BigDecimal minQuantity)

Sets a new value for the attribute minQuantity.

Parameters:

minQuantity - The possibly null new value for attribute minQuantity.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

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

getOffsetQuantity

BigDecimal getOffsetQuantity()

Retrieves the possibly null value for the optional attribute offsetQuantity.

Returns:

The possibly null value for attribute offsetQuantity.

setOffsetQuantity

void setOffsetQuantity(BigDecimal offsetQuantity)

Sets a new value for the attribute offsetQuantity.

Parameters:

offsetQuantity - The possibly null new value for attribute offsetQuantity.

getPositionModification

<T extends PositionModification> Collection<T> getPositionModification()

Retrieves a set containing all the elements for the reference positionModification.

Returns:

A set containing all the elements for this reference.

getPositionModification

PositionModification getPositionModification(boolean idIsPersistent,
                                             String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getPositionNumber

String getPositionNumber()

Retrieves the value for the attribute positionNumber.

Returns:

The non-null value for attribute positionNumber.

setPositionNumber

void setPositionNumber(String positionNumber)

Sets a new value for the attribute positionNumber.

Parameters:

positionNumber - The non-null new value for attribute positionNumber.

getPriceLevel

AbstractPriceLevel getPriceLevel()

Retrieves the value for the reference priceLevel.

Returns:

The – possibly null – value for this reference.

setPriceLevel

void setPriceLevel(AbstractPriceLevel priceLevel)

Sets a new value for the reference priceLevel.

Parameters:

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

getPricePerUnit

BigDecimal getPricePerUnit()

Retrieves the possibly null value for the optional attribute pricePerUnit.

Returns:

The possibly null value for attribute pricePerUnit.

setPricePerUnit

void setPricePerUnit(BigDecimal pricePerUnit)

Sets a new value for the attribute pricePerUnit.

Parameters:

pricePerUnit - The possibly null new value for attribute pricePerUnit.

getPriceUom

Uom getPriceUom()

Retrieves the value for the reference priceUom.

Returns:

The – possibly null – value for this reference.

setPriceUom

void setPriceUom(Uom priceUom)

Sets a new value for the reference priceUom.

Parameters:

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

getPriceUomDescription

String getPriceUomDescription()

Retrieves the possibly null value for the optional attribute priceUomDescription.

Returns:

The possibly null value for attribute priceUomDescription.

getPriceUomDetailedDescription

String getPriceUomDetailedDescription()

Retrieves the possibly null value for the optional attribute priceUomDetailedDescription.

Returns:

The possibly null value for attribute priceUomDetailedDescription.

getPricingDate

Date getPricingDate()

Retrieves the possibly null value for the optional attribute pricingDate.

Returns:

The possibly null value for attribute pricingDate.

setPricingDate

void setPricingDate(Date pricingDate)

Sets a new value for the attribute pricingDate.

Parameters:

pricingDate - The possibly null new value for attribute pricingDate.

getPricingRule

PricingRule getPricingRule()

Retrieves the value for the reference pricingRule.

Returns:

The – possibly null – value for this reference.

setPricingRule

void setPricingRule(PricingRule pricingRule)

Sets a new value for the reference pricingRule.

Parameters:

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

getPricingState

short getPricingState()

Retrieves the value for the attribute pricingState.

Returns:

The non-null value for attribute pricingState.

setPricingState

void setPricingState(short pricingState)

Sets a new value for the attribute pricingState.

Parameters:

pricingState - The non-null new value for attribute pricingState.

getProductApplication

<T extends ProductApplication> Collection<T> getProductApplication()

Retrieves a set containing all the elements for the reference productApplication.

Returns:

A set containing all the elements for this reference.

getProductApplication

ProductApplication getProductApplication(boolean idIsPersistent,
                                         String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

addProductApplication

void addProductApplication(boolean idIsPersistent,
                           String id,
                           ProductApplication productApplication)

Adds the specified element to the set of the values for the reference productApplication.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

productApplication - The element to be appended.

getProductDescription

String getProductDescription()

Retrieves the possibly null value for the optional attribute productDescription.

Returns:

The possibly null value for attribute productDescription.

getProductDetailedDescription

String getProductDetailedDescription()

Retrieves the possibly null value for the optional attribute productDetailedDescription.

Returns:

The possibly null value for attribute productDetailedDescription.

getQuantity

BigDecimal getQuantity()

Retrieves the possibly null value for the optional attribute quantity.

Returns:

The possibly null value for attribute quantity.

setQuantity

void setQuantity(BigDecimal quantity)

Sets a new value for the attribute quantity.

Parameters:

quantity - The possibly null new value for attribute quantity.

getQuantityBackOrdered

BigDecimal getQuantityBackOrdered()

Retrieves the possibly null value for the optional attribute quantityBackOrdered.

Returns:

The possibly null value for attribute quantityBackOrdered.

getQuantityShipped

BigDecimal getQuantityShipped()

Retrieves the possibly null value for the optional attribute quantityShipped.

Returns:

The possibly null value for attribute quantityShipped.

reprice

org.openmdx.base.cci2.Void reprice()

getSalesCommission

BigDecimal getSalesCommission()

Retrieves the possibly null value for the optional attribute salesCommission.

Returns:

The possibly null value for attribute salesCommission.

setSalesCommission

void setSalesCommission(BigDecimal salesCommission)

Sets a new value for the attribute salesCommission.

Parameters:

salesCommission - The possibly null new value for attribute salesCommission.

isSalesCommissionIsPercentage

Boolean isSalesCommissionIsPercentage()

Retrieves the possibly null value for the optional attribute salesCommissionIsPercentage.

Returns:

The possibly null value for attribute salesCommissionIsPercentage.

setSalesCommissionIsPercentage

void setSalesCommissionIsPercentage(Boolean salesCommissionIsPercentage)

Sets a new value for the attribute salesCommissionIsPercentage.

Parameters:

salesCommissionIsPercentage - The possibly null new value for attribute salesCommissionIsPercentage.

getSalesTaxType

SalesTaxType getSalesTaxType()

Retrieves the value for the reference salesTaxType.

Returns:

The non-null value for this reference.

setSalesTaxType

void setSalesTaxType(SalesTaxType salesTaxType)

Sets a new value for the reference salesTaxType.

Parameters:

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

getSalesTaxTypeDescription

String getSalesTaxTypeDescription()

Retrieves the possibly null value for the optional attribute salesTaxTypeDescription.

Returns:

The possibly null value for attribute salesTaxTypeDescription.

getSalesTaxTypeDetailedDescription

String getSalesTaxTypeDetailedDescription()

Retrieves the possibly null value for the optional attribute salesTaxTypeDetailedDescription.

Returns:

The possibly null value for attribute salesTaxTypeDetailedDescription.

getTaxAmount

BigDecimal getTaxAmount()

Retrieves the possibly null value for the optional attribute taxAmount.

Returns:

The possibly null value for attribute taxAmount.

getUom

Uom getUom()

Retrieves the value for the reference uom.

Returns:

The – possibly null – value for this reference.

setUom

void setUom(Uom uom)

Sets a new value for the reference uom.

Parameters:

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

getUomDescription

String getUomDescription()

Retrieves the possibly null value for the optional attribute uomDescription.

Returns:

The possibly null value for attribute uomDescription.

getUomDetailedDescription

String getUomDetailedDescription()

Retrieves the possibly null value for the optional attribute uomDetailedDescription.

Returns:

The possibly null value for attribute uomDetailedDescription.