org.opencrx.kernel.contract1.cci
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment, ViewCapable, XmlExporter

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

Method Summary

void	addCalculationRule(CalculationRule newValue)
void	addCalculationRule(String id, CalculationRule newValue)
void	addInvoice(Invoice newValue)
void	addInvoice(String id, Invoice newValue)
void	addLead(Lead newValue)
void	addLead(String id, Lead newValue)
void	addOpportunity(Opportunity newValue)
void	addOpportunity(String id, Opportunity newValue)
void	addQuote(Quote newValue)
void	addQuote(String id, Quote newValue)
void	addSalesOrder(SalesOrder newValue)
void	addSalesOrder(String id, SalesOrder newValue)
Collection	getCalculationRule() Retrieves a collection containing all the elements for the reference calculationRule.
List	getCalculationRule(CalculationRuleFilter filter) Retrieves the value for the reference calculationRule for the specified filter.
List	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.
Collection	getInvoice() Retrieves a collection containing all the elements for the reference invoice.
List	getInvoice(InvoiceFilter filter) Retrieves the value for the reference invoice for the specified filter.
List	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.
Collection	getLead() Retrieves a collection containing all the elements for the reference lead.
List	getLead(LeadFilter filter) Retrieves the value for the reference lead for the specified filter.
List	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.
Collection	getOpportunity() Retrieves a collection containing all the elements for the reference opportunity.
List	getOpportunity(OpportunityFilter filter) Retrieves the value for the reference opportunity for the specified filter.
List	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.
Collection	getQuote() Retrieves a collection containing all the elements for the reference quote.
List	getQuote(QuoteFilter filter) Retrieves the value for the reference quote for the specified filter.
List	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.
Collection	getSalesOrder() Retrieves a collection containing all the elements for the reference salesOrder.
List	getSalesOrder(SalesOrderFilter filter) Retrieves the value for the reference salesOrder for the specified filter.
List	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.
void	removeCalculationRule(String id)
void	removeInvoice(String id)
void	removeLead(String id)
void	removeOpportunity(String id)
void	removeQuote(String id)
void	removeSalesOrder(String id)

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

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

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

getContext, getContext

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

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

getAudit, getAudit, getAudit, getAudit

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

exportXml, exportXml

Method Detail

getCalculationRule

CalculationRule getCalculationRule(String id)

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

getCalculationRule

Collection getCalculationRule()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getCalculationRule

List getCalculationRule(CalculationRuleFilter filter)

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

getCalculationRule

List getCalculationRule(CalculationRuleQuery query)

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

addCalculationRule

void addCalculationRule(String id,
                        CalculationRule newValue)

Parameters:

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

addCalculationRule

void addCalculationRule(CalculationRule newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeCalculationRule

void removeCalculationRule(String id)

Throws:

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

getInvoice

Invoice getInvoice(String id)

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

getInvoice

Collection getInvoice()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getInvoice

List getInvoice(InvoiceFilter filter)

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

getInvoice

List getInvoice(InvoiceQuery query)

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

addInvoice

void addInvoice(String id,
                Invoice newValue)

Parameters:

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

addInvoice

void addInvoice(Invoice newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeInvoice

void removeInvoice(String id)

Throws:

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

getLead

Lead getLead(String id)

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

getLead

Collection getLead()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getLead

List getLead(LeadFilter filter)

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

getLead

List getLead(LeadQuery query)

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

addLead

void addLead(String id,
             Lead newValue)

Parameters:

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

addLead

void addLead(Lead newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeLead

void removeLead(String id)

Throws:

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

getOpportunity

Opportunity getOpportunity(String id)

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

getOpportunity

Collection getOpportunity()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getOpportunity

List getOpportunity(OpportunityFilter filter)

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

getOpportunity

List getOpportunity(OpportunityQuery query)

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

addOpportunity

void addOpportunity(String id,
                    Opportunity newValue)

Parameters:

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

addOpportunity

void addOpportunity(Opportunity newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeOpportunity

void removeOpportunity(String id)

Throws:

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

getQuote

Quote getQuote(String id)

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

getQuote

Collection getQuote()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getQuote

List getQuote(QuoteFilter filter)

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

getQuote

List getQuote(QuoteQuery query)

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

addQuote

void addQuote(String id,
              Quote newValue)

Parameters:

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

addQuote

void addQuote(Quote newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeQuote

void removeQuote(String id)

Throws:

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

getSalesOrder

SalesOrder getSalesOrder(String id)

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

getSalesOrder

Collection getSalesOrder()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getSalesOrder

List getSalesOrder(SalesOrderFilter filter)

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

getSalesOrder

List getSalesOrder(SalesOrderQuery query)

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

addSalesOrder

void addSalesOrder(String id,
                   SalesOrder newValue)

Parameters:

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

addSalesOrder

void addSalesOrder(SalesOrder newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeSalesOrder

void removeSalesOrder(String id)

Throws:

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