org.opencrx.kernel.contract1.jmi1
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Exporter, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment

public interface Segment
extends Segment, Segment, Auditee, Exporter, Importer, Indexed, SecureObject

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

Segment.Identity

Method Summary

void	addCalculationRule(boolean idIsPersistent, String id, CalculationRule calculationRule) Adds the specified element to the set of the values for the reference calculationRule.
void	addCalculationRule(String id, CalculationRule calculationRule) Adds the specified element to the set of the values for the reference calculationRule using a reassignable qualifier.
void	addContractFilter(boolean idIsPersistent, String id, ContractFilterGlobal contractFilter) Adds the specified element to the set of the values for the reference contractFilter.
void	addContractFilter(String id, ContractFilterGlobal contractFilter) Adds the specified element to the set of the values for the reference contractFilter using a reassignable qualifier.
void	addInvoice(boolean idIsPersistent, String id, Invoice invoice) Adds the specified element to the set of the values for the reference invoice.
void	addInvoice(String id, Invoice invoice) Adds the specified element to the set of the values for the reference invoice using a reassignable qualifier.
void	addLead(boolean idIsPersistent, String id, Lead lead) Adds the specified element to the set of the values for the reference lead.
void	addLead(String id, Lead lead) Adds the specified element to the set of the values for the reference lead using a reassignable qualifier.
void	addOpportunity(boolean idIsPersistent, String id, Opportunity opportunity) Adds the specified element to the set of the values for the reference opportunity.
void	addOpportunity(String id, Opportunity opportunity) Adds the specified element to the set of the values for the reference opportunity using a reassignable qualifier.
void	addQuote(boolean idIsPersistent, String id, Quote quote) Adds the specified element to the set of the values for the reference quote.
void	addQuote(String id, Quote quote) Adds the specified element to the set of the values for the reference quote using a reassignable qualifier.
void	addSalesOrder(boolean idIsPersistent, String id, SalesOrder salesOrder) Adds the specified element to the set of the values for the reference salesOrder.
void	addSalesOrder(String id, SalesOrder salesOrder) Adds the specified element to the set of the values for the reference salesOrder using a reassignable qualifier.
CalculationRule	getCalculationRule(boolean idIsPersistent, String id) Retrieves the value for the reference calculationRule for the specified qualifier attribute value.
<T extends CalculationRule> List<T>	getCalculationRule(CalculationRuleQuery query) Retrieves the value for the reference calculationRule for the specified query.
CalculationRule	getCalculationRule(String id) Retrieves the value for the reference calculationRule for the specified qualifier attribute value.
ContractFilterGlobal	getContractFilter(boolean idIsPersistent, String id) Retrieves the value for the reference contractFilter for the specified qualifier attribute value.
<T extends ContractFilterGlobal> List<T>	getContractFilter(ContractFilterGlobalQuery query) Retrieves the value for the reference contractFilter for the specified query.
ContractFilterGlobal	getContractFilter(String id) Retrieves the value for the reference contractFilter for the specified qualifier attribute value.
ContractRole	getContractRole(boolean idIsPersistent, String id) Retrieves the value for the reference contractRole for the specified qualifier attribute value.
<T extends ContractRole> List<T>	getContractRole(ContractRoleQuery query) Retrieves the value for the reference contractRole for the specified query.
ContractRole	getContractRole(String id) Retrieves the value for the reference contractRole for the specified qualifier attribute value.
Invoice	getInvoice(boolean idIsPersistent, String id) Retrieves the value for the reference invoice for the specified qualifier attribute value.
<T extends Invoice> List<T>	getInvoice(InvoiceQuery query) Retrieves the value for the reference invoice for the specified query.
Invoice	getInvoice(String id) Retrieves the value for the reference invoice for the specified qualifier attribute value.
Lead	getLead(boolean idIsPersistent, String id) Retrieves the value for the reference lead for the specified qualifier attribute value.
<T extends Lead> List<T>	getLead(LeadQuery query) Retrieves the value for the reference lead for the specified query.
Lead	getLead(String id) Retrieves the value for the reference lead for the specified qualifier attribute value.
Opportunity	getOpportunity(boolean idIsPersistent, String id) Retrieves the value for the reference opportunity for the specified qualifier attribute value.
<T extends Opportunity> List<T>	getOpportunity(OpportunityQuery query) Retrieves the value for the reference opportunity for the specified query.
Opportunity	getOpportunity(String id) Retrieves the value for the reference opportunity for the specified qualifier attribute value.
Quote	getQuote(boolean idIsPersistent, String id) Retrieves the value for the reference quote for the specified qualifier attribute value.
<T extends Quote> List<T>	getQuote(QuoteQuery query) Retrieves the value for the reference quote for the specified query.
Quote	getQuote(String id) Retrieves the value for the reference quote for the specified qualifier attribute value.
SalesOrder	getSalesOrder(boolean idIsPersistent, String id) Retrieves the value for the reference salesOrder for the specified qualifier attribute value.
<T extends SalesOrder> List<T>	getSalesOrder(SalesOrderQuery query) Retrieves the value for the reference salesOrder for the specified query.
SalesOrder	getSalesOrder(String id) Retrieves the value for the reference salesOrder for the specified qualifier attribute value.

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

getCalculationRule, getContractFilter, getContractRole, getInvoice, getLead, getOpportunity, getQuote, getSalesOrder

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

getExtent, getExtent, getExtent, getProvider

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

getDescription, getExtent, setDescription

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

getContext

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

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

Method Detail

getCalculationRule

<T extends CalculationRule> List<T> getCalculationRule(CalculationRuleQuery query)

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

getCalculationRule

CalculationRule getCalculationRule(boolean idIsPersistent,
                                   String id)

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

getCalculationRule

CalculationRule getCalculationRule(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addCalculationRule

void addCalculationRule(boolean idIsPersistent,
                        String id,
                        CalculationRule calculationRule)

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

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.

calculationRule - The element to be appended.

addCalculationRule

void addCalculationRule(String id,
                        CalculationRule calculationRule)

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

calculationRule - The element to be appended.

getContractFilter

<T extends ContractFilterGlobal> List<T> getContractFilter(ContractFilterGlobalQuery query)

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

getContractFilter

ContractFilterGlobal getContractFilter(boolean idIsPersistent,
                                       String id)

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

getContractFilter

ContractFilterGlobal getContractFilter(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addContractFilter

void addContractFilter(boolean idIsPersistent,
                       String id,
                       ContractFilterGlobal contractFilter)

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

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.

contractFilter - The element to be appended.

addContractFilter

void addContractFilter(String id,
                       ContractFilterGlobal contractFilter)

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

contractFilter - The element to be appended.

getContractRole

<T extends ContractRole> List<T> getContractRole(ContractRoleQuery query)

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

getContractRole

ContractRole getContractRole(boolean idIsPersistent,
                             String id)

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

getContractRole

ContractRole getContractRole(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

getInvoice

<T extends Invoice> List<T> getInvoice(InvoiceQuery query)

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

getInvoice

Invoice getInvoice(boolean idIsPersistent,
                   String id)

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

getInvoice

Invoice getInvoice(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addInvoice

void addInvoice(boolean idIsPersistent,
                String id,
                Invoice invoice)

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

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.

invoice - The element to be appended.

addInvoice

void addInvoice(String id,
                Invoice invoice)

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

invoice - The element to be appended.

getLead

<T extends Lead> List<T> getLead(LeadQuery query)

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

getLead

Lead getLead(boolean idIsPersistent,
             String id)

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

getLead

Lead getLead(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addLead

void addLead(boolean idIsPersistent,
             String id,
             Lead lead)

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

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.

lead - The element to be appended.

addLead

void addLead(String id,
             Lead lead)

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

lead - The element to be appended.

getOpportunity

<T extends Opportunity> List<T> getOpportunity(OpportunityQuery query)

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

getOpportunity

Opportunity getOpportunity(boolean idIsPersistent,
                           String id)

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

getOpportunity

Opportunity getOpportunity(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addOpportunity

void addOpportunity(boolean idIsPersistent,
                    String id,
                    Opportunity opportunity)

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

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.

opportunity - The element to be appended.

addOpportunity

void addOpportunity(String id,
                    Opportunity opportunity)

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

opportunity - The element to be appended.

getQuote

<T extends Quote> List<T> getQuote(QuoteQuery query)

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

getQuote

Quote getQuote(boolean idIsPersistent,
               String id)

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

getQuote

Quote getQuote(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addQuote

void addQuote(boolean idIsPersistent,
              String id,
              Quote quote)

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

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.

quote - The element to be appended.

addQuote

void addQuote(String id,
              Quote quote)

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

quote - The element to be appended.

getSalesOrder

<T extends SalesOrder> List<T> getSalesOrder(SalesOrderQuery query)

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

getSalesOrder

SalesOrder getSalesOrder(boolean idIsPersistent,
                         String id)

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

getSalesOrder

SalesOrder getSalesOrder(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addSalesOrder

void addSalesOrder(boolean idIsPersistent,
                   String id,
                   SalesOrder salesOrder)

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

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.

salesOrder - The element to be appended.

addSalesOrder

void addSalesOrder(String id,
                   SalesOrder salesOrder)

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

salesOrder - The element to be appended.