org.opencrx.kernel.contract1.cci
Interface AbstractContract

All Superinterfaces:

AddressContainer, Assignable, DeliveryRequestContainer, DepotReferenceHolder, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ShippingDetail, TemplateEnabled

All Known Subinterfaces:

Invoice, Lead, Opportunity, Quote, SalesOrder

All Known Implementing Classes:

AbstractContractImpl, InvoiceImpl, LeadImpl, OpportunityImpl, QuoteImpl, SalesOrderImpl

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

Method Summary

void	addActivity(Activity newValue)
void	addActivity(int index, Activity newValue)
void	addCompetitor(Competitor newValue)
void	addCompetitor(int index, Competitor newValue)
void	addContact(Contact newValue)
void	addContact(int index, Contact newValue)
CreatePositionResult	createPosition(CreatePositionParams params)
CreatePositionResult	createPosition(String name, Uom priceUom, Date pricingDate, PricingRule pricingRule, Product product, BigDecimal quantity, Uom uom)
CreateProductOfferingPositionResult	createProductOfferingPosition(CreateProductOfferingPositionParams params)
CreateProductOfferingPositionResult	createProductOfferingPosition(ProductOffering offering, BigDecimal quantity)
Date	getActiveOn()
Collection	getActivity() Retrieves the objects referenced by activity.
Activity	getActivity(int index) Retrieves the value for the reference activity for the specified qualifier attribute value.
Account	getBroker() Retrieves the value for the optional reference broker.
CalculationRule	getCalcRule() Retrieves the value for the optional reference calcRule.
Date	getCancelOn()
Date	getClosedOn()
Collection	getCompetitor() Retrieves the objects referenced by competitor.
Competitor	getCompetitor(int index) Retrieves the value for the reference competitor for the specified qualifier attribute value.
Collection	getContact() Retrieves the objects referenced by contact.
Contact	getContact(int index) Retrieves the value for the reference contact for the specified qualifier attribute value.
short	getContractCurrency() Retrieves the value for the attribute contractCurrency.
short	getContractLanguage() Retrieves the value for the attribute contractLanguage.
String	getContractNumber()
short	getContractState() Retrieves the value for the attribute contractState.
Account	getCustomer() Retrieves the value for the optional reference customer.
String	getDescription()
Date	getExpiresOn()
Collection	getInventoryCb() Retrieves the objects referenced by inventoryCb.
CompoundBooking	getInventoryCb(int index) Retrieves the value for the reference inventoryCb for the specified qualifier attribute value.
String	getName() Retrieves the value for the attribute name.
AbstractContract	getOrigin() Retrieves the value for the optional reference origin.
short	getPaymentTerms() Retrieves the value for the attribute paymentTerms.
Collection	getPositionModification() Retrieves a collection containing all the elements for the reference positionModification.
List	getPositionModification(PositionModificationFilter filter) Retrieves the value for the reference positionModification for the specified filter.
List	getPositionModification(PositionModificationQuery query) Retrieves the value for the reference positionModification for the specified query.
PositionModification	getPositionModification(String id) Retrieves the value for the reference positionModification for the specified qualifier attribute value.
Date	getPricingDate()
PricingRule	getPricingRule() Retrieves the value for the optional reference pricingRule.
short	getPricingState() Retrieves the value for the attribute pricingState.
short	getPriority() Retrieves the value for the attribute priority.
Collection	getRemovedPosition() Retrieves a collection containing all the elements for the reference removedPosition.
List	getRemovedPosition(AbstractRemovedPositionFilter filter) Retrieves the value for the reference removedPosition for the specified filter.
List	getRemovedPosition(AbstractRemovedPositionQuery query) Retrieves the value for the reference removedPosition for the specified query.
AbstractRemovedPosition	getRemovedPosition(String id) Retrieves the value for the reference removedPosition for the specified qualifier attribute value.
Account	getSalesRep() Retrieves the value for the optional reference salesRep.
Account	getSupplier() Retrieves the value for the optional 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.
void	removeActivity(int index)
void	removeBroker() Removes the value for the optional reference broker.
void	removeCalcRule() Removes the value for the optional reference calcRule.
void	removeCompetitor(int index)
void	removeContact(int index)
void	removeCustomer() Removes the value for the optional reference customer.
void	removeOrigin() Removes the value for the optional reference origin.
Void	removePendingInventoryBookings()
Void	removePendingInventoryBookings(Void params)
void	removePricingRule() Removes the value for the optional reference pricingRule.
void	removeSalesRep() Removes the value for the optional reference salesRep.
void	removeSupplier() Removes the value for the optional reference supplier.
Void	reprice()
Void	reprice(Void params)
void	setActiveOn(Date newValue) Sets a new value for the attribute activeOn.
void	setBroker(Account newValue) Sets a new value for the reference broker.
void	setCalcRule(CalculationRule newValue) Sets a new value for the reference calcRule.
void	setCancelOn(Date newValue) Sets a new value for the attribute cancelOn.
void	setClosedOn(Date newValue) Sets a new value for the attribute closedOn.
void	setContractCurrency(short newValue) Sets a new value for the attribute contractCurrency.
void	setContractLanguage(short newValue) Sets a new value for the attribute contractLanguage.
void	setContractNumber(String newValue) Sets a new value for the attribute contractNumber.
void	setContractState(short newValue) Sets a new value for the attribute contractState.
void	setCustomer(Account newValue) Sets a new value for the reference customer.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setExpiresOn(Date newValue) Sets a new value for the attribute expiresOn.
void	setName(String newValue) Sets a new value for the attribute name.
void	setOrigin(AbstractContract newValue) Sets a new value for the reference origin.
void	setPaymentTerms(short newValue) Sets a new value for the attribute paymentTerms.
void	setPricingDate(Date newValue) Sets a new value for the attribute pricingDate.
void	setPricingRule(PricingRule newValue) Sets a new value for the reference pricingRule.
void	setPriority(short newValue) Sets a new value for the attribute priority.
void	setSalesRep(Account newValue) Sets a new value for the reference salesRep.
void	setSupplier(Account newValue) Sets a new value for the reference supplier.
UpdateInventoryResult	updateInventory()
UpdateInventoryResult	updateInventory(Void params)

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

assignToMe, assignToMe

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

addReplacement, addReplacement, applyReplacements, applyReplacements, createObject, createObject, deleteObject, deleteObject, getReplacement, getReplacement, getReplacement, getReplacement, getTemplateReferenceFilter, isTemplate, removeReplacement, setTemplate, setTemplateReferenceFilter

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

addAddress, addAddress, getAddress, getAddress, getAddress, getAddress, removeAddress

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

addDeliveryRequest, addDeliveryRequest, getDeliveryRequest, getDeliveryRequest, getDeliveryRequest, getDeliveryRequest, removeDeliveryRequest

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

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

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

addDepotReference, addDepotReference, getDepotReference, getDepotReference, getDepotReference, getDepotReference, removeDepotReference

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

Method Detail

getActiveOn

Date getActiveOn()

Returns:

The possibly null value for attribute activeOn.

Throws:

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

setActiveOn

void setActiveOn(Date newValue)

Sets a new value for the attribute activeOn.

Parameters:

newValue - The possibly null new value for attribute activeOn.

Throws:

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

getActivity

Activity getActivity(int index)

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

Parameters:

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

getActivity

Collection getActivity()

Retrieves the objects referenced by activity.

Returns:

The collection of referenced objects.

Throws:

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

addActivity

void addActivity(int index,
                 Activity newValue)

Parameters:

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

addActivity

void addActivity(Activity newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeActivity

void removeActivity(int index)

Throws:

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

getBroker

Account getBroker()

Retrieves the value for the optional reference broker.

Returns:

The possibly null value for this reference.

Throws:

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

setBroker

void setBroker(Account newValue)

Sets a new value for the reference broker.

Parameters:

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

Throws:

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

removeBroker

void removeBroker()

Removes the value for the optional reference broker.

Throws:

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

getCalcRule

CalculationRule getCalcRule()

Retrieves the value for the optional reference calcRule.

Returns:

The possibly null value for this reference.

Throws:

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

setCalcRule

void setCalcRule(CalculationRule newValue)

Sets a new value for the reference calcRule.

Parameters:

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

Throws:

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

removeCalcRule

void removeCalcRule()

Removes the value for the optional reference calcRule.

Throws:

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

getCancelOn

Date getCancelOn()

Returns:

The possibly null value for attribute cancelOn.

Throws:

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

setCancelOn

void setCancelOn(Date newValue)

Sets a new value for the attribute cancelOn.

Parameters:

newValue - The possibly null new value for attribute cancelOn.

Throws:

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

getClosedOn

Date getClosedOn()

Returns:

The possibly null value for attribute closedOn.

Throws:

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

setClosedOn

void setClosedOn(Date newValue)

Sets a new value for the attribute closedOn.

Parameters:

newValue - The possibly null new value for attribute closedOn.

Throws:

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

getCompetitor

Competitor getCompetitor(int index)

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

Parameters:

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

getCompetitor

Collection getCompetitor()

Retrieves the objects referenced by competitor.

Returns:

The collection of referenced objects.

Throws:

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

addCompetitor

void addCompetitor(int index,
                   Competitor newValue)

Parameters:

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

addCompetitor

void addCompetitor(Competitor newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeCompetitor

void removeCompetitor(int index)

Throws:

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

getContact

Contact getContact(int index)

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

Parameters:

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

getContact

Collection getContact()

Retrieves the objects referenced by contact.

Returns:

The collection of referenced objects.

Throws:

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

addContact

void addContact(int index,
                Contact newValue)

Parameters:

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

addContact

void addContact(Contact newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeContact

void removeContact(int index)

Throws:

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

getContractCurrency

short getContractCurrency()

Retrieves the value for the attribute contractCurrency.

Returns:

The non-null value for attribute contractCurrency.

Throws:

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

setContractCurrency

void setContractCurrency(short newValue)

Sets a new value for the attribute contractCurrency.

Parameters:

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

Throws:

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

getContractLanguage

short getContractLanguage()

Retrieves the value for the attribute contractLanguage.

Returns:

The non-null value for attribute contractLanguage.

Throws:

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

setContractLanguage

void setContractLanguage(short newValue)

Sets a new value for the attribute contractLanguage.

Parameters:

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

Throws:

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

getContractNumber

String getContractNumber()

Returns:

The possibly null value for attribute contractNumber.

Throws:

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

setContractNumber

void setContractNumber(String newValue)

Sets a new value for the attribute contractNumber.

Parameters:

newValue - The possibly null new value for attribute contractNumber.

Throws:

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

getContractState

short getContractState()

Retrieves the value for the attribute contractState.

Returns:

The non-null value for attribute contractState.

Throws:

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

setContractState

void setContractState(short newValue)

Sets a new value for the attribute contractState.

Parameters:

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

Throws:

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

createPosition

CreatePositionResult createPosition(CreatePositionParams params)
                                    throws RefException

Throws:

RefException

createPosition

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

Throws:

RefException

createProductOfferingPosition

CreateProductOfferingPositionResult createProductOfferingPosition(CreateProductOfferingPositionParams params)
                                                                  throws RefException

Throws:

RefException

createProductOfferingPosition

CreateProductOfferingPositionResult createProductOfferingPosition(ProductOffering offering,
                                                                  BigDecimal quantity)
                                                                  throws RefException

Throws:

RefException

getCustomer

Account getCustomer()

Retrieves the value for the optional reference customer.

Returns:

The possibly null value for this reference.

Throws:

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

setCustomer

void setCustomer(Account newValue)

Sets a new value for the reference customer.

Parameters:

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

Throws:

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

removeCustomer

void removeCustomer()

Removes the value for the optional reference customer.

Throws:

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

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.

getExpiresOn

Date getExpiresOn()

Returns:

The possibly null value for attribute expiresOn.

Throws:

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

setExpiresOn

void setExpiresOn(Date newValue)

Sets a new value for the attribute expiresOn.

Parameters:

newValue - The possibly null new value for attribute expiresOn.

Throws:

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

getInventoryCb

CompoundBooking getInventoryCb(int index)

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

Parameters:

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

getInventoryCb

Collection getInventoryCb()

Retrieves the objects referenced by inventoryCb.

Returns:

The collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved 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.

getOrigin

AbstractContract getOrigin()

Retrieves the value for the optional reference origin.

Returns:

The possibly null value for this reference.

Throws:

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

setOrigin

void setOrigin(AbstractContract newValue)

Sets a new value for the reference origin.

Parameters:

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

Throws:

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

removeOrigin

void removeOrigin()

Removes the value for the optional reference origin.

Throws:

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

getPaymentTerms

short getPaymentTerms()

Retrieves the value for the attribute paymentTerms.

Returns:

The non-null value for attribute paymentTerms.

Throws:

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

setPaymentTerms

void setPaymentTerms(short newValue)

Sets a new value for the attribute paymentTerms.

Parameters:

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

Throws:

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

getPositionModification

PositionModification getPositionModification(String id)

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

getPositionModification

Collection getPositionModification()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getPositionModification

List getPositionModification(PositionModificationFilter filter)

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

getPositionModification

List getPositionModification(PositionModificationQuery query)

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

getPricingDate

Date getPricingDate()

Returns:

The possibly null value for attribute pricingDate.

Throws:

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

setPricingDate

void setPricingDate(Date newValue)

Sets a new value for the attribute pricingDate.

Parameters:

newValue - The possibly null new value for attribute pricingDate.

Throws:

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

getPricingRule

PricingRule getPricingRule()

Retrieves the value for the optional reference pricingRule.

Returns:

The possibly null value for this reference.

Throws:

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

setPricingRule

void setPricingRule(PricingRule newValue)

Sets a new value for the reference pricingRule.

Parameters:

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

Throws:

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

removePricingRule

void removePricingRule()

Removes the value for the optional reference pricingRule.

Throws:

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

getPricingState

short getPricingState()

Retrieves the value for the attribute pricingState.

Returns:

The non-null value for attribute pricingState.

Throws:

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

getPriority

short getPriority()

Retrieves the value for the attribute priority.

Returns:

The non-null value for attribute priority.

Throws:

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

setPriority

void setPriority(short newValue)

Sets a new value for the attribute priority.

Parameters:

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

Throws:

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

removePendingInventoryBookings

Void removePendingInventoryBookings(Void params)
                                    throws RefException

Throws:

RefException

removePendingInventoryBookings

Void removePendingInventoryBookings()
                                    throws RefException

Throws: