org.opencrx.kernel.contract1.jdo2
Class Invoice

java.lang.Object
  extended by org.oasisopen.jdo2.Identifiable
      extended by org.w3c.jdo2.AbstractObject
          extended by org.opencrx.kernel.contract1.jdo2.Invoice
All Implemented Interfaces:
Serializable, AlertSender, Assignable, Auditee, Cloneable, Importer, Indexed, SecureObject, XmlExporter, AbstractContract, AddressContainer, DeliveryRequestContainer, Invoice, ShippingDetail, DepotReferenceHolder, CrxObject, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class Invoice
extends org.w3c.jdo2.AbstractObject
implements Invoice

Class Invoice

See Also:
Serialized Form

Nested Class Summary
static class Invoice.Identity
          The object's application identity
static class Invoice.Slice
          Slice object hold the Invoice's multivalued attributes
 
Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject
org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>
 
Field Summary
static List<String> BASE_CLASS
          Define this class as base class
static List<String> CLASS
          Define the model class org::opencrx::kernel::contract1::Invoice
 
Constructor Summary
Invoice()
           
 
Method Summary
 void addAdditionalExternalLink(boolean idIsPersistent, String id, AdditionalExternalLink additionalExternalLink)
          Adds the specified element to the set of the values for the reference additionalExternalLink.
 void addAddress(boolean idIsPersistent, String id, ContractAddress address)
          Adds the specified element to the set of the values for the reference address.
 void addAttachedDocument(boolean idIsPersistent, String id, DocumentAttachment attachedDocument)
          Adds the specified element to the set of the values for the reference attachedDocument.
 void addDeliveryRequest(boolean idIsPersistent, String id, DeliveryRequest deliveryRequest)
          Adds the specified element to the set of the values for the reference deliveryRequest.
 void addDepotReference(boolean idIsPersistent, String id, DepotReference depotReference)
          Adds the specified element to the set of the values for the reference depotReference.
 void addMedia(boolean idIsPersistent, String id, Media media)
          Adds the specified element to the set of the values for the reference media.
 void addNote(boolean idIsPersistent, String id, Note note)
          Adds the specified element to the set of the values for the reference note.
 ModifySecureObjectResult addOwningGroup(PrincipalGroup group, short mode)
           
 void addPosition(boolean idIsPersistent, String id, AbstractInvoicePosition position)
          Adds the specified element to the set of the values for the reference position.
 void addPropertySet(boolean idIsPersistent, String id, PropertySet propertySet)
          Adds the specified element to the set of the values for the reference propertySet.
 void addRating(boolean idIsPersistent, String id, Rating rating)
          Adds the specified element to the set of the values for the reference rating.
 void addToSegment(Segment segment)
          Sets a new value for the reference segment.
 void addToSegment(Segment segment, boolean idIsPersistent, String id)
          Set the object's composite association org:opencrx:kernel:contract1:SegmentContainsInvoice.
 org.openmdx.base.cci2.Void assignToMe()
           
 CheckPermissionsResult checkPermissions(String principalName)
           
 CloneResult clone_(String referenceFilter)
           
 CreatePositionResult createPosition(String name, Uom priceUom, Date pricingDate, PricingRule pricingRule, Product product, BigDecimal quantity, Uom uom)
           
 ExportResult exportXml(String attributeFilter, String referenceFilter)
           
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
 short getAccessLevelBrowse()
          Retrieves the value for the attribute accessLevelBrowse.
 short getAccessLevelDelete()
          Retrieves the value for the attribute accessLevelDelete.
 short getAccessLevelUpdate()
          Retrieves the value for the attribute accessLevelUpdate.
 Date getActiveOn()
          Retrieves the possibly null value for the optional attribute activeOn.
<T extends Activity>
List<T>
getActivity()
          Retrieves the Collection of objects referenced by activity.
<T extends AdditionalExternalLink>
Collection<T>
getAdditionalExternalLink()
          Retrieves a set containing all the elements for the reference additionalExternalLink.
 AdditionalExternalLink getAdditionalExternalLink(boolean idIsPersistent, String id)
          Retrieves the value for the reference additionalExternalLink for the specified qualifier attribute value.
<T extends ContractAddress>
Collection<T>
getAddress()
          Retrieves a set containing all the elements for the reference address.
 ContractAddress getAddress(boolean idIsPersistent, String id)
          Retrieves the value for the reference address for the specified qualifier attribute value.
<T extends DocumentAttachment>
Collection<T>
getAttachedDocument()
          Retrieves a set containing all the elements for the reference attachedDocument.
 DocumentAttachment getAttachedDocument(boolean idIsPersistent, String id)
          Retrieves the value for the reference attachedDocument for the specified qualifier attribute value.
<T extends AuditEntry>
Collection<T>
getAudit()
          Retrieves a set containing all the elements for the reference audit.
 AuditEntry getAudit(boolean idIsPersistent, String id)
          Retrieves the value for the reference audit for the specified qualifier attribute value.
 Account getBroker()
          Retrieves the value for the reference broker.
 CalculationRule getCalcRule()
          Retrieves the value for the reference calcRule.
 Date getCancelOn()
          Retrieves the possibly null value for the optional attribute cancelOn.
 Account getCarrier()
          Retrieves the value for the reference carrier.
 List<String> getCategory()
          Retrieves a list containing all the elements for the attribute category.
 Date getClosedOn()
          Retrieves the possibly null value for the optional attribute closedOn.
<T extends Competitor>
List<T>
getCompetitor()
          Retrieves the Collection of objects referenced by competitor.
<T extends Account>
List<T>
getContact()
          Retrieves the Collection of objects referenced by contact.
 short getContractCurrency()
          Retrieves the value for the attribute contractCurrency.
 short getContractLanguage()
          Retrieves the value for the attribute contractLanguage.
 String getContractNumber()
          Retrieves the possibly null value for the optional attribute contractNumber.
 short getContractState()
          Retrieves the value for the attribute contractState.
 Date getCreatedAt()
          Retrieves the value for the attribute createdAt.
 Set<String> getCreatedBy()
          Retrieves a set containing all the elements for the attribute createdBy.
 Account getCustomer()
          Retrieves the value for the reference customer.
<T extends DeliveryRequest>
Collection<T>
getDeliveryRequest()
          Retrieves a set containing all the elements for the reference deliveryRequest.
 DeliveryRequest getDeliveryRequest(boolean idIsPersistent, String id)
          Retrieves the value for the reference deliveryRequest for the specified qualifier attribute value.
<T extends DepotReference>
Collection<T>
getDepotReference()
          Retrieves a set containing all the elements for the reference depotReference.
 DepotReference getDepotReference(boolean idIsPersistent, String id)
          Retrieves the value for the reference depotReference for the specified qualifier attribute value.
 String getDescription()
          Retrieves the possibly null value for the optional attribute description.
 String getDisabledReason()
          Retrieves the possibly null value for the optional attribute disabledReason.
 Date getExpiresOn()
          Retrieves the possibly null value for the optional attribute expiresOn.
 List<String> getExternalLink()
          Retrieves a list containing all the elements for the attribute externalLink.
 String getGiftMessage()
          Retrieves the possibly null value for the optional attribute giftMessage.
 String getIdentity()
          Retrieves the value for the attribute identity.
<T extends IndexEntry>
Collection<T>
getIndexEntry()
          Retrieves a set containing all the elements for the reference indexEntry.
 IndexEntry getIndexEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
<T extends CompoundBooking>
List<T>
getInventoryCb()
          Retrieves the Collection of objects referenced by inventoryCb.
<T extends Media>
Collection<T>
getMedia()
          Retrieves a set containing all the elements for the reference media.
 Media getMedia(boolean idIsPersistent, String id)
          Retrieves the value for the reference media for the specified qualifier attribute value.
 Date getModifiedAt()
          Retrieves the value for the attribute modifiedAt.
 Set<String> getModifiedBy()
          Retrieves a set containing all the elements for the attribute modifiedBy.
 String getName()
          Retrieves the value for the attribute name.
<T extends Note>
Collection<T>
getNote()
          Retrieves a set containing all the elements for the reference note.
 Note getNote(boolean idIsPersistent, String id)
          Retrieves the value for the reference note for the specified qualifier attribute value.
 AbstractContract getOrigin()
          Retrieves the value for the reference origin.
 List<String> getOwner()
          Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup>
List<T>
getOwningGroup()
          Retrieves the Collection of objects referenced by owningGroup.
 User getOwningUser()
          Retrieves the value for the reference owningUser.
 short getPaymentTerms()
          Retrieves the value for the attribute paymentTerms.
<T extends AbstractInvoicePosition>
Collection<T>
getPosition()
          Retrieves a set containing all the elements for the reference position.
 AbstractInvoicePosition getPosition(boolean idIsPersistent, String id)
          Retrieves the value for the reference position for the specified qualifier attribute value.
<T extends PositionModification>
Collection<T>
getPositionModification()
          Retrieves a set containing all the elements for the reference positionModification.
 PositionModification getPositionModification(boolean idIsPersistent, String id)
          Retrieves the value for the reference positionModification for the specified qualifier attribute value.
 Date getPricingDate()
          Retrieves the possibly null value for the optional attribute pricingDate.
 PricingRule getPricingRule()
          Retrieves the value for the reference pricingRule.
 short getPricingState()
          Retrieves the value for the attribute pricingState.
 short getPriority()
          Retrieves the value for the attribute priority.
<T extends PropertySet>
Collection<T>
getPropertySet()
          Retrieves a set containing all the elements for the reference propertySet.
 PropertySet getPropertySet(boolean idIsPersistent, String id)
          Retrieves the value for the reference propertySet for the specified qualifier attribute value.
<T extends PropertySetEntry>
Collection<T>
getPropertySetEntry()
          Retrieves a set containing all the elements for the reference propertySetEntry.
 PropertySetEntry getPropertySetEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference propertySetEntry for the specified qualifier attribute value.
<T extends Rating>
Collection<T>
getRating()
          Retrieves a set containing all the elements for the reference rating.
 Rating getRating(boolean idIsPersistent, String id)
          Retrieves the value for the reference rating for the specified qualifier attribute value.
<T extends AbstractRemovedPosition>
Collection<T>
getRemovedPosition()
          Retrieves a set containing all the elements for the reference removedPosition.
 AbstractRemovedPosition getRemovedPosition(boolean idIsPersistent, String id)
          Retrieves the value for the reference removedPosition for the specified qualifier attribute value.
 Account getSalesRep()
          Retrieves the value for the reference salesRep.
 String getShippingInstructions()
          Retrieves the possibly null value for the optional attribute shippingInstructions.
 short getShippingMethod()
          Retrieves the value for the attribute shippingMethod.
 String getShippingTrackingNumber()
          Retrieves the possibly null value for the optional attribute shippingTrackingNumber.
 Account getSupplier()
          Retrieves the value for the reference supplier.
 BigDecimal getTotalAmount()
          Retrieves the value for the attribute totalAmount.
 BigDecimal getTotalAmountIncludingTax()
          Retrieves the value for the attribute totalAmountIncludingTax.
 BigDecimal getTotalBaseAmount()
          Retrieves the value for the attribute totalBaseAmount.
 BigDecimal getTotalDiscountAmount()
          Retrieves the value for the attribute totalDiscountAmount.
 BigDecimal getTotalSalesCommission()
          Retrieves the value for the attribute totalSalesCommission.
 BigDecimal getTotalTaxAmount()
          Retrieves the value for the attribute totalTaxAmount.
 List<Boolean> getUserBoolean4()
          Retrieves a list containing all the elements for the attribute userBoolean4.
 Short getUserCode0()
          Retrieves the possibly null value for the optional attribute userCode0.
 Short getUserCode1()
          Retrieves the possibly null value for the optional attribute userCode1.
 Short getUserCode2()
          Retrieves the possibly null value for the optional attribute userCode2.
 Short getUserCode3()
          Retrieves the possibly null value for the optional attribute userCode3.
 List<Short> getUserCode4()
          Retrieves a list containing all the elements for the attribute userCode4.
 javax.xml.datatype.XMLGregorianCalendar getUserDate0()
          Retrieves the possibly null value for the optional attribute userDate0.
 javax.xml.datatype.XMLGregorianCalendar getUserDate1()
          Retrieves the possibly null value for the optional attribute userDate1.
 javax.xml.datatype.XMLGregorianCalendar getUserDate2()
          Retrieves the possibly null value for the optional attribute userDate2.
 javax.xml.datatype.XMLGregorianCalendar getUserDate3()
          Retrieves the possibly null value for the optional attribute userDate3.
 List<javax.xml.datatype.XMLGregorianCalendar> getUserDate4()
          Retrieves a list containing all the elements for the attribute userDate4.
 Date getUserDateTime0()
          Retrieves the possibly null value for the optional attribute userDateTime0.
 Date getUserDateTime1()
          Retrieves the possibly null value for the optional attribute userDateTime1.
 Date getUserDateTime2()
          Retrieves the possibly null value for the optional attribute userDateTime2.
 Date getUserDateTime3()
          Retrieves the possibly null value for the optional attribute userDateTime3.
 List<Date> getUserDateTime4()
          Retrieves a list containing all the elements for the attribute userDateTime4.
 BigDecimal getUserNumber0()
          Retrieves the possibly null value for the optional attribute userNumber0.
 BigDecimal getUserNumber1()
          Retrieves the possibly null value for the optional attribute userNumber1.
 BigDecimal getUserNumber2()
          Retrieves the possibly null value for the optional attribute userNumber2.
 BigDecimal getUserNumber3()
          Retrieves the possibly null value for the optional attribute userNumber3.
 List<BigDecimal> getUserNumber4()
          Retrieves a list containing all the elements for the attribute userNumber4.
 String getUserString0()
          Retrieves the possibly null value for the optional attribute userString0.
 String getUserString1()
          Retrieves the possibly null value for the optional attribute userString1.
 String getUserString2()
          Retrieves the possibly null value for the optional attribute userString2.
 String getUserString3()
          Retrieves the possibly null value for the optional attribute userString3.
 List<String> getUserString4()
          Retrieves a list containing all the elements for the attribute userString4.
<T extends org.openmdx.compatibility.view1.cci2.View>
Collection<T>
getView()
          Retrieves a set containing all the elements for the reference view.
 org.openmdx.compatibility.view1.cci2.View getView(boolean namespaceIsPersistent, String namespace)
          Retrieves the value for the reference view for the specified qualifier attribute value.
 ImportResult importItem(byte[] item, String itemMimeType, String itemName, short locale)
           
 Boolean isDisabled()
          Retrieves the possibly null value for the optional attribute disabled.
 boolean isGift()
          Retrieves the value for the attribute isGift.
 Boolean isUserBoolean0()
          Retrieves the possibly null value for the optional attribute userBoolean0.
 Boolean isUserBoolean1()
          Retrieves the possibly null value for the optional attribute userBoolean1.
 Boolean isUserBoolean2()
          Retrieves the possibly null value for the optional attribute userBoolean2.
 Boolean isUserBoolean3()
          Retrieves the possibly null value for the optional attribute userBoolean3.
 org.openmdx.base.cci2.Void markAsClosed(short invoiceState)
           
static Invoice.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean idIsPersistent, String id)
           
protected  org.w3c.jdo2.AbstractObject.Slice newSlice(int index)
           
protected  List<String> openmdxjdoGetClass()
          Retrieve the model class
protected  String openmdxjdoGetObjectId()
          Retrieve the object's JDO identity key
static CloseableCollection<Invoice> openmdxjdoGetObjectsByParent(Segment segment)
          Navigate through an object's composite association
protected  int openmdxjdoGetSize(int field)
           
protected
<E extends org.w3c.jdo2.AbstractObject.Slice>
SortedMap<Integer,E>
openmdxjdoGetSlices()
           
protected  void openmdxjdoSetSize(int field, int size)
           
static Invoice.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
           
 ModifySecureObjectResult removeAllOwningGroup(short mode)
           
 ModifySecureObjectResult removeOwningGroup(PrincipalGroup group, short mode)
           
 org.openmdx.base.cci2.Void removePendingInventoryBookings()
           
 org.openmdx.base.cci2.Void reprice()
           
 org.openmdx.base.cci2.Void sendAlert(String description, short importance, String name, org.openmdx.base.cci2.BasicObject reference, Integer resendDelayInSeconds, String toUsers)
           
 ModifySecureObjectResult setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
           
 void setAccessLevelBrowse(short accessLevelBrowse)
          Sets a new value for the attribute accessLevelBrowse.
 void setAccessLevelDelete(short accessLevelDelete)
          Sets a new value for the attribute accessLevelDelete.
 void setAccessLevelUpdate(short accessLevelUpdate)
          Sets a new value for the attribute accessLevelUpdate.
 void setActiveOn(Date activeOn)
          Sets a new value for the attribute activeOn.
 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 setCancelOn(Date cancelOn)
          Sets a new value for the attribute cancelOn.
 void setCarrier(Account carrier)
          Sets a new value for the reference carrier.
 void setCategory(String... category)
          Clears category and adds the given value(s).
 void setClosedOn(Date closedOn)
          Sets a new value for the attribute closedOn.
 void setContractCurrency(short contractCurrency)
          Sets a new value for the attribute contractCurrency.
 void setContractLanguage(short contractLanguage)
          Sets a new value for the attribute contractLanguage.
 void setContractNumber(String contractNumber)
          Sets a new value for the attribute contractNumber.
 void setContractState(short contractState)
          Sets a new value for the attribute contractState.
 void setCustomer(Account customer)
          Sets a new value for the reference customer.
 void setDescription(String description)
          Sets a new value for the attribute description.
 void setDisabled(Boolean disabled)
          Sets a new value for the attribute disabled.
 void setDisabledReason(String disabledReason)
          Sets a new value for the attribute disabledReason.
 void setExpiresOn(Date expiresOn)
          Sets a new value for the attribute expiresOn.
 void setExternalLink(String... externalLink)
          Clears externalLink and adds the given value(s).
 void setGift(boolean isGift)
          Sets a new value for the attribute isGift.
 void setGiftMessage(String giftMessage)
          Sets a new value for the attribute giftMessage.
 void setName(String name)
          Sets a new value for the attribute name.
 void setOrigin(AbstractContract origin)
          Sets a new value for the reference origin.
 ModifySecureObjectResult