atg.commerce.order
Interface ShippingGroup

All Superinterfaces:
CommerceIdentifier, CommerceItemRelationshipContainer, HandlingInstructionContainer, PaymentGroupRelationshipContainer, java.io.Serializable
All Known Subinterfaces:
B2BShippingGroup
All Known Implementing Classes:
B2BHardgoodShippingGroup, B2BShippingGroupImpl, ElectronicShippingGroup, HardgoodShippingGroup, ShippingGroupImpl

public interface ShippingGroup
extends HandlingInstructionContainer, CommerceItemRelationshipContainer, PaymentGroupRelationshipContainer, CommerceIdentifier, java.io.Serializable

This interface represents all the information which designates a shipment. This could include traditional shipping by a carrier, or electronic shipping.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Method Summary
 java.util.Date getActualShipDate()
          Returns the actualShipDate.
 java.lang.String getDescription()
          Returns the description
 ShippingPriceInfo getPriceInfo()
          returns the ShippingPriceInfo object.
 java.util.Date getShipOnDate()
          Returns the shipOnDate.
 java.lang.String getShippingGroupClassType()
          Returns the ShippingGroupClassType
 java.lang.String getShippingMethod()
          Returns the shippingMethod
 java.util.Map getSpecialInstructions()
          Returns the specialInstructions
 int getState()
          returns the ShippingGroup state.
 java.lang.String getStateDetail()
          returns the ShippingGroup state details.
 java.util.Date getSubmittedDate()
          Returns the submittedDate.
 void setActualShipDate(java.util.Date pActualShipDate)
          Sets the actualShipDate
 void setDescription(java.lang.String pDescription)
          Sets the description
 void setPriceInfo(ShippingPriceInfo pInfo)
          sets the ShippingPriceInfo object.
 void setShipOnDate(java.util.Date pShipOnDate)
          Sets the shipOnDate
 void setShippingGroupClassType(java.lang.String pShippingGroupClassType)
          Sets the ShippingGroupClassType
 void setShippingMethod(java.lang.String pShippingMethod)
          Sets the shippingMethod
 void setState(int pState)
          sets the ShippingGroup state.
 void setStateDetail(java.lang.String pStateDetail)
          sets the ShippingGroup state details.
 void setSubmittedDate(java.util.Date pSubmittedDate)
          Sets the submittedDate.
 
Methods inherited from interface atg.commerce.order.HandlingInstructionContainer
addHandlingInstruction, addHandlingInstruction, getHandlingInstruction, getHandlingInstructionCount, getHandlingInstructions, removeAllHandlingInstructions, removeHandlingInstruction
 
Methods inherited from interface atg.commerce.order.CommerceItemRelationshipContainer
addCommerceItemRelationship, addCommerceItemRelationship, getCommerceItemRelationship, getCommerceItemRelationshipCount, getCommerceItemRelationships, removeAllCommerceItemRelationships, removeCommerceItemRelationship
 
Methods inherited from interface atg.commerce.order.PaymentGroupRelationshipContainer
addPaymentGroupRelationship, addPaymentGroupRelationship, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, removeAllPaymentGroupRelationships, removePaymentGroupRelationship
 
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

getShippingGroupClassType

java.lang.String getShippingGroupClassType()
Returns the ShippingGroupClassType


setShippingGroupClassType

void setShippingGroupClassType(java.lang.String pShippingGroupClassType)
Sets the ShippingGroupClassType


getShippingMethod

java.lang.String getShippingMethod()
Returns the shippingMethod


setShippingMethod

void setShippingMethod(java.lang.String pShippingMethod)
Sets the shippingMethod


getDescription

java.lang.String getDescription()
Returns the description


setDescription

void setDescription(java.lang.String pDescription)
Sets the description


getShipOnDate

java.util.Date getShipOnDate()
Returns the shipOnDate. This is the date the user chooses to have the ShippingGroup shipped.


setShipOnDate

void setShipOnDate(java.util.Date pShipOnDate)
Sets the shipOnDate


getActualShipDate

java.util.Date getActualShipDate()
Returns the actualShipDate. This is the date that the ShippingGroup was actually shipped.


setActualShipDate

void setActualShipDate(java.util.Date pActualShipDate)
Sets the actualShipDate


getState

int getState()
returns the ShippingGroup state.


setState

void setState(int pState)
sets the ShippingGroup state.

Parameters:
pState - the state to set

getStateDetail

java.lang.String getStateDetail()
returns the ShippingGroup state details.


setStateDetail

void setStateDetail(java.lang.String pStateDetail)
sets the ShippingGroup state details.

Parameters:
pStateDetail - the state detail to set.

getPriceInfo

ShippingPriceInfo getPriceInfo()
returns the ShippingPriceInfo object.


setPriceInfo

void setPriceInfo(ShippingPriceInfo pInfo)
sets the ShippingPriceInfo object.

Parameters:
pInfo - the ShippingPriceInfo to set

getSubmittedDate

java.util.Date getSubmittedDate()
Returns the submittedDate. This is the time that fulfillment begins for the ShippingGroup.


setSubmittedDate

void setSubmittedDate(java.util.Date pSubmittedDate)
Sets the submittedDate. This is the time that fulfillment begins for the ShippingGroup.


getSpecialInstructions

java.util.Map getSpecialInstructions()
Returns the specialInstructions