org.opencrx.kernel.contract1.jmi1

Interface AbstractContract

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, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject, ShippingDetail

All Known Subinterfaces:

GenericContract, Invoice, Lead, Opportunity, Quote, SalesContract, SalesOrder, SalesVolumeContract

public interface AbstractContract
extends AbstractContract, Assignable, AddressContainer, DeliveryRequestContainer, ShippingDetail, BookingOrigin, DepotReferenceHolder, CrxObject, Extended

Abstract class AbstractContract

isFrozenisFrozen

Method Summary

Methods

Modifier and Type	Method and Description
void	addAssignedAccount(AccountAssignmentContract assignedAccount) Adds the specified element to the set of the values for the reference assignedAccount using an implementation-specific, reassignable qualifier.
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	addGroupAssignment(boolean idIsPersistent, String id, ContractGroupAssignment groupAssignment) Adds the specified element to the set of the values for the reference groupAssignment.
void	addGroupAssignment(ContractGroupAssignment groupAssignment) Adds the specified element to the set of the values for the reference groupAssignment using an implementation-specific, reassignable qualifier.
void	addGroupAssignment(String id, ContractGroupAssignment groupAssignment) Adds the specified element to the set of the values for the reference groupAssignment 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(ContractLinkTo linkTo) Adds the specified element to the set of the values for the reference linkTo using an implementation-specific, reassignable qualifier.
void	addLinkTo(String id, ContractLinkTo linkTo) Adds the specified element to the set of the values for the reference linkTo using a reassignable qualifier.
<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.
List<Short>	getContractRole() Retrieves a list containing all the elements for the attribute contractRole.
ContractType	getContractType() Retrieves the value for the reference contractType.
ContractGroupAssignment	getGroupAssignment(boolean idIsPersistent, String id) Retrieves the value for the reference groupAssignment for the specified qualifier attribute value.
<T extends ContractGroupAssignment> List<T>	getGroupAssignment(ContractGroupAssignmentQuery query) Retrieves the value for the reference groupAssignment for the specified query.
ContractGroupAssignment	getGroupAssignment(String id) Retrieves the value for the reference groupAssignment for the specified qualifier attribute value.
ContractCreator	getLastAppliedCreator() Retrieves the value for the reference lastAppliedCreator.
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.
org.openmdx.base.jmi1.Void	reapplyContractCreator(ReapplyContractCreatorParams in)
void	setContractRole(List<Short> contractRole) Clears contractRole and adds the members of the given List.
void	setContractType(ContractType contractType) Sets a new value for the reference contractType.
void	setLastAppliedCreator(ContractCreator lastAppliedCreator) Sets a new value for the reference lastAppliedCreator.
void	setOrigin(AbstractContract origin) Sets a new value for the reference origin.

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

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

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

assignToMe

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

addAddress, 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, 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, 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, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addAttachedDocument, addDocumentFolderAssignment, addDocumentFolderAssignment, addDocumentFolderAssignment, addInvolvedObject, addInvolvedObject, addInvolvedObject, addMedia, addMedia, addMedia, addNote, addNote, addNote, addPropertySet, addPropertySet, addPropertySet, addRating, addRating, addRating, disableCrxObject, enableCrxObject, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAssignedTimer, getAssignedTimer, getAssignedTimer, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getDocumentFolderAssignment, getDocumentFolderAssignment, getDocumentFolderAssignment, getExternalLink, getInvolvedObject, getInvolvedObject, getInvolvedObject, 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

disableCrxObject, enableCrxObject, getAdditionalExternalLink, getAssignedTimer, getAttachedDocument, getDisabledReason, getDocumentFolderAssignment, getInvolvedObject, 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, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, 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, setOwner, setOwningUser

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

addLocalizedField, addLocalizedField, addLocalizedField, getLocalizedField, getLocalizedField, getLocalizedField

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

getLocalizedField

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

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

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

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

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.

addAssignedAccount

void addAssignedAccount(AccountAssignmentContract assignedAccount)

Adds the specified element to the set of the values for the reference assignedAccount using an implementation-specific, reassignable qualifier.

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

Parameters:

assignedAccount - The element to be appended.

getContractRole

List<Short> getContractRole()

Retrieves a list containing all the elements for the attribute contractRole.

Specified by:

getContractRole in interface AbstractContract

Returns:

A list containing all elements for this attribute.

setContractRole

void setContractRole(List<Short> contractRole)

Clears contractRole and adds the members of the given List.

This method is equivalent to

   list.clear();
   list.addAll(contractRole);
 

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the equivalent code.

Parameters:

contractRole - collection to be copied.

getContractType

ContractType getContractType()

Retrieves the value for the reference contractType.

Specified by:

getContractType in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setContractType

void setContractType(ContractType contractType)

Sets a new value for the reference contractType.

Specified by:

setContractType in interface AbstractContract

Parameters:

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

getGroupAssignment

<T extends ContractGroupAssignment> List<T> getGroupAssignment(ContractGroupAssignmentQuery query)

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

getGroupAssignment

ContractGroupAssignment getGroupAssignment(boolean idIsPersistent,
                                         String id)

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

getGroupAssignment

ContractGroupAssignment getGroupAssignment(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addGroupAssignment

void addGroupAssignment(boolean idIsPersistent,
                      String id,
                      ContractGroupAssignment groupAssignment)

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

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.

groupAssignment - The element to be appended.

addGroupAssignment

void addGroupAssignment(String id,
                      ContractGroupAssignment groupAssignment)

Adds the specified element to the set of the values for the reference groupAssignment 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.

groupAssignment - The element to be appended.

addGroupAssignment

void addGroupAssignment(ContractGroupAssignment groupAssignment)

Adds the specified element to the set of the values for the reference groupAssignment using an implementation-specific, reassignable qualifier.

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

Parameters:

groupAssignment - The element to be appended.

getLastAppliedCreator

ContractCreator getLastAppliedCreator()

Retrieves the value for the reference lastAppliedCreator.

Specified by:

getLastAppliedCreator in interface AbstractContract

Returns:

The – possibly null – value for this reference.

setLastAppliedCreator

void setLastAppliedCreator(ContractCreator lastAppliedCreator)

Sets a new value for the reference lastAppliedCreator.

Specified by:

setLastAppliedCreator in interface AbstractContract

Parameters:

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

addLinkTo

void addLinkTo(ContractLinkTo linkTo)

Adds the specified element to the set of the values for the reference linkTo using an implementation-specific, reassignable qualifier.

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

Parameters:

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

reapplyContractCreator

org.openmdx.base.jmi1.Void reapplyContractCreator(ReapplyContractCreatorParams in)