Order (ATG Java API)

All Superinterfaces:

CommerceIdentifier, CommerceItemContainer, CostCenterContainer, CostCenterRelationshipContainer, PaymentGroupContainer, PaymentGroupRelationshipContainer, RelationshipContainer, java.io.Serializable, ShippingGroupContainer

All Known Implementing Classes:

OrderImpl
```
public interface Order
extends CommerceItemContainer, ShippingGroupContainer, PaymentGroupContainer, RelationshipContainer, PaymentGroupRelationshipContainer, CostCenterContainer, CostCenterRelationshipContainer, CommerceIdentifier, java.io.Serializable
```
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.

See Also:

OrderImpl

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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`	`getActiveQuoteOrderId()` Returns activeQuoteOrderId
`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`	`getConfiguratorId()` Returns the ID for this order in an external Configurator system
`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`	`getOrganizationId()` Returns the RepositoryId of the organization which this Order belongs to.
`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.
`RepositoryItem`	`getQuoteInfo()` Returns the quote info repository item for the order
`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.
`default java.lang.String`	`getStateAsString()` Returns an UNSET state for a class that has no custom implementation.
`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
`java.util.Map`	`getTransientData()` Returns the transientData.
`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`	`setActiveQuoteOrderId(java.lang.String pActiveQuoteOrderId)` Sets activeQuoteOrderId
`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`	`setConfiguratorId(java.lang.String pConfiguratorId)` Sets the Configurator ID for this order
`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`	`setOrganizationId(java.lang.String pOrganizationId)` Sets the RepositoryId of the organization which this Order belongs to.
`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`	`setQuoteInfo(RepositoryItem pQuoteInfo)` Sets the quote info repository item for the order
`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, getCommerceItem, getCommerceItemCount, getCommerceItems, getCommerceItemsByCatalogRefId, getTotalCommerceItemCount, getTotalCommerceItemCountWithFraction, 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
  - CLASS_VERSION
```
static final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getOrderClassType
```
java.lang.String getOrderClassType()
```
    Returns the orderClassType
  - setOrderClassType
```
void setOrderClassType(java.lang.String pOrderClassType)
```
    Sets the orderClassType
  - getProfileId
```
java.lang.String getProfileId()
```
    Returns the RepositoryId of the profile which this Order belongs to.
  - setProfileId
```
void setProfileId(java.lang.String pId)
```
    Sets the RepositoryId of the profile which this Order belongs to.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description
  - setDescription
```
void setDescription(java.lang.String pDescription)
```
    Sets the description
  - getState
```
int getState()
```
    Returns the order state.
  - setState
```
void setState(int pState)
```
    Sets the order state.
  - getStateDetail
```
java.lang.String getStateDetail()
```
    Returns the order state details.
  - setStateDetail
```
void setStateDetail(java.lang.String pStateDetail)
```
    Sets the order state details.
  - getPriceInfo
```
OrderPriceInfo getPriceInfo()
```
    Returns the OrderPriceInfo for the order
  - setPriceInfo
```
void setPriceInfo(OrderPriceInfo pPriceInfo)
```
    Sets the OrderPriceInfo for the order
  - getTaxPriceInfo
```
TaxPriceInfo getTaxPriceInfo()
```
    Returns the taxPriceInfo
  - setTaxPriceInfo
```
void setTaxPriceInfo(TaxPriceInfo pTaxPriceInfo)
```
    Sets the taxPriceInfo
  - getCreatedByOrderId
```
java.lang.String getCreatedByOrderId()
```
    Returns the createdByOrderId
  - setCreatedByOrderId
```
void setCreatedByOrderId(java.lang.String pCreatedByOrderId)
```
    Sets the createdByOrderId
  - getRelatedOrders
```
java.util.List getRelatedOrders()
```
    Returns the relatedOrders property
  - addOrderIdToRelatedOrders
```
void addOrderIdToRelatedOrders(java.lang.String pOrderId)
```
    Sets the relatedOrders property
  - getSubmittedDate
```
java.util.Date getSubmittedDate()
```
    Returns the submittedDate. This is the date which the order was "checked out".
  - setSubmittedTime
```
void setSubmittedTime(long pSubmittedTime)
```
    Sets the submittedDate as a long. This is the date which the order was "checked out".
  - getSubmittedTime
```
long getSubmittedTime()
```
    Gets the submittedDate as a long. This is the date which the order was "checked out".
  - getCreationDate
```
java.util.Date getCreationDate()
```
    Returns the creationDate. This is the date that the Order was created.
  - setCreationTime
```
void setCreationTime(long pCreationTime)
```
    Sets the creationDate as a long. This is the date that the Order was created.
  - getCreationTime
```
long getCreationTime()
```
    Gets the creationDate as a long. This is the date that the Order was created.
  - getLastModifiedDate
```
java.util.Date getLastModifiedDate()
```
    Returns the lastModifiedDate. This is the date that the order was last saved.
  - setLastModifiedTime
```
void setLastModifiedTime(long pLastModifiedTime)
```
    Sets the lastModifiedDate as a long. This is the date that the order was last saved.
  - getLastModifiedTime
```
long getLastModifiedTime()
```
    Gets the lastModifiedDate as a long. This is the date that the order was last saved.
  - getCompletedDate
```
java.util.Date getCompletedDate()
```
    Returns the completedDate. This is the date that the order was completed.
  - setCompletedTime
```
void setCompletedTime(long pCompletedTime)
```
    Sets the completedDate as a long. This is the date that the order was completed.
  - getCompletedTime
```
long getCompletedTime()
```
    Gets the completedDate as a long. This is the date that the order was completed.
  - isTransient
```
boolean isTransient()
```
    Returns the transient flag. A transient Order is one which has not been persisted to a repository.
  - setTransient
```
void setTransient(boolean pTransient)
```
    Sets the transient flag. A transient Order is one which has not been persisted to a repository.
  - getSpecialInstructions
```
java.util.Map getSpecialInstructions()
```
    Returns the specialInstructions
  - getTransientData
```
java.util.Map getTransientData()
```
    Returns the transientData. This map stores the transient properties of an order and is not persisted.
    
    Returns:
    
    transientData
  - setOriginOfOrder
```
void setOriginOfOrder(java.lang.String pOriginOfOrder)
```
    Sets the originOfOrder property. The possible value will be default as the order is placed by the normal checkout process; or scheduledOrder as the order is placed within a scheduledOrder
  - getOriginOfOrder
```
java.lang.String getOriginOfOrder()
```
    Returns the OriginOfOrder property
  - isChanged
```
boolean isChanged()
```
    Returns the isChanged flag
  - equals
```
boolean equals(java.lang.Object pOrder)
```
    Returns true if pOrder is the same as this Order.
    
    Overrides:
    
    equals in class java.lang.Object
  - setExplicitlySaved
```
void setExplicitlySaved(boolean pExplicitlySave)
```
    Marks the order as one that has been explicitly saved. Explicitly saving an order indicates that it was persisted because of a direct call instead of the automatic persistence of a session's shopping cart.
    
    Parameters:
    
    pExplicitlySave - is true if this order was explicitly saved, false otherwise.
  - isExplicitlySaved
```
boolean isExplicitlySaved()
```
    Returns true if the order was explicitly marked for saving.
  - getManualAdjustments
```
java.util.List getManualAdjustments()
```
    Returns a list of manualAdjustment repository items for this order.
    
    Returns:
    
    List of repository items
  - setManualAdjustments
```
void setManualAdjustments(java.util.List pManualAdjustments)
```
  - getQuoteInfo
```
RepositoryItem getQuoteInfo()
```
    Returns the quote info repository item for the order
    
    Returns:
    
    the quote info repository item for the order
  - setQuoteInfo
```
void setQuoteInfo(RepositoryItem pQuoteInfo)
```
    Sets the quote info repository item for the order
    
    Parameters:
    
    pQuoteInfo - - the quote info repository item for the order
  - getActiveQuoteOrderId
```
java.lang.String getActiveQuoteOrderId()
```
    Returns activeQuoteOrderId
    
    Returns:
    
    activeQuoteOrderId
  - setActiveQuoteOrderId
```
void setActiveQuoteOrderId(java.lang.String pActiveQuoteOrderId)
```
    Sets activeQuoteOrderId
    
    Parameters:
    
    pActiveQuoteOrderId -
  - getAgentId
```
java.lang.String getAgentId()
```
    Returns agentId
    
    Returns:
    
    agentId
  - setAgentId
```
void setAgentId(java.lang.String pAgentId)
```
    Sets agentId
    
    Parameters:
    
    pAgentId -
  - getSalesChannel
```
java.lang.String getSalesChannel()
```
    Returns salesChannel
    
    Returns:
    
    salesChannel
  - setSalesChannel
```
void setSalesChannel(java.lang.String pSalesChannel)
```
    Sets salesChannel
    
    Parameters:
    
    pSalesChannel -
  - getCreationSiteId
```
java.lang.String getCreationSiteId()
```
    Returns the ID of the site on which this order was created
    
    Returns:
    
    creation site ID
  - setCreationSiteId
```
void setCreationSiteId(java.lang.String pCreationSiteId)
```
    Sets the ID of the site on which this order was created
    
    Parameters:
    
    pCreationSiteId - a site ID
  - getSiteId
```
java.lang.String getSiteId()
```
    Returns the ID of the site associated with this order
    
    Returns:
    
    site ID
  - setSiteId
```
void setSiteId(java.lang.String pSiteId)
```
    Sets the ID of the site on which this order was submitted
    
    Parameters:
    
    pSiteId - a site ID
  - getApproverIds
```
java.util.List getApproverIds()
```
    Returns the approverIds
  - setApproverIds
```
void setApproverIds(java.util.List pApproverIds)
```
    Sets the approverIds
  - getAuthorizedApproverIds
```
java.util.List getAuthorizedApproverIds()
```
    Returns the authorizedApproverIds
  - setAuthorizedApproverIds
```
void setAuthorizedApproverIds(java.util.List pAuthorizedApproverIds)
```
    Sets the authorizedApproverIds
  - getApprovalSystemMessages
```
java.util.List getApprovalSystemMessages()
```
    Returns the approvalSystemMessages
  - setApprovalSystemMessages
```
void setApprovalSystemMessages(java.util.List pApprovalSystemMessages)
```
    Sets the approvalSystemMessages
  - getApproverMessages
```
java.util.List getApproverMessages()
```
    Returns the approverMessages
  - setApproverMessages
```
void setApproverMessages(java.util.List pApproverMessages)
```
    Sets the approverMessages
  - getOrganizationId
```
java.lang.String getOrganizationId()
```
    Returns the RepositoryId of the organization which this Order belongs to.
  - setOrganizationId
```
void setOrganizationId(java.lang.String pOrganizationId)
```
    Sets the RepositoryId of the organization which this Order belongs to.
    
    Parameters:
    
    pOrganizationId - the RepositoryId of the organization which this Order belongs to.
  - getConfiguratorId
```
java.lang.String getConfiguratorId()
```
    Returns the ID for this order in an external Configurator system
  - setConfiguratorId
```
void setConfiguratorId(java.lang.String pConfiguratorId)
```
    Sets the Configurator ID for this order
    
    Parameters:
    
    pConfiguratorId - the ID of the order in an external Configurator system
  - getStateAsString
```
default java.lang.String getStateAsString()
```
    Returns an UNSET state for a class that has no custom implementation.
    
    Returns:
    
    the state

Interface Order

Field Summary

Method Summary

Methods inherited from interface atg.commerce.order.CommerceItemContainer

Methods inherited from interface atg.commerce.order.ShippingGroupContainer

Methods inherited from interface atg.commerce.order.PaymentGroupContainer

Methods inherited from interface atg.commerce.order.RelationshipContainer

Methods inherited from interface atg.commerce.order.PaymentGroupRelationshipContainer

Methods inherited from interface atg.commerce.order.CostCenterContainer

Methods inherited from interface atg.commerce.order.CostCenterRelationshipContainer

Methods inherited from interface atg.commerce.order.CommerceIdentifier

Field Detail

CLASS_VERSION

Method Detail

getOrderClassType

setOrderClassType

getProfileId

setProfileId

getDescription

setDescription

getState

setState

getStateDetail

setStateDetail

getPriceInfo

setPriceInfo

getTaxPriceInfo

setTaxPriceInfo

getCreatedByOrderId

setCreatedByOrderId

getRelatedOrders

addOrderIdToRelatedOrders

getSubmittedDate

setSubmittedTime

getSubmittedTime

getCreationDate

setCreationTime

getCreationTime

getLastModifiedDate

setLastModifiedTime

getLastModifiedTime

getCompletedDate

setCompletedTime

getCompletedTime

isTransient

setTransient

getSpecialInstructions

getTransientData

setOriginOfOrder

getOriginOfOrder

isChanged

equals

setExplicitlySaved

isExplicitlySaved

getManualAdjustments

setManualAdjustments

getQuoteInfo

setQuoteInfo

getActiveQuoteOrderId

setActiveQuoteOrderId

getAgentId

setAgentId

getSalesChannel

setSalesChannel

getCreationSiteId

setCreationSiteId

getSiteId

setSiteId

getApproverIds

setApproverIds

getAuthorizedApproverIds

setAuthorizedApproverIds

getApprovalSystemMessages

setApprovalSystemMessages

getApproverMessages

setApproverMessages

getOrganizationId

setOrganizationId

getConfiguratorId

setConfiguratorId