|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Order
Implemented by a class that represents an order. This interface provides all the methods to manipulate an Order object. Any object which is an Order needs to implement this interface. For an example, see atg.commerce.order.OrderImpl.
OrderImpl
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary | |
---|---|
void |
addOrderIdToRelatedOrders(java.lang.String pOrderId)
Sets the relatedOrders property |
boolean |
equals(java.lang.Object pOrder)
Returns true if pOrder is the same as this Order. |
java.lang.String |
getAgentId()
Returns agentId |
java.util.List |
getApprovalSystemMessages()
Returns the approvalSystemMessages |
java.util.List |
getApproverIds()
Returns the approverIds |
java.util.List |
getApproverMessages()
Returns the approverMessages |
java.util.List |
getAuthorizedApproverIds()
Returns the authorizedApproverIds |
java.util.Date |
getCompletedDate()
Returns the completedDate. |
long |
getCompletedTime()
Gets the completedDate as a long. |
java.lang.String |
getCreatedByOrderId()
Returns the createdByOrderId |
java.util.Date |
getCreationDate()
Returns the creationDate. |
java.lang.String |
getCreationSiteId()
Returns the ID of the site on which this order was created |
long |
getCreationTime()
Gets the creationDate as a long. |
java.lang.String |
getDescription()
Returns the description |
java.util.Date |
getLastModifiedDate()
Returns the lastModifiedDate. |
long |
getLastModifiedTime()
Gets the lastModifiedDate as a long. |
java.util.List |
getManualAdjustments()
Returns a list of manualAdjustment repository items for this order. |
java.lang.String |
getOrderClassType()
Returns the orderClassType |
java.lang.String |
getOriginOfOrder()
Returns the OriginOfOrder property |
OrderPriceInfo |
getPriceInfo()
Returns the OrderPriceInfo for the order |
java.lang.String |
getProfileId()
Returns the RepositoryId of the profile which this Order belongs to. |
java.util.List |
getRelatedOrders()
Returns the relatedOrders property |
java.lang.String |
getSalesChannel()
Returns salesChannel |
java.lang.String |
getSiteId()
Returns the ID of the site associated with this order |
java.util.Map |
getSpecialInstructions()
Returns the specialInstructions |
int |
getState()
Returns the order state. |
java.lang.String |
getStateDetail()
Returns the order state details. |
java.util.Date |
getSubmittedDate()
Returns the submittedDate. |
long |
getSubmittedTime()
Gets the submittedDate as a long. |
TaxPriceInfo |
getTaxPriceInfo()
Returns the taxPriceInfo |
boolean |
isChanged()
Returns the isChanged flag |
boolean |
isExplicitlySaved()
Returns true if the order was explicitly marked for saving. |
boolean |
isTransient()
Returns the transient flag. |
void |
setAgentId(java.lang.String pAgentId)
Sets agentId |
void |
setApprovalSystemMessages(java.util.List pApprovalSystemMessages)
Sets the approvalSystemMessages |
void |
setApproverIds(java.util.List pApproverIds)
Sets the approverIds |
void |
setApproverMessages(java.util.List pApproverMessages)
Sets the approverMessages |
void |
setAuthorizedApproverIds(java.util.List pAuthorizedApproverIds)
Sets the authorizedApproverIds |
void |
setCompletedTime(long pCompletedTime)
Sets the completedDate as a long. |
void |
setCreatedByOrderId(java.lang.String pCreatedByOrderId)
Sets the createdByOrderId |
void |
setCreationSiteId(java.lang.String pCreationSiteId)
Sets the ID of the site on which this order was created |
void |
setCreationTime(long pCreationTime)
Sets the creationDate as a long. |
void |
setDescription(java.lang.String pDescription)
Sets the description |
void |
setExplicitlySaved(boolean pExplicitlySave)
Marks the order as one that has been explicitly saved. |
void |
setLastModifiedTime(long pLastModifiedTime)
Sets the lastModifiedDate as a long. |
void |
setManualAdjustments(java.util.List pManualAdjustments)
|
void |
setOrderClassType(java.lang.String pOrderClassType)
Sets the orderClassType |
void |
setOriginOfOrder(java.lang.String pOriginOfOrder)
Sets the originOfOrder property. |
void |
setPriceInfo(OrderPriceInfo pPriceInfo)
Sets the OrderPriceInfo for the order |
void |
setProfileId(java.lang.String pId)
Sets the RepositoryId of the profile which this Order belongs to. |
void |
setSalesChannel(java.lang.String pSalesChannel)
Sets salesChannel |
void |
setSiteId(java.lang.String pSiteId)
Sets the ID of the site on which this order was submitted |
void |
setState(int pState)
Sets the order state. |
void |
setStateDetail(java.lang.String pStateDetail)
Sets the order state details. |
void |
setSubmittedTime(long pSubmittedTime)
Sets the submittedDate as a long. |
void |
setTaxPriceInfo(TaxPriceInfo pTaxPriceInfo)
Sets the taxPriceInfo |
void |
setTransient(boolean pTransient)
Sets the transient flag. |
Methods inherited from interface atg.commerce.order.CommerceItemContainer |
---|
addCommerceItem, addCommerceItem, getCommerceItem, getCommerceItemCount, getCommerceItems, getCommerceItemsByCatalogRefId, getTotalCommerceItemCount, removeAllCommerceItems, removeCommerceItem |
Methods inherited from interface atg.commerce.order.ShippingGroupContainer |
---|
addShippingGroup, addShippingGroup, getShippingGroup, getShippingGroupCount, getShippingGroups, removeAllShippingGroups, removeShippingGroup |
Methods inherited from interface atg.commerce.order.PaymentGroupContainer |
---|
addPaymentGroup, addPaymentGroup, getPaymentGroup, getPaymentGroupCount, getPaymentGroups, removeAllPaymentGroups, removePaymentGroup |
Methods inherited from interface atg.commerce.order.RelationshipContainer |
---|
addRelationship, addRelationship, getRelationship, getRelationshipCount, getRelationships, removeAllRelationships, removeRelationship |
Methods inherited from interface atg.commerce.order.PaymentGroupRelationshipContainer |
---|
addPaymentGroupRelationship, addPaymentGroupRelationship, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, removeAllPaymentGroupRelationships, removePaymentGroupRelationship |
Methods inherited from interface atg.commerce.order.CostCenterContainer |
---|
addCostCenter, addCostCenter, getCostCenter, getCostCenterCount, getCostCenters, removeAllCostCenters, removeCostCenter |
Methods inherited from interface atg.commerce.order.CostCenterRelationshipContainer |
---|
addCostCenterRelationship, addCostCenterRelationship, getCostCenterRelationship, getCostCenterRelationshipCount, getCostCenterRelationships, removeAllCostCenterRelationships, removeCostCenterRelationship |
Methods inherited from interface atg.commerce.order.CommerceIdentifier |
---|
getId |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
java.lang.String getOrderClassType()
void setOrderClassType(java.lang.String pOrderClassType)
java.lang.String getProfileId()
void setProfileId(java.lang.String pId)
java.lang.String getDescription()
void setDescription(java.lang.String pDescription)
int getState()
void setState(int pState)
java.lang.String getStateDetail()
void setStateDetail(java.lang.String pStateDetail)
OrderPriceInfo getPriceInfo()
void setPriceInfo(OrderPriceInfo pPriceInfo)
TaxPriceInfo getTaxPriceInfo()
void setTaxPriceInfo(TaxPriceInfo pTaxPriceInfo)
java.lang.String getCreatedByOrderId()
void setCreatedByOrderId(java.lang.String pCreatedByOrderId)
java.util.List getRelatedOrders()
void addOrderIdToRelatedOrders(java.lang.String pOrderId)
java.util.Date getSubmittedDate()
void setSubmittedTime(long pSubmittedTime)
long getSubmittedTime()
java.util.Date getCreationDate()
void setCreationTime(long pCreationTime)
long getCreationTime()
java.util.Date getLastModifiedDate()
void setLastModifiedTime(long pLastModifiedTime)
long getLastModifiedTime()
java.util.Date getCompletedDate()
void setCompletedTime(long pCompletedTime)
long getCompletedTime()
boolean isTransient()
void setTransient(boolean pTransient)
java.util.Map getSpecialInstructions()
void setOriginOfOrder(java.lang.String pOriginOfOrder)
java.lang.String getOriginOfOrder()
boolean isChanged()
boolean equals(java.lang.Object pOrder)
equals
in class java.lang.Object
void setExplicitlySaved(boolean pExplicitlySave)
pExplicitlySave
- is true if this order was explicitly saved, false otherwise.boolean isExplicitlySaved()
java.util.List getManualAdjustments()
void setManualAdjustments(java.util.List pManualAdjustments)
java.lang.String getAgentId()
void setAgentId(java.lang.String pAgentId)
pAgentId
- java.lang.String getSalesChannel()
void setSalesChannel(java.lang.String pSalesChannel)
pSalesChannel
- java.lang.String getCreationSiteId()
void setCreationSiteId(java.lang.String pCreationSiteId)
pCreationSiteId
- a site IDjava.lang.String getSiteId()
void setSiteId(java.lang.String pSiteId)
pSiteId
- a site IDjava.util.List getApproverIds()
void setApproverIds(java.util.List pApproverIds)
java.util.List getAuthorizedApproverIds()
void setAuthorizedApproverIds(java.util.List pAuthorizedApproverIds)
java.util.List getApprovalSystemMessages()
void setApprovalSystemMessages(java.util.List pApprovalSystemMessages)
java.util.List getApproverMessages()
void setApproverMessages(java.util.List pApproverMessages)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |