org.opencrx.kernel.contract1.cci2
Interface AbstractContract

All Superinterfaces:

AddressContainer, Assignable, DeliveryRequestContainer, DepotReferenceHolder, SecureObject, ShippingDetail

All Known Subinterfaces:

AbstractContract, Invoice, Invoice, Lead, Lead, Opportunity, Opportunity, Quote, Quote, SalesOrder, SalesOrder

All Known Implementing Classes:

Invoice, Lead, Opportunity, Quote, SalesOrder

public interface AbstractContract
extends Assignable, SecureObject, AddressContainer, DeliveryRequestContainer, ShippingDetail, DepotReferenceHolder

Abstract class AbstractContract

Method Summary

CreatePositionResult	createPosition(String name, Uom priceUom, Date pricingDate, PricingRule pricingRule, Product product, BigDecimal quantity, Uom uom)
Date	getActiveOn() Retrieves the possibly null value for the optional attribute activeOn.
<T extends Activity> List<T>	getActivity() Retrieves the Collection of objects referenced by activity.
Account	getBroker() Retrieves the value for the reference broker.
CalculationRule	getCalcRule() Retrieves the value for the reference calcRule.
Date	getCancelOn() Retrieves the possibly null value for the optional attribute cancelOn.
Date	getClosedOn() Retrieves the possibly null value for the optional attribute closedOn.
<T extends Competitor> List<T>	getCompetitor() Retrieves the Collection of objects referenced by competitor.
<T extends Account> List<T>	getContact() Retrieves the Collection of objects referenced by contact.
short	getContractCurrency() Retrieves the value for the attribute contractCurrency.
short	getContractLanguage() Retrieves the value for the attribute contractLanguage.
String	getContractNumber() Retrieves the possibly null value for the optional attribute contractNumber.
short	getContractState() Retrieves the value for the attribute contractState.
Account	getCustomer() Retrieves the value for the reference customer.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
Date	getExpiresOn() Retrieves the possibly null value for the optional attribute expiresOn.
<T extends CompoundBooking> List<T>	getInventoryCb() Retrieves the Collection of objects referenced by inventoryCb.
String	getName() Retrieves the value for the attribute name.
AbstractContract	getOrigin() Retrieves the value for the reference origin.
short	getPaymentTerms() Retrieves the value for the attribute paymentTerms.
<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.
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.
short	getPriority() Retrieves the value for the attribute priority.
<T extends AbstractRemovedPosition> Collection<T>	getRemovedPosition() Retrieves a set containing all the elements for the reference removedPosition.
AbstractRemovedPosition	getRemovedPosition(boolean idIsPersistent, String id) Retrieves the value for the reference removedPosition for the specified qualifier attribute value.
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	setActiveOn(Date activeOn) Sets a new value for the attribute activeOn.
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	setCancelOn(Date cancelOn) Sets a new value for the attribute cancelOn.
void	setClosedOn(Date closedOn) Sets a new value for the attribute closedOn.
void	setContractCurrency(short contractCurrency) Sets a new value for the attribute contractCurrency.
void	setContractLanguage(short contractLanguage) Sets a new value for the attribute contractLanguage.
void	setContractNumber(String contractNumber) Sets a new value for the attribute contractNumber.
void	setContractState(short contractState) Sets a new value for the attribute contractState.
void	setCustomer(Account customer) Sets a new value for the reference customer.
void	setDescription(String description) Sets a new value for the attribute description.
void	setExpiresOn(Date expiresOn) Sets a new value for the attribute expiresOn.
void	setName(String name) Sets a new value for the attribute name.
void	setOrigin(AbstractContract origin) Sets a new value for the reference origin.
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	setPriority(short priority) Sets a new value for the attribute priority.
void	setSalesRep(Account salesRep) Sets a new value for the reference salesRep.
void	setSupplier(Account supplier) Sets a new value for the reference supplier.
UpdateInventoryResult	updateInventory()

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

assignToMe

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

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

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

getActiveOn

Date getActiveOn()

Retrieves the possibly null value for the optional attribute activeOn.

Returns:

The possibly null value for attribute activeOn.

setActiveOn

void setActiveOn(Date activeOn)

Sets a new value for the attribute activeOn.

Parameters:

activeOn - The possibly null new value for attribute activeOn.

getActivity

<T extends Activity> List<T> getActivity()

Retrieves the Collection of objects referenced by activity.

Returns:

The Collection of referenced objects.

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

getCancelOn

Date getCancelOn()

Retrieves the possibly null value for the optional attribute cancelOn.

Returns:

The possibly null value for attribute cancelOn.

setCancelOn

void setCancelOn(Date cancelOn)

Sets a new value for the attribute cancelOn.

Parameters:

cancelOn - The possibly null new value for attribute cancelOn.

getClosedOn

Date getClosedOn()

Retrieves the possibly null value for the optional attribute closedOn.

Returns:

The possibly null value for attribute closedOn.

setClosedOn

void setClosedOn(Date closedOn)

Sets a new value for the attribute closedOn.

Parameters:

closedOn - The possibly null new value for attribute closedOn.

getCompetitor

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

Retrieves the Collection of objects referenced by competitor.

Returns:

The Collection of referenced objects.

getContact

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

Retrieves the Collection of objects referenced by contact.

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.

getContractLanguage

short getContractLanguage()

Retrieves the value for the attribute contractLanguage.

Returns:

The non-null value for attribute contractLanguage.

setContractLanguage

void setContractLanguage(short contractLanguage)

Sets a new value for the attribute contractLanguage.

Parameters:

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

getContractNumber

String getContractNumber()

Retrieves the possibly null value for the optional attribute contractNumber.

Returns:

The possibly null value for attribute contractNumber.

setContractNumber

void setContractNumber(String contractNumber)

Sets a new value for the attribute contractNumber.

Parameters:

contractNumber - The possibly null new value for attribute contractNumber.

getContractState

short getContractState()

Retrieves the value for the attribute contractState.

Returns:

The non-null value for attribute contractState.

setContractState

void setContractState(short contractState)

Sets a new value for the attribute contractState.

Parameters:

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

createPosition

CreatePositionResult createPosition(String name,
                                    Uom priceUom,
                                    Date pricingDate,
                                    PricingRule pricingRule,
                                    Product product,
                                    BigDecimal quantity,
                                    Uom uom)

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

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.

getExpiresOn

Date getExpiresOn()

Retrieves the possibly null value for the optional attribute expiresOn.

Returns:

The possibly null value for attribute expiresOn.

setExpiresOn

void setExpiresOn(Date expiresOn)

Sets a new value for the attribute expiresOn.

Parameters:

expiresOn - The possibly null new value for attribute expiresOn.

getInventoryCb

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

Retrieves the Collection of objects referenced by inventoryCb.

Returns:

The Collection of referenced objects.

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.

getOrigin

AbstractContract getOrigin()

Retrieves the value for the reference origin.

Returns:

The – possibly null – value for this reference.

setOrigin

void setOrigin(AbstractContract origin)

Sets a new value for the reference origin.

Parameters:

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

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> 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

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.

getPriority

short getPriority()

Retrieves the value for the attribute priority.

Returns:

The non-null value for attribute priority.

setPriority

void setPriority(short priority)

Sets a new value for the attribute priority.

Parameters:

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

removePendingInventoryBookings

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

getRemovedPosition

<T extends AbstractRemovedPosition> Collection<T> getRemovedPosition()

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

Returns:

A set containing all the elements for this reference.

getRemovedPosition

AbstractRemovedPosition getRemovedPosition(boolean idIsPersistent,
                                           String id)

Retrieves the value for the reference removedPosition 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

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

getTotalAmount

BigDecimal getTotalAmount()

Retrieves the value for the attribute totalAmount.

Returns:

The non-null value for attribute totalAmount.

getTotalAmountIncludingTax

BigDecimal getTotalAmountIncludingTax()

Retrieves the value for the attribute totalAmountIncludingTax.

Returns:

The non-null value for attribute totalAmountIncludingTax.

getTotalBaseAmount

BigDecimal getTotalBaseAmount()

Retrieves the value for the attribute totalBaseAmount.

Returns:

The non-null value for attribute totalBaseAmount.

getTotalDiscountAmount

BigDecimal getTotalDiscountAmount()

Retrieves the value for the attribute totalDiscountAmount.

Returns:

The non-null value for attribute totalDiscountAmount.

getTotalSalesCommission

BigDecimal getTotalSalesCommission()

Retrieves the value for the attribute totalSalesCommission.

Returns:

The non-null value for attribute totalSalesCommission.

getTotalTaxAmount

BigDecimal getTotalTaxAmount()

Retrieves the value for the attribute totalTaxAmount.

Returns:

The non-null value for attribute totalTaxAmount.

updateInventory

UpdateInventoryResult updateInventory()