public class Line extends ModelObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String | EDIT_STATE
Constant for the line edit state.
|
static java.lang.String | INVALID_CORRELATION_NUM
Initial correlation number assigned to Line.
|
static java.lang.String | NEW_STATE
Constant for the line new state.
|
static java.lang.String | PROP_APPLIED_QUANTITY
Constant for the quantity applied property name.
|
static java.lang.String | PROP_APPLY_TRY_STATE
Constant for the try Apply property name.
|
static java.lang.String | PROP_CATALOG_ENTRY_ID
Constant for the catalog entry ID property name.
|
static java.lang.String | PROP_CATALOG_MEMBER_ID
Constant for the catalog member Id property name.
|
static java.lang.String | PROP_CONFIGURATION_ID
Constant for the configuration ID property name.
|
static java.lang.String | PROP_CONTRACT_ID
Constant for the contract id property name.
|
static java.lang.String | PROP_CONTRACT_SHIPPING
Constant for the contract shipping property name.
|
static java.lang.String | PROP_CORRELATION_NUMBER
Constant for the correlation number property name.
|
static java.lang.String | PROP_CURRENCY
Constant for the currency property name.
|
static java.lang.String | PROP_DIRTY
Constant for the dirty property name.
|
static java.lang.String | PROP_DISCOUNT_AMOUNT
Constant for the discount amount property name.
|
static java.lang.String | PROP_EDITABLE
Constant for the editable property name.
|
static java.lang.String | PROP_EXPEDITE
Constant for the expedite property name.
|
static java.lang.String | PROP_EXTENDED_PRICE
Constant for the extended price property name.
|
static java.lang.String | PROP_IS_FREE_GIFT
Constant for the isFreeGift property name.
|
static java.lang.String | PROP_IS_VALID_PRODUCT
Constant for the has valid product property name.
|
static java.lang.String | PROP_ITEM_CREATE_DATE
Constant for the lastUpdatedDate property name.
|
static java.lang.String | PROP_MISCELLANEOUS_CHARGE
Constant for the miscellaneous charge property name prefix.
|
static java.lang.String | PROP_PRICE_OVERRIDE
Constant for the price override bean.
|
static java.lang.String | PROP_PRODUCT
Constant for the product property name.
|
static java.lang.String | PROP_QUANTITY
Constant for the quantity property name.
|
static java.lang.String | PROP_QUANTITY_ALLOCATED
Constant for the quantity allocated property name.
|
static java.lang.String | PROP_REQUESTED_DELIVERY_DATE
Constant for the requested delivery date property name.
|
static java.lang.String | PROP_SAVED_SHIPPING_MODE
Constant for the shipping mode property name.
|
static java.lang.String | PROP_SERIAL_NUMBERS
Constant for the serial number property.
|
static java.lang.String | PROP_SHIPPED
Constant for the shipped property name.
|
static java.lang.String | PROP_SHIPPING_ADDRESS
Constant for the shipping address property name.
|
static java.lang.String | PROP_SHIPPING_CARRIER
Constant for the shipping carrier property name.
|
static java.lang.String | PROP_SHIPPING_INSTRUCTION
Constant for the shipping instruction property name.
|
static java.lang.String | PROP_SHIPPING_MODE
Constant for the shipping mode property name.
|
static java.lang.String | PROP_SKU
Constant for the sku property name.
|
static java.lang.String | PROP_STATE
Constant for the state property name.
|
static java.lang.String | PROP_SUB_LINES
Constant for the sub lines property name.
|
static java.lang.String | PROP_TIE_CODE
Constant for the tie code property name.
|
static java.lang.String | PROP_UNIQUE_ID
Constant for the unique ID property name.
|
static java.lang.String | PROP_UNIT_PRICE_AMOUNT
Constant for the unit price amount property name.
|
Constructor and Description |
---|
Line()
Constructor for Line.
|
Modifier and Type | Method and Description |
---|---|
void | addMiscellaneousCharge(MiscellaneousCharge miscellaneousCharge)
This method is a convenience method for setting an "miscellaneousCharge." property.
|
void | addSerialNumber(java.lang.String serial)
This method is a convenience method for updating the "serialNumber" property.
|
void | addSubLine(SubLine subline)
This method is a convenience method for updating the "subLines" property.
|
java.lang.String | getAppliedQuantity()
This method is a convenience method for retrieving the current setting of the "appliedQuantity" property.
|
java.lang.String | getCatalogEntryId()
This method is a convenience method for retrieving the current setting of the "catalogEntryId" property.
|
java.lang.String | getCatalogMemberId()
This method is a convenience method for retrieving the current setting of the "catalogMemberId" property.
|
java.lang.String | getConfigurationId()
This method is a convenience method for retrieving the current setting of the "configurationId" property.
|
java.lang.String | getContractID()
This method is a convenience method for retrieving the current setting of the "contractID" property.
|
ContractShipping | getContractShipping()
This method is a convenience method for retrieving the current setting of the "contractShipping" property.
|
java.lang.String | getCorrelationNumber()
This method is a convenience method for retrieving the current setting of the "correlationNumber" property.
|
java.lang.String | getCurrency()
This method is a convenience method for retrieving the current setting of the "currency" property.
|
java.lang.String | getDiscountAmount()
This method is a convenience method for retrieving the current setting of the "discountAmount" property.
|
java.lang.String | getExtendedPrice()
This method is a convenience method for retrieving the current setting of the "extendedPrice" property.
|
java.lang.String | getItemCreateDate()
This method is a convenience method for retrieving the current setting of the "lastUpdatedDate" property.
|
MiscellaneousCharge[] | getMiscellaneousCharges()
This method is a convenience method for retrieving the current setting of all of the "miscellaneousCharge." properties.
|
PriceOverrideBean | getPriceOverrideBean()
This method is a convenience method to get the "priceOverride" property.
|
Product | getProduct()
This method is a convenience method for retrieving the current setting of the "product" property.
|
java.lang.String | getQuantity()
This method is a convenience method for retrieving the current setting of the "quantity" property.
|
java.lang.String | getQuantityAllocated()
This method is a convenience method for retrieving the current setting of the "quantityAllocated" property.
|
java.lang.String | getRequestedDeliveryDate()
This method is a convenience method for retrieving the current setting of the "requestedDeliveryDate" property.
|
java.lang.String | getSavedShippingMode()
This method is a convenience method for retrieving the current setting of the "savedShippingMode" property.
|
java.util.ArrayList | getSerialNumbers()
This method is a convenience method for retrieving the current setting of the "serialNumbers" property.
|
Address | getShippingAddress()
This method is a convenience method for retrieving the current setting of the "shippingAddress" property.
|
ShippingCarriers | getShippingCarriers()
This method is a convenience method for getting the "shippingCarriers" property.
|
ShippingInstructions | getShippingInstructions()
This method is a convenience method for getting the "shippingInstructions" property.
|
java.lang.String | getShippingMode()
This method is a convenience method for retrieving the current setting of the "shippingMode" property.
|
java.lang.String | getState()
This method is a convenience method for retrieving the current setting of the "state" property.
|
SubLine[] | getSubLines()
This method is a convenience method for retrieving the current setting of the "subLines" property.
|
ModelObjectList | getSubLinesModelObjectList()
This method is a convenience method for retrieving the current setting of the "subLines" property.
|
java.lang.String | getTieCode()
This method is a convenience method for retrieving the current setting of the "tieCode" property.
|
java.lang.String | getUnitPrice()
This method is a convenience method for retrieving the current setting of the "unitPriceAmount" property.
|
boolean | isApplyTried()
This method is a convenience method for retrieving the current setting of the "tryApply" property.
|
boolean | isCorrelationNumberValid()
This method tells you if the Line has a valid correlation number (returns 'true') or still uses the initial invalid correlation number (returns 'false')
|
boolean | isDirty()
This method is a convenience method for retrieving the current setting of the "dirty" property.
|
boolean | isEditable()
This method is a convenience method for retrieving the current setting of the "editable" property.
|
boolean | isExpedite()
This method is a convenience method for retrieving the current setting of the "expedite" property.
|
boolean | isFreeGift()
This method is a convenience method for retrieving the current setting of the "freeGift" property.
|
boolean | isProductValid()
This method is a convenience method for retrieving the current setting of the "isValid" property.
|
boolean | isShipped()
This method is a convenience method for retrieving the current setting of the "shipped" property.
|
void | setAppliedQuantity(java.lang.String quantity)
This method is a convenience method for setting the "appliedQuantity" property.
|
void | setApplyTried(boolean tryApply)
This method is a convenience method for setting the "tryApply" property.
|
void | setCatalogEntryId(java.lang.String catalogEntryId)
This method is a convenience method for setting the "catalogEntryId" property.
|
void | setCatalogMemberId(java.lang.String catalogMemberId)
This method is a convenience method for setting the "catalogMemberId" property.
|
void | setConfigurationId(java.lang.String configurationId)
This method is a convenience method for setting the "configurationId" property.
|
void | setContractID(java.lang.String contractID)
This method is a convenience method for setting the PROP_CONTRACT_ID property.
|
void | setContractShipping(ContractShipping contractShipping)
This method is a convenience method for setting the "contractShipping" property.
|
void | setCorrelationNumber(java.lang.String correlationNumber)
This method is a convenience method for setting the "correlationNumber" property.
|
void | setCurrency(java.lang.String currency)
This method is a convenience method for setting the "currency" property.
|
void | setDirty(boolean dirty)
This method is a convenience method for setting the PROP_DIRTY property.
|
void | setDiscountAmount(java.lang.String discountAmount)
This method is a convenience method for setting the "discountAmount" property.
|
void | setEditable(boolean editable)
This method is a convenience method for setting the "editable" property.
|
void | setExpedite(boolean expedite)
This method is a convenience method for setting the "expedite" property.
|
void | setExpedite(java.lang.Boolean expedite)
This method is a convenience method for setting the "expedite" property.
|
void | setExtendedPrice(java.lang.String extendedPrice)
This method is a convenience method for setting the "extendedPrice" property.
|
void | setFreeGift(boolean freeGift)
This method is a convenience method for setting the "isFreeGift" property.
|
void | setItemCreateDate(java.lang.String itemCreateDate)
This method is a convenience method for setting the PROP_ITEM_CREATE_DATE property.
|
void | setMiscellaneousCharges(MiscellaneousCharge[] miscellaneousCharges)
This method is a convenience method for setting the "miscellaneousCharge." properties.
|
void | setPriceOverrideBean(PriceOverrideBean priceOverride)
This method is a convenience method for setting the "priceOverride" property.
|
void | setProduct(Product product)
This method is a convenience method for setting the "product" property.
|
void | setProductValid(boolean isValid)
This method is a convenience method for setting the "isValid" property.
|
void | setQuantity(java.lang.String quantity)
This method is a convenience method for setting the "quantity" property.
|
void | setQuantityAllocated(java.lang.String quantityAllocated)
This method is a convenience method for setting the "quantityAllocated" property.
|
void | setRequestedDeliveryDate(java.lang.String requestedDeliveryDate)
This method is a convenience method for setting the "requestedDeliveryDate" property.
|
void | setSavedShippingMode(java.lang.String shippingMode)
This method is a convenience method for setting the "savedShippingMode" property.
|
void | setSerialNumber(java.util.ArrayList serialNumbers)
This method is a convenience method for setting the PROP_SERIAL_NUMBERS property.
|
void | setShipped(boolean shipped)
This method is a convenience method for setting the "shipped" property.
|
void | setShippingAddress(Address shippingAddress)
This method is a convenience method for setting the "shippingAddress" property.
|
void | setShippingCarriers(ShippingCarriers shippingCarriers)
This method is a convenience method for setting the PROP_SHIPPING_CARRIER property.
|
void | setShippingInstructions(ShippingInstructions shippingInstructions)
This method is a convenience method for setting the PROP_SHIPPING_INSTRUCTION property.
|
void | setShippingMode(java.lang.String shippingMode)
This method is a convenience method for setting the "shippingMode" property.
|
void | setState(java.lang.String state)
This method is a convenience method for setting the "state" property.
|
void | setTieCode(java.lang.String tieCode)
This method is a convenience method for setting the "tieCode" property.
|
void | setUniqueId()
This method is a convenience method for setting the unique id for use on the client side.
|
void | setUnitPrice(java.lang.String unitPrice)
This method is a convenience method for setting the "unitPriceAmount" property.
|
java.lang.String | toString()
Returns a string representation of this line.
|
public static final java.lang.String INVALID_CORRELATION_NUM
public static final java.lang.String PROP_CORRELATION_NUMBER
The value is "correlationNumber".
The data stored under the "correlationNumber" property is a String that represents the line item's correlation number.
public static final java.lang.String PROP_DISCOUNT_AMOUNT
The value is "discountAmount".
The data stored under the "discountAmount" property is a String that represents the line's total discount amount.
public static final java.lang.String PROP_EDITABLE
The value is "editable".
The data stored under the "editable" property is a Boolean that indicates if the line item is editable.
public static final java.lang.String PROP_SKU
The value is "sku".
The data stored under the "sku" property is a String that indicates if the line item's sku.
public static final java.lang.String PROP_QUANTITY
The value is "quantity".
The data stored under the "quantity" property is a String that indicates if the number of items requested for this line item.
public static final java.lang.String PROP_APPLIED_QUANTITY
The value is "appliedQuantity".
The data stored under the "appliedQuantity" property is a String that indicates the number of applied items for this line item. This value will be always sync with server.
public static final java.lang.String PROP_QUANTITY_ALLOCATED
The value is "quantityAllocated".
The data stored under the "quantityAllocated" property is a String that indicates if the number of allocated items for this line item.
public static final java.lang.String PROP_TIE_CODE
The value is "tieCode".
The data stored under the "tieCode" property is a String that contains the tie code.
public static final java.lang.String PROP_ITEM_CREATE_DATE
The value is "lastUpdatedDate".
The data stored under the "lastUpdatedDate" property is a String that contains the last Updated Date and time for this item.
public static final java.lang.String PROP_CONTRACT_ID
The value is "contractID".
The data stored under the "contractID" property is a String that contains the contract id.
public static final java.lang.String PROP_CONTRACT_SHIPPING
The value is "contractShipping".
The data stored under the "contractShipping" property is a ContractShipping that contains the contract shipping information.
public static final java.lang.String PROP_UNIT_PRICE_AMOUNT
The value is "unitPriceAmount".
The data stored under the "unitPriceAmount" property is a String that contains the unit price.
public static final java.lang.String PROP_MISCELLANEOUS_CHARGE
The value is "miscellaneousCharge.".
The data stored under property names with the "miscellaneousCharge." prefix is of type MiscellaneousCharge. The full property name is "miscellaneousCharge.miscellaneousChargeId", where miscellaneousChargeId is the miscellaneous charge type's unique identifier.
public static final java.lang.String PROP_EXTENDED_PRICE
The value is "extendedPrice".
The data stored under the "extendedPrice" property is a String that contains the extended price.
public static final java.lang.String PROP_CURRENCY
The value is "currency".
The data stored under the "currency" property is a String that contains the currency.
public static final java.lang.String PROP_REQUESTED_DELIVERY_DATE
The value is "requestedDeliveryDate".
The data stored under the "requestedDeliveryDate" property is a String that contains the requested delivery date.
public static final java.lang.String PROP_CATALOG_ENTRY_ID
The value is "catalogEntryId".
The data stored under the "catalogEntryId" property is a String that contains the catalog entry ID.
public static final java.lang.String PROP_CATALOG_MEMBER_ID
The value is "catalogMemberId".
The data stored under the "catalogMemberId" property is a String that contains the catalog member Id.
public static final java.lang.String PROP_PRODUCT
The value is "product".
The data stored under the "product" property is a Product that represents the product.
public static final java.lang.String PROP_SHIPPING_ADDRESS
The value is "shippingAddress".
The data stored under the "shippingAddress" property is an Address that represents the shipping address.
public static final java.lang.String PROP_SHIPPING_MODE
The value is "shippingMode".
The data stored under the "shippingMode" property is a String that contains the shipping mode.
public static final java.lang.String PROP_SAVED_SHIPPING_MODE
The value is "savedShippingMode".
The data stored under the "savedShippingMode" property is a String that contains the shipping mode saved in the database.
public static final java.lang.String PROP_SUB_LINES
The value is "subLines".
The data stored under the "subLines" property is a ModelObjectList that contains the list of SubLine objects.
public static final java.lang.String PROP_CONFIGURATION_ID
The value is "configurationId".
The data stored under the "configurationId" property is a java.lang.String that represents the configuration ID.
public static final java.lang.String PROP_UNIQUE_ID
The value is "uniqueId".
The data stored under the "uniqueId" property is a generated Integer that is unique to this object. This property is considered a significant property until a valid "corelationid" property is set.
public static final java.lang.String PROP_IS_VALID_PRODUCT
The value is "isValidProduct".
The data stored under the "requirisValidProducted" property is a java.lang.Boolean that represents the if the product contained in this line is valid or not. This property is used by the order editor.
public static final java.lang.String PROP_DIRTY
The value is "dirty".
The data stored under the "dirty" property is a java.lang.String that represents the if the line is dirty.
public static final java.lang.String NEW_STATE
The value is "new".
public static final java.lang.String EDIT_STATE
The value is "edit".
public static final java.lang.String PROP_STATE
The value is "state".
The data stored under the "state" property is a java.lang.String that represents the state of the line (New, Edit, or Delete).
public static final java.lang.String PROP_EXPEDITE
The value is "expedite".
The data stored under the "expedite" property is a java.lang.String that represents if the line must be expedited or not.
public static final java.lang.String PROP_SERIAL_NUMBERS
The value is "serialNumbers".
The data stored under the "serialNumbers" property is a java.util.ArrayList containing String objects representing the serial numbers possibly belonging to the ordered item
public static final java.lang.String PROP_SHIPPED
The value is "shipped".
The data stored under the "shipped" property is a Boolean that indicates if the line item is shipped.
public static final java.lang.String PROP_PRICE_OVERRIDE
The value is "priceOverride".
The data stored under the "priceOverride" property is a PriceOverrideBean that indicates if the line item price override.
public static final java.lang.String PROP_APPLY_TRY_STATE
The value is "tryApply".
The data stored under the "tryApply" property is a boolean that represents the if the line was tried for apply or not. This property is used by the order editor.
public static final java.lang.String PROP_IS_FREE_GIFT
The value is "isFreeGift".
The data stored under the "isFreeGift" property is a boolean that represents the if the line is a free gift or not. This property is used by the order editor to decide whether the line item is editable or not.
public static final java.lang.String PROP_SHIPPING_INSTRUCTION
The value is "shippingInstructions".
The data stored under the "shippingInstructions" property is a ShippingInstructions that represents shipping instructions that was changed by the user. This value will be null if the user do not change the shipping instruction using the user interface.
public static final java.lang.String PROP_SHIPPING_CARRIER
The value is "shippingCarrier".
The data stored under the "shippingCarrier" property is a ShippingCarriers that represents shipping carriers that was changed by the user. This value will be null if the user do not change the shipping carrier using the user interface.
public void addMiscellaneousCharge(MiscellaneousCharge miscellaneousCharge)
public void addSubLine(SubLine subline)
public java.lang.String getCatalogMemberId()
public java.lang.String getCatalogEntryId()
public java.lang.String getConfigurationId()
public java.lang.String getCorrelationNumber()
public java.lang.String getCurrency()
public boolean isCorrelationNumberValid()
public boolean isEditable()
public java.lang.String getDiscountAmount()
public java.lang.String getExtendedPrice()
public MiscellaneousCharge[] getMiscellaneousCharges()
public Product getProduct()
public java.lang.String getTieCode()
public java.lang.String getItemCreateDate()
public java.lang.String getQuantity()
public java.lang.String getAppliedQuantity()
public java.lang.String getQuantityAllocated()
public java.lang.String getRequestedDeliveryDate()
public Address getShippingAddress()
public java.lang.String getShippingMode()
public java.lang.String getSavedShippingMode()
public SubLine[] getSubLines()
public ModelObjectList getSubLinesModelObjectList()
public java.lang.String getContractID()
public ContractShipping getContractShipping()
public java.lang.String getUnitPrice()
public void setCatalogMemberId(java.lang.String catalogMemberId)
public void setCatalogEntryId(java.lang.String catalogEntryId)
public void setConfigurationId(java.lang.String configurationId)
public void setCorrelationNumber(java.lang.String correlationNumber)
public void setCurrency(java.lang.String currency)
public void setDiscountAmount(java.lang.String discountAmount)
public void setTieCode(java.lang.String tieCode)
public void setItemCreateDate(java.lang.String itemCreateDate)
public void setEditable(boolean editable)
public void setExtendedPrice(java.lang.String extendedPrice)
public void setMiscellaneousCharges(MiscellaneousCharge[] miscellaneousCharges)
public void setProduct(Product product)
public void setQuantity(java.lang.String quantity)
public void setAppliedQuantity(java.lang.String quantity)
public void setQuantityAllocated(java.lang.String quantityAllocated)
public void setRequestedDeliveryDate(java.lang.String requestedDeliveryDate)
public void setShippingAddress(Address shippingAddress)
public void setShippingMode(java.lang.String shippingMode)
public void setSavedShippingMode(java.lang.String shippingMode)
public void setContractID(java.lang.String contractID)
public void setContractShipping(ContractShipping contractShipping)
public void setUnitPrice(java.lang.String unitPrice)
public java.util.ArrayList getSerialNumbers()
public void addSerialNumber(java.lang.String serial)
public void setSerialNumber(java.util.ArrayList serialNumbers)
public void setShipped(boolean shipped)
public boolean isShipped()
public java.lang.String toString()
public void setProductValid(boolean isValid)
public void setDirty(boolean dirty)
public boolean isDirty()
public boolean isProductValid()
public void setUniqueId()
public void setState(java.lang.String state)
public java.lang.String getState()
public boolean isExpedite()
public void setExpedite(boolean expedite)
public void setExpedite(java.lang.Boolean expedite)
public void setPriceOverrideBean(PriceOverrideBean priceOverride)
public PriceOverrideBean getPriceOverrideBean()
public boolean isApplyTried()
public void setApplyTried(boolean tryApply)
public boolean isFreeGift()
public void setFreeGift(boolean freeGift)
public void setShippingInstructions(ShippingInstructions shippingInstructions)
public ShippingInstructions getShippingInstructions()
public void setShippingCarriers(ShippingCarriers shippingCarriers)
public ShippingCarriers getShippingCarriers()