org.opencrx.kernel.contract1.jmi1
Interface Segment

All Superinterfaces:
Auditee, org.openmdx.base.cci2.ContextCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, SecureObject, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

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

Class Segment


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment
org.openmdx.base.cci2.Segment.Identity
 
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 addOwningGroup(int index, PrincipalGroup newValue)
          
 void addOwningGroup(PrincipalGroup newValue)
          
 void addQuote(Quote newValue)
          
 void addQuote(String id, Quote newValue)
          
 void addSalesOrder(SalesOrder newValue)
          
 void addSalesOrder(String id, SalesOrder newValue)
          
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
<T extends AuditEntry>
List<T>
getAudit(AuditEntryQuery query)
          Retrieves the value for the reference audit for the specified query.
<T extends CalculationRule>
List<T>
getCalculationRule(CalculationRuleQuery query)
          Retrieves the value for the reference calculationRule for the specified query.
<T extends org.openmdx.base.cci2.ExtentCapable>
List<T>
getExtent(org.openmdx.base.cci2.ExtentCapableQuery query)
          Retrieves the value for the reference extent for the specified query.
<T extends IndexEntry>
List<T>
getIndexEntry(IndexEntryQuery query)
          Retrieves the value for the reference indexEntry for the specified query.
<T extends Invoice>
List<T>
getInvoice(InvoiceQuery query)
          Retrieves the value for the reference invoice for the specified query.
<T extends Lead>
List<T>
getLead(LeadQuery query)
          Retrieves the value for the reference lead for the specified query.
<T extends Opportunity>
List<T>
getOpportunity(OpportunityQuery query)
          Retrieves the value for the reference opportunity for the specified query.
 User getOwningUser()
          Retrieves the value for the reference owningUser.
 org.openmdx.base.jdo2.Provider getProvider()
          Retrieves the value for the reference provider.
<T extends Quote>
List<T>
getQuote(QuoteQuery query)
          Retrieves the value for the reference quote for the specified query.
<T extends SalesOrder>
List<T>
getSalesOrder(SalesOrderQuery query)
          Retrieves the value for the reference salesOrder for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View>
List<T>
getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
          Retrieves the value for the reference view for the specified query.
 void removeCalculationRule(String id)
          
 void removeInvoice(String id)
          
 void removeLead(String id)
          
 void removeOpportunity(String id)
          
 void removeOwningGroup(int index)
          
 void removeOwningUser()
          Removes the value for the optional reference owningUser.
 void removeQuote(String id)
          
 void removeSalesOrder(String id)
          
 void setOwningUser(User owningUser)
          Sets a new value for the reference owningUser.
 
Methods inherited from interface org.opencrx.kernel.contract1.cci2.Segment
getCalculationRule, getInvoice, getLead, getOpportunity, getQuote, getSalesOrder
 
Methods inherited from interface org.openmdx.base.jmi1.Segment
setProvider, setProvider
 
Methods inherited from interface org.openmdx.base.cci2.Segment
getDescription, setDescription
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView
 
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.cci2.Auditee
getAudit
 
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
updateIndex
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed
getIndexEntry, updateIndex
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject
addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.XmlExporter
exportXml
 
Methods inherited from interface org.opencrx.kernel.base.cci2.XmlExporter
exportXml
 

Method Detail

getAudit

<T extends AuditEntry> List<T> getAudit(AuditEntryQuery query)
Retrieves the value for the reference audit for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getIndexEntry

<T extends IndexEntry> List<T> getIndexEntry(IndexEntryQuery query)
Retrieves the value for the reference indexEntry for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getAccessGrantedByParent

org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
Retrieves the value for the reference accessGrantedByParent.

Specified by:
getAccessGrantedByParent in interface SecureObject
Returns:
The – possibly null – value for this reference.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:
index - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:
newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)


getOwningUser

User getOwningUser()
Retrieves the value for the reference owningUser.

Specified by:
getOwningUser in interface SecureObject
Returns:
The – possibly null – value for this reference.

setOwningUser

void setOwningUser(User owningUser)
Sets a new value for the reference owningUser.

Specified by:
setOwningUser in interface SecureObject
Parameters:
owningUser - The non-null new value for this reference.

removeOwningUser

void removeOwningUser()
Removes the value for the optional reference owningUser.


getCalculationRule

<T extends CalculationRule> List<T> getCalculationRule(CalculationRuleQuery query)
Retrieves the value for the reference calculationRule for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addCalculationRule

void addCalculationRule(CalculationRule newValue)

Parameters:
newValue - The element to be appended.

removeCalculationRule

void removeCalculationRule(String id)


getInvoice

<T extends Invoice> List<T> getInvoice(InvoiceQuery query)
Retrieves the value for the reference invoice for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addInvoice

void addInvoice(Invoice newValue)

Parameters:
newValue - The element to be appended.

removeInvoice

void removeInvoice(String id)


getLead

<T extends Lead> List<T> getLead(LeadQuery query)
Retrieves the value for the reference lead for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addLead

void addLead(Lead newValue)

Parameters:
newValue - The element to be appended.

removeLead

void removeLead(String id)


getOpportunity

<T extends Opportunity> List<T> getOpportunity(OpportunityQuery query)
Retrieves the value for the reference opportunity for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addOpportunity

void addOpportunity(Opportunity newValue)

Parameters:
newValue - The element to be appended.

removeOpportunity

void removeOpportunity(String id)


getQuote

<T extends Quote> List<T> getQuote(QuoteQuery query)
Retrieves the value for the reference quote for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addQuote

void addQuote(Quote newValue)

Parameters:
newValue - The element to be appended.

removeQuote

void removeQuote(String id)


getSalesOrder

<T extends SalesOrder> List<T> getSalesOrder(SalesOrderQuery query)
Retrieves the value for the reference salesOrder for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

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.

addSalesOrder

void addSalesOrder(SalesOrder newValue)

Parameters:
newValue - The element to be appended.

removeSalesOrder

void removeSalesOrder(String id)


getExtent

<T extends org.openmdx.base.cci2.ExtentCapable> List<T> getExtent(org.openmdx.base.cci2.ExtentCapableQuery query)
Retrieves the value for the reference extent for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getProvider

org.openmdx.base.jdo2.Provider getProvider()
Retrieves the value for the reference provider.

Specified by:
getProvider in interface org.openmdx.base.cci2.Segment
Returns:
The non-null value for this reference.

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
Retrieves the value for the reference view for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.


This software is published under the BSD license. Copyright © 2003-2007, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.