org.opencrx.kernel.contract1.cci2

Interface SalesContract

All Superinterfaces:

AbstractContract, AddressContainer, AlertSender, Assignable, Auditee, org.openmdx.base.cci2.BasicObject, BookingOrigin, Cloneable, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, CrxObject, DeliveryRequestContainer, DepotReferenceHolder, Exporter, Extended, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, LocalizedFieldContainer, org.openmdx.base.cci2.Modifiable, SecureObject, ShippingDetail

All Known Subinterfaces:

Invoice, Invoice, Lead, Lead, Opportunity, Opportunity, Quote, Quote, SalesContract, SalesOrder, SalesOrder

public interface SalesContract
extends AbstractContract

Abstract class SalesContract

Method Summary

Methods

Modifier and Type	Method and Description
CreatePositionResult	createPosition(CreatePositionParams in)
Account	getBroker() Retrieves the value for the reference broker.
CalculationRule	getCalcRule() Retrieves the value for the reference calcRule.
<T extends Competitor> List<T>	getCompetitor() Retrieves the Collection of objects referenced by competitor.
short	getContractCurrency() Retrieves the value for the attribute contractCurrency.
Account	getCustomer() Retrieves the value for the reference customer.
<T extends CompoundBooking> List<T>	getInventoryCb() Retrieves the Collection of objects referenced by inventoryCb.
short	getPaymentTerms() Retrieves the value for the attribute paymentTerms.
<T extends PositionModification> ContractContainsPositionModification.PositionModification<T>	getPositionModification() Retrieves a set containing all the elements for the reference positionModification.
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 AbstractRemovedPosition> ContractContainsRemovedPosition.RemovedPosition<T>	getRemovedPosition() Retrieves a set containing all the elements for the reference removedPosition.
Account	getSalesRep() Retrieves the value for the reference salesRep.
Account	getSupplier() Retrieves the value for the reference supplier.
BigDecimal	getTotalAmount() Retrieves the value for the attribute totalAmount.
BigDecimal	getTotalAmountIncludingTax() Retrieves the value for the attribute totalAmountIncludingTax.
BigDecimal	getTotalBaseAmount() Retrieves the value for the attribute totalBaseAmount.
BigDecimal	getTotalDiscountAmount() Retrieves the value for the attribute totalDiscountAmount.
BigDecimal	getTotalSalesCommission() Retrieves the value for the attribute totalSalesCommission.
BigDecimal	getTotalTaxAmount() Retrieves the value for the attribute totalTaxAmount.
org.openmdx.base.cci2.Void	removePendingInventoryBookings()
org.openmdx.base.cci2.Void	reprice()
void	setBroker(Account broker) Sets a new value for the reference broker.
void	setCalcRule(CalculationRule calcRule) Sets a new value for the reference calcRule.
void	setContractCurrency(short contractCurrency) Sets a new value for the attribute contractCurrency.
void	setCustomer(Account customer) Sets a new value for the reference customer.
void	setPaymentTerms(short paymentTerms) Sets a new value for the attribute paymentTerms.
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	setSalesRep(Account salesRep) Sets a new value for the reference salesRep.
void	setSupplier(Account supplier) Sets a new value for the reference supplier.
void	setTotalAmount(BigDecimal totalAmount) Sets a new value for the attribute totalAmount.
void	setTotalAmountIncludingTax(BigDecimal totalAmountIncludingTax) Sets a new value for the attribute totalAmountIncludingTax.
void	setTotalBaseAmount(BigDecimal totalBaseAmount) Sets a new value for the attribute totalBaseAmount.
void	setTotalDiscountAmount(BigDecimal totalDiscountAmount) Sets a new value for the attribute totalDiscountAmount.
void	setTotalSalesCommission(BigDecimal totalSalesCommission) Sets a new value for the attribute totalSalesCommission.
void	setTotalTaxAmount(BigDecimal totalTaxAmount) Sets a new value for the attribute totalTaxAmount.
UpdateInventoryResult	updateInventory()

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

getActiveOn, getActivity, getAssignedAccount, getCancelOn, getClosedOn, getContact, getContractLanguage, getContractNumber, getContractRole, getContractState, getContractType, getDescription, getExpiresOn, getGroupAssignment, getLastAppliedCreator, getLinkFrom, getLinkTo, getName, getOrigin, getPriority, reapplyContractCreator, setActiveOn, setCancelOn, setClosedOn, setContractLanguage, setContractNumber, setContractRole, setContractState, setContractType, setDescription, setExpiresOn, setLastAppliedCreator, setName, setOrigin, setPriority

Methods inherited from interface org.opencrx.kernel.base.cci2.Assignable

assignToMe

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

getAddress

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

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

getDepotReference

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

disableCrxObject, enableCrxObject, getAdditionalExternalLink, getAssignedTimer, getAttachedDocument, getCategory, getDisabledReason, getDocumentFolderAssignment, getExternalLink, getInvolvedObject, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

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

sendAlert

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

getAudit

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

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

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

importItem

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

getIndexEntry, updateIndex

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.generic.cci2.LocalizedFieldContainer

getLocalizedField

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

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

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Methods inherited from interface org.opencrx.kernel.generic.cci2.Extended

getExtCode0, getExtCode1, getExtCode2, getExtCode3, getExtCode4, getExtDate0, getExtDate1, getExtDate2, getExtDate3, getExtDate4, getExtDateTime0, getExtDateTime1, getExtDateTime2, getExtDateTime3, getExtDateTime4, getExtNumber0, getExtNumber1, getExtNumber2, getExtNumber3, getExtNumber4, getExtString0, getExtString1, getExtString2, getExtString3, getExtString4, isExtBoolean0, isExtBoolean1, isExtBoolean2, isExtBoolean3, isExtBoolean4, setExtBoolean0, setExtBoolean1, setExtBoolean2, setExtBoolean3, setExtBoolean4, setExtCode0, setExtCode1, setExtCode2, setExtCode3, setExtCode4, setExtDate0, setExtDate1, setExtDate2, setExtDate3, setExtDate4, setExtDateTime0, setExtDateTime1, setExtDateTime2, setExtDateTime3, setExtDateTime4, setExtNumber0, setExtNumber1, setExtNumber2, setExtNumber3, setExtNumber4, setExtString0, setExtString1, setExtString2, setExtString3, setExtString4

Method Detail

getBroker

Account getBroker()

Retrieves the value for the reference broker.

Returns:

The – possibly null – value for this reference.

setBroker

void setBroker(Account broker)

Sets a new value for the reference broker.

Parameters:

broker - The new – possibly null – value for this reference.

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 new – possibly null – value for this reference.

getCompetitor

<T extends Competitor> List<T> getCompetitor()

Retrieves the Collection of objects referenced by competitor.

Returns:

The Collection of referenced objects.

getContractCurrency

short getContractCurrency()

Retrieves the value for the attribute contractCurrency.

Returns:

The non-null value for attribute contractCurrency.

setContractCurrency

void setContractCurrency(short contractCurrency)

Sets a new value for the attribute contractCurrency.

Parameters:

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

createPosition

CreatePositionResult createPosition(CreatePositionParams in)

getCustomer

Account getCustomer()

Retrieves the value for the reference customer.

Returns:

The – possibly null – value for this reference.

setCustomer

void setCustomer(Account customer)

Sets a new value for the reference customer.

Parameters:

customer - The new – possibly null – value for this reference.

getInventoryCb

<T extends CompoundBooking> List<T> getInventoryCb()

Retrieves the Collection of objects referenced by inventoryCb.

Returns:

The Collection of referenced objects.

getPaymentTerms

short getPaymentTerms()

Retrieves the value for the attribute paymentTerms.

Returns:

The non-null value for attribute paymentTerms.

setPaymentTerms

void setPaymentTerms(short paymentTerms)

Sets a new value for the attribute paymentTerms.

Parameters:

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

getPositionModification

<T extends PositionModification> ContractContainsPositionModification.PositionModification<T> getPositionModification()

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

Returns:

A set containing all the elements for this reference.

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 new – possibly null – 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.

removePendingInventoryBookings

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

getRemovedPosition

<T extends AbstractRemovedPosition> ContractContainsRemovedPosition.RemovedPosition<T> getRemovedPosition()

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

Returns:

A set containing all the elements for this reference.

reprice

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

getSalesRep

Account getSalesRep()

Retrieves the value for the reference salesRep.

Returns:

The – possibly null – value for this reference.

setSalesRep

void setSalesRep(Account salesRep)

Sets a new value for the reference salesRep.

Parameters:

salesRep - The new – possibly null – value for this reference.

getSupplier

Account getSupplier()

Retrieves the value for the reference supplier.

Returns:

The – possibly null – value for this reference.

setSupplier

void setSupplier(Account supplier)

Sets a new value for the reference supplier.

Parameters:

supplier - The new – possibly null – value for this reference.

getTotalAmount

BigDecimal getTotalAmount()

Retrieves the value for the attribute totalAmount.

Returns:

The non-null value for attribute totalAmount.

setTotalAmount

void setTotalAmount(BigDecimal totalAmount)

Sets a new value for the attribute totalAmount.

Parameters:

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

getTotalAmountIncludingTax

BigDecimal getTotalAmountIncludingTax()

Retrieves the value for the attribute totalAmountIncludingTax.

Returns:

The non-null value for attribute totalAmountIncludingTax.

setTotalAmountIncludingTax

void setTotalAmountIncludingTax(BigDecimal totalAmountIncludingTax)

Sets a new value for the attribute totalAmountIncludingTax.

Parameters:

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

getTotalBaseAmount

BigDecimal getTotalBaseAmount()

Retrieves the value for the attribute totalBaseAmount.

Returns:

The non-null value for attribute totalBaseAmount.

setTotalBaseAmount

void setTotalBaseAmount(BigDecimal totalBaseAmount)

Sets a new value for the attribute totalBaseAmount.

Parameters:

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

getTotalDiscountAmount

BigDecimal getTotalDiscountAmount()

Retrieves the value for the attribute totalDiscountAmount.

Returns:

The non-null value for attribute totalDiscountAmount.

setTotalDiscountAmount

void setTotalDiscountAmount(BigDecimal totalDiscountAmount)

Sets a new value for the attribute totalDiscountAmount.

Parameters:

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

getTotalSalesCommission

BigDecimal getTotalSalesCommission()

Retrieves the value for the attribute totalSalesCommission.

Returns:

The non-null value for attribute totalSalesCommission.

setTotalSalesCommission

void setTotalSalesCommission(BigDecimal totalSalesCommission)

Sets a new value for the attribute totalSalesCommission.

Parameters:

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

getTotalTaxAmount

BigDecimal getTotalTaxAmount()

Retrieves the value for the attribute totalTaxAmount.

Returns:

The non-null value for attribute totalTaxAmount.

setTotalTaxAmount

void setTotalTaxAmount(BigDecimal totalTaxAmount)

Sets a new value for the attribute totalTaxAmount.

Parameters:

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

updateInventory

UpdateInventoryResult updateInventory()