org.opencrx.kernel.contract1.jmi1
Interface AbstractContract

All Superinterfaces:

AbstractContract, AddressContainer, AlertSender, AspectCapable, Assignable, Auditee, BasicObject, Cloneable, ContextCapable, Creatable, CrxObject, DeliveryRequestContainer, DepotReferenceHolder, Exporter, ExtentCapable, Importer, Indexed, Modifiable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ShippingDetail

All Known Subinterfaces:

Invoice, Lead, Opportunity, Quote, SalesOrder

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

Abstract class AbstractContract

Method Summary

void	addAssignedAccount(boolean idIsPersistent, String id, AccountAssignmentContract assignedAccount) Adds the specified element to the set of the values for the reference assignedAccount.
void	addAssignedAccount(String id, AccountAssignmentContract assignedAccount) Adds the specified element to the set of the values for the reference assignedAccount using a reassignable qualifier.
void	addLinkTo(boolean idIsPersistent, String id, ContractLinkTo linkTo) Adds the specified element to the set of the values for the reference linkTo.
void	addLinkTo(String id, ContractLinkTo linkTo) Adds the specified element to the set of the values for the reference linkTo using a reassignable qualifier.
CreatePositionResult	createPosition(CreatePositionParams in)
<T extends AccountAssignmentContract> List<T>	getAssignedAccount(AccountAssignmentContractQuery query) Retrieves the value for the reference assignedAccount for the specified query.
AccountAssignmentContract	getAssignedAccount(boolean idIsPersistent, String id) Retrieves the value for the reference assignedAccount for the specified qualifier attribute value.
AccountAssignmentContract	getAssignedAccount(String id) Retrieves the value for the reference assignedAccount for the specified qualifier attribute value.
Account	getBroker() Retrieves the value for the reference broker.
CalculationRule	getCalcRule() Retrieves the value for the reference calcRule.
Account	getCustomer() Retrieves the value for the reference customer.
ContractLinkFrom	getLinkFrom(boolean idIsPersistent, String id) Retrieves the value for the reference linkFrom for the specified qualifier attribute value.
<T extends ContractLinkFrom> List<T>	getLinkFrom(ContractLinkFromQuery query) Retrieves the value for the reference linkFrom for the specified query.
ContractLinkFrom	getLinkFrom(String id) Retrieves the value for the reference linkFrom for the specified qualifier attribute value.
ContractLinkTo	getLinkTo(boolean idIsPersistent, String id) Retrieves the value for the reference linkTo for the specified qualifier attribute value.
<T extends ContractLinkTo> List<T>	getLinkTo(ContractLinkToQuery query) Retrieves the value for the reference linkTo for the specified query.
ContractLinkTo	getLinkTo(String id) Retrieves the value for the reference linkTo for the specified qualifier attribute value.
AbstractContract	getOrigin() Retrieves the value for the reference origin.
PositionModification	getPositionModification(boolean idIsPersistent, String id) Retrieves the value for the reference positionModification for the specified qualifier attribute value.
<T extends PositionModification> List<T>	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.
PricingRule	getPricingRule() Retrieves the value for the reference pricingRule.
<T extends AbstractRemovedPosition> List<T>	getRemovedPosition(AbstractRemovedPositionQuery query) Retrieves the value for the reference removedPosition for the specified query.
AbstractRemovedPosition	getRemovedPosition(boolean idIsPersistent, String id) Retrieves the value for the reference removedPosition for the specified qualifier attribute value.
AbstractRemovedPosition	getRemovedPosition(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.
Void	removePendingInventoryBookings()
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	setCustomer(Account customer) Sets a new value for the reference customer.
void	setOrigin(AbstractContract origin) Sets a new value for the reference origin.
void	setPricingRule(PricingRule pricingRule) Sets a new value for the reference pricingRule.
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.contract1.cci2.AbstractContract

createPosition, getActiveOn, getActivity, getAssignedAccount, getCancelOn, getClosedOn, getCompetitor, getContact, getContractCurrency, getContractLanguage, getContractNumber, getContractState, getDescription, getExpiresOn, getInventoryCb, getLinkFrom, getLinkTo, getName, getPaymentTerms, getPositionModification, getPricingDate, getPricingState, getPriority, getRemovedPosition, getTotalAmount, getTotalAmountIncludingTax, getTotalBaseAmount, getTotalDiscountAmount, getTotalSalesCommission, getTotalTaxAmount, setActiveOn, setCancelOn, setClosedOn, setContractCurrency, setContractLanguage, setContractNumber, setContractState, setDescription, setExpiresOn, setName, setPaymentTerms, setPricingDate, setPriority

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

assignToMe

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

addAddress, addAddress, getAddress, getAddress, getAddress

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

getAddress

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

addDeliveryRequest, addDeliveryRequest, getDeliveryRequest, getDeliveryRequest, getDeliveryRequest

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

getDeliveryRequest

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

getCarrier, setCarrier

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

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

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

addDepotReference, addDepotReference, getDepotReference, getDepotReference, getDepotReference

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

getDepotReference

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

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addDocumentFolderAssignment, addDocumentFolderAssignment, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getDocumentFolderAssignment, getDocumentFolderAssignment, getDocumentFolderAssignment, getExternalLink, getMedia, getMedia, getMedia, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

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

getAdditionalExternalLink, getAttachedDocument, getDisabledReason, getDocumentFolderAssignment, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserString0, getUserString1, getUserString2, getUserString3, 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.jmi1.AlertSender

sendAlert

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

sendAlert

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

getAudit, getAudit, getAudit

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

getAudit

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

clone_

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

clone_

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

exportItem, exportItemAdvanced

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

exportItem, exportItemAdvanced

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

importItem

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

importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

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

getIndexEntry

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

addOwningGroup, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwningUser, setOwningUser

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

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

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

getContext

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

getCreatedBy

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

getCreatedAt

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

getIdentity

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

getModifiedBy

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

getModifiedAt

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

getAssignedAccount

<T extends AccountAssignmentContract> List<T> getAssignedAccount(AccountAssignmentContractQuery query)

Retrieves the value for the reference assignedAccount for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getAssignedAccount

AccountAssignmentContract getAssignedAccount(boolean idIsPersistent,
                                             String id)

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

getAssignedAccount

AccountAssignmentContract getAssignedAccount(String id)

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

This method is equivalent to the preferred invocation getAssignedAccount(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addAssignedAccount

void addAssignedAccount(boolean idIsPersistent,
                        String id,
                        AccountAssignmentContract assignedAccount)

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

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.

assignedAccount - The element to be appended.

addAssignedAccount

void addAssignedAccount(String id,
                        AccountAssignmentContract assignedAccount)

Adds the specified element to the set of the values for the reference assignedAccount using a reassignable qualifier.

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

Parameters:

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

assignedAccount - The element to be appended.

getBroker

Account getBroker()

Retrieves the value for the reference broker.

Specified by:

getBroker in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setBroker

void setBroker(Account broker)

Sets a new value for the reference broker.

Specified by:

setBroker in interface AbstractContract

Parameters:

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

getCalcRule

CalculationRule getCalcRule()

Retrieves the value for the reference calcRule.

Specified by:

getCalcRule in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setCalcRule

void setCalcRule(CalculationRule calcRule)

Sets a new value for the reference calcRule.

Specified by:

setCalcRule in interface AbstractContract

Parameters:

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

createPosition

CreatePositionResult createPosition(CreatePositionParams in)

getCustomer

Account getCustomer()

Retrieves the value for the reference customer.

Specified by:

getCustomer in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setCustomer

void setCustomer(Account customer)

Sets a new value for the reference customer.

Specified by:

setCustomer in interface AbstractContract

Parameters:

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

getLinkFrom

<T extends ContractLinkFrom> List<T> getLinkFrom(ContractLinkFromQuery query)

Retrieves the value for the reference linkFrom for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getLinkFrom

ContractLinkFrom getLinkFrom(boolean idIsPersistent,
                             String id)

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

getLinkFrom

ContractLinkFrom getLinkFrom(String id)

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

This method is equivalent to the preferred invocation getLinkFrom(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getLinkTo

<T extends ContractLinkTo> List<T> getLinkTo(ContractLinkToQuery query)

Retrieves the value for the reference linkTo for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getLinkTo

ContractLinkTo getLinkTo(boolean idIsPersistent,
                         String id)

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

getLinkTo

ContractLinkTo getLinkTo(String id)

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

This method is equivalent to the preferred invocation getLinkTo(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addLinkTo

void addLinkTo(boolean idIsPersistent,
               String id,
               ContractLinkTo linkTo)

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

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.

linkTo - The element to be appended.

addLinkTo

void addLinkTo(String id,
               ContractLinkTo linkTo)

Adds the specified element to the set of the values for the reference linkTo using a reassignable qualifier.

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

Parameters:

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

linkTo - The element to be appended.

getOrigin

AbstractContract getOrigin()

Retrieves the value for the reference origin.

Specified by:

getOrigin in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setOrigin

void setOrigin(AbstractContract origin)

Sets a new value for the reference origin.

Specified by:

setOrigin in interface AbstractContract

Parameters:

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

getPositionModification

<T extends PositionModification> List<T> getPositionModification(PositionModificationQuery query)

Retrieves the value for the reference positionModification for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getPositionModification

PositionModification getPositionModification(String id)

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

This method is equivalent to the preferred invocation getPositionModification(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getPricingRule

PricingRule getPricingRule()

Retrieves the value for the reference pricingRule.

Specified by:

getPricingRule in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setPricingRule

void setPricingRule(PricingRule pricingRule)

Sets a new value for the reference pricingRule.

Specified by:

setPricingRule in interface AbstractContract

Parameters:

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

removePendingInventoryBookings

Void removePendingInventoryBookings()

Specified by:

removePendingInventoryBookings in interface AbstractContract

getRemovedPosition

<T extends AbstractRemovedPosition> List<T> getRemovedPosition(AbstractRemovedPositionQuery query)

Retrieves the value for the reference removedPosition for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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

getRemovedPosition

AbstractRemovedPosition getRemovedPosition(String id)

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

This method is equivalent to the preferred invocation getRemovedPosition(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

reprice

Void reprice()

Specified by:

reprice in interface AbstractContract

getSalesRep

Account getSalesRep()

Retrieves the value for the reference salesRep.

Specified by:

getSalesRep in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setSalesRep

void setSalesRep(Account salesRep)

Sets a new value for the reference salesRep.

Specified by:

setSalesRep in interface AbstractContract

Parameters:

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

getSupplier

Account getSupplier()

Retrieves the value for the reference supplier.

Specified by:

getSupplier in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setSupplier

void setSupplier(Account supplier)

Sets a new value for the reference supplier.

Specified by:

setSupplier in interface AbstractContract

Parameters:

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

updateInventory

UpdateInventoryResult updateInventory()

Specified by:

updateInventory in interface AbstractContract