org.opencrx.kernel.product1.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 addConfigurationTypeSet(boolean idIsPersistent, String id, ProductConfigurationTypeSet configurationTypeSet)
          Adds the specified element to the set of the values for the reference configurationTypeSet.
 void addConfigurationTypeSet(String id, ProductConfigurationTypeSet configurationTypeSet)
          Adds the specified element to the set of the values for the reference configurationTypeSet using a reassignable qualifier.
 void addPriceLevel(boolean idIsPersistent, String id, AbstractPriceLevel priceLevel)
          Adds the specified element to the set of the values for the reference priceLevel.
 void addPriceLevel(String id, AbstractPriceLevel priceLevel)
          Adds the specified element to the set of the values for the reference priceLevel using a reassignable qualifier.
 void addPricingRule(boolean idIsPersistent, String id, PricingRule pricingRule)
          Adds the specified element to the set of the values for the reference pricingRule.
 void addPricingRule(String id, PricingRule pricingRule)
          Adds the specified element to the set of the values for the reference pricingRule using a reassignable qualifier.
 void addProduct(boolean idIsPersistent, String id, Product product)
          Adds the specified element to the set of the values for the reference product.
 void addProduct(String id, Product product)
          Adds the specified element to the set of the values for the reference product using a reassignable qualifier.
 void addProductClassification(boolean idIsPersistent, String id, ProductClassification productClassification)
          Adds the specified element to the set of the values for the reference productClassification.
 void addProductClassification(String id, ProductClassification productClassification)
          Adds the specified element to the set of the values for the reference productClassification using a reassignable qualifier.
 void addProductFilter(boolean idIsPersistent, String id, ProductFilterGlobal productFilter)
          Adds the specified element to the set of the values for the reference productFilter.
 void addProductFilter(String id, ProductFilterGlobal productFilter)
          Adds the specified element to the set of the values for the reference productFilter using a reassignable qualifier.
 void addSalesTaxType(boolean idIsPersistent, String id, SalesTaxType salesTaxType)
          Adds the specified element to the set of the values for the reference salesTaxType.
 void addSalesTaxType(String id, SalesTaxType salesTaxType)
          Adds the specified element to the set of the values for the reference salesTaxType using a reassignable qualifier.
 ProductConfigurationTypeSet getConfigurationTypeSet(boolean idIsPersistent, String id)
          Retrieves the value for the reference configurationTypeSet for the specified qualifier attribute value.
<T extends ProductConfigurationTypeSet>
List<T>
getConfigurationTypeSet(ProductConfigurationTypeSetQuery query)
          Retrieves the value for the reference configurationTypeSet for the specified query.
 ProductConfigurationTypeSet getConfigurationTypeSet(String id)
          Retrieves the value for the reference configurationTypeSet for the specified qualifier attribute value.
<T extends AbstractPriceLevel>
List<T>
getPriceLevel(AbstractPriceLevelQuery query)
          Retrieves the value for the reference priceLevel for the specified query.
 AbstractPriceLevel getPriceLevel(boolean idIsPersistent, String id)
          Retrieves the value for the reference priceLevel for the specified qualifier attribute value.
 AbstractPriceLevel getPriceLevel(String id)
          Retrieves the value for the reference priceLevel for the specified qualifier attribute value.
 PriceListEntry getPriceListEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference priceListEntry for the specified qualifier attribute value.
<T extends PriceListEntry>
List<T>
getPriceListEntry(PriceListEntryQuery query)
          Retrieves the value for the reference priceListEntry for the specified query.
 PriceListEntry getPriceListEntry(String id)
          Retrieves the value for the reference priceListEntry for the specified qualifier attribute value.
 PricingRule getPricingRule(boolean idIsPersistent, String id)
          Retrieves the value for the reference pricingRule for the specified qualifier attribute value.
<T extends PricingRule>
List<T>
getPricingRule(PricingRuleQuery query)
          Retrieves the value for the reference pricingRule for the specified query.
 PricingRule getPricingRule(String id)
          Retrieves the value for the reference pricingRule for the specified qualifier attribute value.
 Product getProduct(boolean idIsPersistent, String id)
          Retrieves the value for the reference product for the specified qualifier attribute value.
<T extends Product>
List<T>
getProduct(ProductQuery query)
          Retrieves the value for the reference product for the specified query.
 Product getProduct(String id)
          Retrieves the value for the reference product for the specified qualifier attribute value.
 ProductClassification getProductClassification(boolean idIsPersistent, String id)
          Retrieves the value for the reference productClassification for the specified qualifier attribute value.
<T extends ProductClassification>
List<T>
getProductClassification(ProductClassificationQuery query)
          Retrieves the value for the reference productClassification for the specified query.
 ProductClassification getProductClassification(String id)
          Retrieves the value for the reference productClassification for the specified qualifier attribute value.
 ProductFilterGlobal getProductFilter(boolean idIsPersistent, String id)
          Retrieves the value for the reference productFilter for the specified qualifier attribute value.
<T extends ProductFilterGlobal>
List<T>
getProductFilter(ProductFilterGlobalQuery query)
          Retrieves the value for the reference productFilter for the specified query.
 ProductFilterGlobal getProductFilter(String id)
          Retrieves the value for the reference productFilter for the specified qualifier attribute value.
 SalesTaxType getSalesTaxType(boolean idIsPersistent, String id)
          Retrieves the value for the reference salesTaxType for the specified qualifier attribute value.
<T extends SalesTaxType>
List<T>
getSalesTaxType(SalesTaxTypeQuery query)
          Retrieves the value for the reference salesTaxType for the specified query.
 SalesTaxType getSalesTaxType(String id)
          Retrieves the value for the reference salesTaxType for the specified qualifier attribute value.
 
Methods inherited from interface org.opencrx.kernel.product1.cci2.Segment
getConfigurationTypeSet, getPriceLevel, getPriceListEntry, getPricingRule, getProduct, getProductClassification, getProductFilter, getSalesTaxType
 
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, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, 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

getConfigurationTypeSet

<T extends ProductConfigurationTypeSet> List<T> getConfigurationTypeSet(ProductConfigurationTypeSetQuery query)
Retrieves the value for the reference configurationTypeSet 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.

getConfigurationTypeSet

ProductConfigurationTypeSet getConfigurationTypeSet(boolean idIsPersistent,
                                                    String id)
Retrieves the value for the reference configurationTypeSet 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

getConfigurationTypeSet

ProductConfigurationTypeSet getConfigurationTypeSet(String id)
Retrieves the value for the reference configurationTypeSet for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addConfigurationTypeSet

void addConfigurationTypeSet(boolean idIsPersistent,
                             String id,
                             ProductConfigurationTypeSet configurationTypeSet)
Adds the specified element to the set of the values for the reference configurationTypeSet.

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.
configurationTypeSet - The element to be appended.

addConfigurationTypeSet

void addConfigurationTypeSet(String id,
                             ProductConfigurationTypeSet configurationTypeSet)
Adds the specified element to the set of the values for the reference configurationTypeSet 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.
configurationTypeSet - The element to be appended.

getPriceLevel

<T extends AbstractPriceLevel> List<T> getPriceLevel(AbstractPriceLevelQuery query)
Retrieves the value for the reference priceLevel 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.

getPriceLevel

AbstractPriceLevel getPriceLevel(boolean idIsPersistent,
                                 String id)
Retrieves the value for the reference priceLevel 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

getPriceLevel

AbstractPriceLevel getPriceLevel(String id)
Retrieves the value for the reference priceLevel for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addPriceLevel

void addPriceLevel(boolean idIsPersistent,
                   String id,
                   AbstractPriceLevel priceLevel)
Adds the specified element to the set of the values for the reference priceLevel.

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.
priceLevel - The element to be appended.

addPriceLevel

void addPriceLevel(String id,
                   AbstractPriceLevel priceLevel)
Adds the specified element to the set of the values for the reference priceLevel 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.
priceLevel - The element to be appended.

getPriceListEntry

<T extends PriceListEntry> List<T> getPriceListEntry(PriceListEntryQuery query)
Retrieves the value for the reference priceListEntry 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.

getPriceListEntry

PriceListEntry getPriceListEntry(boolean idIsPersistent,
                                 String id)
Retrieves the value for the reference priceListEntry 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

getPriceListEntry

PriceListEntry getPriceListEntry(String id)
Retrieves the value for the reference priceListEntry for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getPricingRule

<T extends PricingRule> List<T> getPricingRule(PricingRuleQuery query)
Retrieves the value for the reference pricingRule 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.

getPricingRule

PricingRule getPricingRule(boolean idIsPersistent,
                           String id)
Retrieves the value for the reference pricingRule 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

getPricingRule

PricingRule getPricingRule(String id)
Retrieves the value for the reference pricingRule for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addPricingRule

void addPricingRule(boolean idIsPersistent,
                    String id,
                    PricingRule pricingRule)
Adds the specified element to the set of the values for the reference pricingRule.

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.
pricingRule - The element to be appended.

addPricingRule

void addPricingRule(String id,
                    PricingRule pricingRule)
Adds the specified element to the set of the values for the reference pricingRule 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.
pricingRule - The element to be appended.

getProduct

<T extends Product> List<T> getProduct(ProductQuery query)
Retrieves the value for the reference product 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.

getProduct

Product getProduct(boolean idIsPersistent,
                   String id)
Retrieves the value for the reference product 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

getProduct

Product getProduct(String id)
Retrieves the value for the reference product for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addProduct

void addProduct(boolean idIsPersistent,
                String id,
                Product product)
Adds the specified element to the set of the values for the reference product.

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.
product - The element to be appended.

addProduct

void addProduct(String id,
                Product product)
Adds the specified element to the set of the values for the reference product 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.
product - The element to be appended.

getProductClassification

<T extends ProductClassification> List<T> getProductClassification(ProductClassificationQuery query)
Retrieves the value for the reference productClassification 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.

getProductClassification

ProductClassification getProductClassification(boolean idIsPersistent,
                                               String id)
Retrieves the value for the reference productClassification 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

getProductClassification

ProductClassification getProductClassification(String id)
Retrieves the value for the reference productClassification for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addProductClassification

void addProductClassification(boolean idIsPersistent,
                              String id,
                              ProductClassification productClassification)
Adds the specified element to the set of the values for the reference productClassification.

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.
productClassification - The element to be appended.

addProductClassification

void addProductClassification(String id,
                              ProductClassification productClassification)
Adds the specified element to the set of the values for the reference productClassification 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.
productClassification - The element to be appended.

getProductFilter

<T extends ProductFilterGlobal> List<T> getProductFilter(ProductFilterGlobalQuery query)
Retrieves the value for the reference productFilter 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.

getProductFilter

ProductFilterGlobal getProductFilter(boolean idIsPersistent,
                                     String id)
Retrieves the value for the reference productFilter 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

getProductFilter

ProductFilterGlobal getProductFilter(String id)
Retrieves the value for the reference productFilter for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addProductFilter

void addProductFilter(boolean idIsPersistent,
                      String id,
                      ProductFilterGlobal productFilter)
Adds the specified element to the set of the values for the reference productFilter.

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.
productFilter - The element to be appended.

addProductFilter

void addProductFilter(String id,
                      ProductFilterGlobal productFilter)
Adds the specified element to the set of the values for the reference productFilter 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.
productFilter - The element to be appended.

getSalesTaxType

<T extends SalesTaxType> List<T> getSalesTaxType(SalesTaxTypeQuery query)
Retrieves the value for the reference salesTaxType 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.

getSalesTaxType

SalesTaxType getSalesTaxType(boolean idIsPersistent,
                             String id)
Retrieves the value for the reference salesTaxType 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

getSalesTaxType

SalesTaxType getSalesTaxType(String id)
Retrieves the value for the reference salesTaxType for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addSalesTaxType

void addSalesTaxType(boolean idIsPersistent,
                     String id,
                     SalesTaxType salesTaxType)
Adds the specified element to the set of the values for the reference salesTaxType.

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.
salesTaxType - The element to be appended.

addSalesTaxType

void addSalesTaxType(String id,
                     SalesTaxType salesTaxType)
Adds the specified element to the set of the values for the reference salesTaxType 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.
salesTaxType - The element to be appended.


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