Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.opencrx.kernel.contract1.jmi1
Interface Invoice

All Superinterfaces:
AbstractContract, AddressContainer, AlertSender, Assignable, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, DeliveryRequestContainer, DepotReferenceHolder, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, Invoice, RefBaseObject, RefFeatured, RefObject, SecureObject, ShippingDetail, SubscriptionTarget, TemplateEnabled, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter
public interface Invoice
extends Invoice, AbstractContract, CrxObject

Class Invoice

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.contract1.cci2.Invoice
Invoice.Identity
 
Method Summary
 void addActivity(Activity newValue)
          
 void addActivity(int index, Activity newValue)
          
 void addAdditionalExternalLink(AdditionalExternalLink newValue)
          
 void addAdditionalExternalLink(String id, AdditionalExternalLink newValue)
          
 void addAddress(ContractAddress newValue)
          
 void addAddress(String id, ContractAddress newValue)
          
 void addAttachedDocument(DocumentAttachment newValue)
          
 void addAttachedDocument(String id, DocumentAttachment newValue)
          
 void addCompetitor(Competitor newValue)
          
 void addCompetitor(int index, Competitor newValue)
          
 void addContact(Contact newValue)
          
 void addContact(int index, Contact newValue)
          
 void addDeliveryRequest(DeliveryRequest newValue)
          
 void addDeliveryRequest(String id, DeliveryRequest newValue)
          
 void addDepotReference(DepotReference newValue)
          
 void addDepotReference(String id, DepotReference newValue)
          
 void addMedia(Media newValue)
          
 void addMedia(String id, Media newValue)
          
 void addNote(Note newValue)
          
 void addNote(String id, Note newValue)
          
 void addOwningGroup(int index, PrincipalGroup newValue)
          
 void addOwningGroup(PrincipalGroup newValue)
          
 void addPosition(AbstractInvoicePosition newValue)
          
 void addPosition(String id, AbstractInvoicePosition newValue)
          
 void addPropertySet(PropertySet newValue)
          
 void addPropertySet(String id, PropertySet newValue)
          
 void addRating(Rating newValue)
          
 void addRating(String id, Rating newValue)
          
 void addReplacement(String id, TemplateReplacement newValue)
          
 void addReplacement(TemplateReplacement newValue)
          
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
<T extends AdditionalExternalLink>
List<T>
getAdditionalExternalLink(AdditionalExternalLinkQuery query)
          Retrieves the value for the reference additionalExternalLink for the specified query.
<T extends ContractAddress>
List<T>
getAddress(ContractAddressQuery query)
          Retrieves the value for the reference address for the specified query.
<T extends DocumentAttachment>
List<T>
getAttachedDocument(DocumentAttachmentQuery query)
          Retrieves the value for the reference attachedDocument for the specified query.
<T extends AuditEntry>
List<T>
getAudit(AuditEntryQuery query)
          Retrieves the value for the reference audit for the specified query.
 Account getBroker()
          Retrieves the value for the reference broker.
 CalculationRule getCalcRule()
          Retrieves the value for the reference calcRule.
 Account getCarrier()
          Retrieves the value for the reference carrier.
 Account getCustomer()
          Retrieves the value for the reference customer.
<T extends DeliveryRequest>
List<T>
getDeliveryRequest(DeliveryRequestQuery query)
          Retrieves the value for the reference deliveryRequest for the specified query.
<T extends DepotReference>
List<T>
getDepotReference(DepotReferenceQuery query)
          Retrieves the value for the reference depotReference 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 Media>
List<T>
getMedia(MediaQuery query)
          Retrieves the value for the reference media for the specified query.
<T extends Note>
List<T>
getNote(NoteQuery query)
          Retrieves the value for the reference note for the specified query.
 AbstractContract getOrigin()
          Retrieves the value for the reference origin.
 User getOwningUser()
          Retrieves the value for the reference owningUser.
<T extends AbstractInvoicePosition>
List<T>
getPosition(AbstractInvoicePositionQuery query)
          Retrieves the value for the reference position for the specified query.
<T extends PositionModification>
List<T>
getPositionModification(PositionModificationQuery query)
          Retrieves the value for the reference positionModification for the specified query.
 PricingRule getPricingRule()
          Retrieves the value for the reference pricingRule.
<T extends PropertySet>
List<T>
getPropertySet(PropertySetQuery query)
          Retrieves the value for the reference propertySet for the specified query.
<T extends PropertySetEntry>
List<T>
getPropertySetEntry(PropertySetEntryQuery query)
          Retrieves the value for the reference propertySetEntry for the specified query.
<T extends Rating>
List<T>
getRating(RatingQuery query)
          Retrieves the value for the reference rating for the specified query.
<T extends AbstractRemovedPosition>
List<T>
getRemovedPosition(AbstractRemovedPositionQuery query)
          Retrieves the value for the reference removedPosition for the specified query.
<T extends TemplateReplacement>
List<T>
getReplacement(TemplateReplacementQuery query)
          Retrieves the value for the reference replacement for the specified query.
 Account getSalesRep()
          Retrieves the value for the reference salesRep.
 Account getSupplier()
          Retrieves the value for the reference supplier.
<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.
<T extends org.openmdx.base.cci2.Void>
T
markAsClosed(InvoiceMarkAsClosedParams params)
           
 void removeActivity(int index)
          
 void removeAdditionalExternalLink(String id)
          
 void removeAddress(String id)
          
 void removeAttachedDocument(String id)
          
 void removeBroker()
          Removes the value for the optional reference broker.
 void removeCalcRule()
          Removes the value for the optional reference calcRule.
 void removeCompetitor(int index)
          
 void removeContact(int index)
          
 void removeCustomer()
          Removes the value for the optional reference customer.
 void removeDeliveryRequest(String id)
          
 void removeDepotReference(String id)
          
 void removeMedia(String id)
          
 void removeNote(String id)
          
 void removeOrigin()
          Removes the value for the optional reference origin.
 void removeOwningGroup(int index)
          
 void removeOwningUser()
          Removes the value for the optional reference owningUser.
 void removePosition(String id)
          
 void removePricingRule()
          Removes the value for the optional reference pricingRule.
 void removePropertySet(String id)
          
 void removeRating(String id)
          
 void removeReplacement(String id)
          
 void removeSalesRep()
          Removes the value for the optional reference salesRep.
 void removeSupplier()
          Removes the value for the optional reference supplier.
 void setBroker(Account broker)
          Sets a new value for the reference broker.
 void setCalcRule(CalculationRule calcRule)
          Sets a new value for the reference calcRule.
 void setCarrier(Account carrier)
          Sets a new value for the reference carrier.
 void setCustomer(Account customer)
          Sets a new value for the reference customer.
 void setOrigin(AbstractContract origin)
          Sets a new value for the reference origin.
 void setOwningUser(User owningUser)
          Sets a new value for the reference owningUser.
 void setPricingRule(PricingRule pricingRule)
          Sets a new value for the reference pricingRule.
 void setSalesRep(Account salesRep)
          Sets a new value for the reference salesRep.
 void setSegment(Segment segment)
          Sets a new value for the reference segment.
 void setSegment(Segment segment, boolean idIsPersistent, String id)
          Set the object's composite association org:opencrx:kernel:contract1:SegmentContainsInvoice.
 void setSupplier(Account supplier)
          Sets a new value for the reference supplier.
 
Methods inherited from interface org.opencrx.kernel.contract1.cci2.Invoice
getPosition, markAsClosed
 
Methods inherited from interface org.opencrx.kernel.contract1.jmi1.AbstractContract
createPosition, createProductOfferingPosition, removePendingInventoryBookings, reprice, updateInventory
 
Methods inherited from interface org.opencrx.kernel.contract1.cci2.AbstractContract
createPosition, createProductOfferingPosition, getActiveOn, getActivity, getCancelOn, getClosedOn, getCompetitor, getContact, getContractCurrency, getContractLanguage, getContractNumber, getContractState, getDescription, getExpiresOn, getInventoryCb, getName, getPaymentTerms, getPositionModification, getPricingDate, getPricingState, getPriority, getRemovedPosition, getTotalAmount, getTotalAmountIncludingTax, getTotalBaseAmount, getTotalDiscountAmount, getTotalSalesCommission, getTotalTaxAmount, removePendingInventoryBookings, reprice, setActiveOn, setCancelOn, setClosedOn, setContractCurrency, setContractLanguage, setContractNumber, setContractState, setDescription, setExpiresOn, setName, setPaymentTerms, setPricingDate, setPriority, updateInventory
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.Assignable
assignToMe
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Assignable
assignToMe
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.TemplateEnabled
applyReplacements, createObject, deleteObject
 
Methods inherited from interface org.opencrx.kernel.base.cci2.TemplateEnabled
applyReplacements, createObject, deleteObject, getReplacement, getTemplateReferenceFilter, isTemplate, setTemplate, setTemplateReferenceFilter
 
Methods inherited from interface org.opencrx.kernel.contract1.cci2.AddressContainer
getAddress
 
Methods inherited from interface org.opencrx.kernel.contract1.cci2.DeliveryRequestContainer
getDeliveryRequest
 
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.cci2.DepotReferenceHolder
getDepotReference
 
Methods inherited from interface org.opencrx.kernel.generic.jmi1.CrxObject
getCategory, getExternalLink, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4
 
Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject
getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, 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.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.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.SubscriptionTarget
addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SubscriptionTarget
addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.XmlExporter
exportXml
 
Methods inherited from interface org.opencrx.kernel.base.cci2.XmlExporter
exportXml
 
Methods inherited from interface org.openmdx.base.jmi1.BasicObject
getCreatedBy, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getModifiedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
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
 

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.

getReplacement

<T extends TemplateReplacement> List<T> getReplacement(TemplateReplacementQuery query)
Retrieves the value for the reference replacement 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.

addReplacement

void addReplacement(String id,
                    TemplateReplacement newValue)

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

addReplacement

void addReplacement(TemplateReplacement newValue)

Parameters:
newValue - The element to be appended.

removeReplacement

void removeReplacement(String id)

addActivity

void addActivity(int index,
                 Activity newValue)

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