|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.commerce.order.CommerceIdentifierImpl atg.commerce.order.ShippingGroupImpl
public class ShippingGroupImpl
This class is an implementation of a ShippingGroup. It represents all the information which designates a shipment. Examples would be HardgoodShippingGroup and ElectronicShippingGroup. This could include traditional shipping by a carrier, or electronic shipping. This class is not meant to be used directly because it does not contain any properties which are specific to any particular kind of payment. Rather a subclass such as HardgoodShippingGroup or ElectronicShippingGroup should be used.
HardgoodShippingGroup
,
ElectronicShippingGroup
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected static java.util.ResourceBundle |
sResourceBundle
Resource Bundle |
Constructor Summary | |
---|---|
ShippingGroupImpl()
|
Method Summary | |
---|---|
void |
addChangedProperty(java.lang.String pPropertyName)
Adds a changedProperty |
void |
addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship)
Add the CommerceItemRelationship to the container. |
void |
addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship,
int pIndex)
Add the CommerceItemRelationship to the container at the given index. |
void |
addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship)
Add the CostCenterRelationship to the container. |
void |
addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship,
int pIndex)
Add the CostCenterRelationship to the container at the given index. |
void |
addHandlingInstruction(HandlingInstruction pHandlingInstruction)
Add the HandlingInstruction to the container. |
void |
addHandlingInstruction(HandlingInstruction pHandlingInstruction,
int pIndex)
Add the HandlingInstruction to the container at the given index. |
void |
addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship)
Add the PaymentGroupRelationship to the container. |
void |
addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship,
int pIndex)
Add the PaymentGroupRelationship to the container at the given index. |
boolean |
arePropertiesEmpty(java.util.Collection<java.lang.String> pPropertiesToCheck)
Query whether the ShippingGroup object is empty. |
void |
clearChangedProperties()
Clears the changedProperties List |
void |
copyProperties(ShippingGroup pSrcShippingGroup,
java.util.Collection<java.lang.String> pPropertiesToCopy)
Copy the shipping group information from the source shipping group to itself. |
boolean |
doPropertiesMatch(ShippingGroup pShippingGroupToMatchAgainst,
java.util.List<java.lang.String> pPropertiesToMatch)
Is the shipping group passed in matches against the current instance? This method compares the current shipping group instance against the shipping group that is being passed in. |
java.util.Date |
getActualShipDate()
Returns property actualShipDate. |
java.util.Set |
getChangedProperties()
Returns the changedProperties |
CommerceItemRelationship |
getCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId)
Returns the CommerceItemRelationship whose id is pCommerceItemRelationshipId. |
int |
getCommerceItemRelationshipCount()
Returns the number of CommerceItemRelationships in the container. |
java.util.List |
getCommerceItemRelationships()
Returns a List of CommerceItemRelationships |
CostCenterRelationship |
getCostCenterRelationship(java.lang.String pCostCenterRelationshipId)
Returns the CostCenterRelationship whose id is pCostCenterRelationshipId. |
int |
getCostCenterRelationshipCount()
Returns the number of CostCenterRelationships in the container. |
java.util.List |
getCostCenterRelationships()
Returns a List of CostCenterRelationships |
java.lang.String |
getDescription()
Returns the description |
HandlingInstruction |
getHandlingInstruction(java.lang.String pHandlingInstructionId)
Returns the HandlingInstruction whose id is pHandlingInstructionId. |
int |
getHandlingInstructionCount()
Returns the number of HandlingInstructions in the container. |
java.util.List |
getHandlingInstructions()
Returns a List of HandlingInstructions |
PaymentGroupRelationship |
getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
Returns the PaymentGroupRelationship whose id is pPaymentGroupRelationshipId. |
int |
getPaymentGroupRelationshipCount()
Returns the number of PaymentGroupRelationships in the container. |
java.util.List |
getPaymentGroupRelationships()
Returns a List of PaymentGroupRelationships |
ShippingPriceInfo |
getPriceInfo()
returns the ShippingPriceInfo object. |
MutableRepositoryItem |
getPriceInfoRepositoryItem()
Returns the priceInfoRepositoryItem |
java.lang.Object |
getPropertyValue(java.lang.String pPropertyName)
Returns a property value. |
MutableRepositoryItem |
getRepositoryItem()
Returns the repositoryItem |
boolean |
getSaveAllProperties()
Returns the saveAllProperties |
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 |
getStateAsString()
returns the ShippingGroup state as a String. |
java.lang.String |
getStateAsUserResource()
returns the ShippingGroup state as a user resource |
java.lang.String |
getStateDetail()
returns the ShippingGroup state details. |
java.util.Date |
getSubmittedDate()
Returns the submittedDate |
boolean |
isChanged()
Returns the isChanged flag |
void |
removeAllCommerceItemRelationships()
Removes all the CommerceItemRelationships |
void |
removeAllCostCenterRelationships()
Removes all the CostCenterRelationships |
void |
removeAllHandlingInstructions()
Removes all the HandlingInstructions in the container. |
void |
removeAllPaymentGroupRelationships()
Removes all the PaymentGroupRelationships |
CommerceItemRelationship |
removeCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId)
Removes a CommerceItemRelationship whose id is passed in. |
CostCenterRelationship |
removeCostCenterRelationship(java.lang.String pCostCenterRelationshipId)
Removes a CostCenterRelationship whose id is passed in. |
HandlingInstruction |
removeHandlingInstruction(java.lang.String pHandlingInstructionId)
Removes a HandlingInstruction whose id is passed in. |
PaymentGroupRelationship |
removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
Removes a PaymentGroupRelationship whose id is passed in. |
void |
setActualShipDate(java.util.Date pActualShipDate)
Sets property actualShipDate |
void |
setChanged(boolean pChanged)
Marks this object as changed |
void |
setDescription(java.lang.String pDescription)
Sets the description |
void |
setPriceInfo(ShippingPriceInfo pInfo)
sets the ShippingPriceInfo object. |
void |
setPriceInfoRepositoryItem(MutableRepositoryItem pPriceInfoRepositoryItem)
Sets the priceInfoRepositoryItem |
void |
setPropertyValue(java.lang.String pPropertyName,
java.lang.Object pPropertyValue)
Sets a property value. |
void |
setRepositoryItem(MutableRepositoryItem pRepositoryItem)
Sets the repositoryItem |
void |
setSaveAllProperties(boolean pSaveAllProperties)
Sets the saveAllProperties |
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 |
setSpecialInstructions(java.util.Map pSpecialInstructions)
Sets the specialInstructions |
void |
setState(int pState)
sets the ShippingGroup state. |
void |
setStateAsString(java.lang.String pState)
sets the ShippingGroup state as a string. |
void |
setStateDetail(java.lang.String pStateDetail)
sets the ShippingGroup state details. |
void |
setSubmittedDate(java.util.Date pSubmittedDate)
Sets the submittedDate |
java.lang.String |
toString()
returns a string representation of this object |
void |
update(java.util.Observable o,
java.lang.Object arg)
This method is called whenever a property in a contained object changes and the containing object needs to be notified. |
Methods inherited from class atg.commerce.order.CommerceIdentifierImpl |
---|
getId, setId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface atg.commerce.order.CommerceIdentifier |
---|
getId |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected static java.util.ResourceBundle sResourceBundle
Constructor Detail |
---|
public ShippingGroupImpl()
Method Detail |
---|
public java.lang.String getShippingGroupClassType()
getShippingGroupClassType
in interface ShippingGroup
public void setShippingGroupClassType(java.lang.String pShippingGroupClassType)
setShippingGroupClassType
in interface ShippingGroup
public java.lang.String getShippingMethod()
getShippingMethod
in interface ShippingGroup
public void setShippingMethod(java.lang.String pShippingMethod)
setShippingMethod
in interface ShippingGroup
public java.lang.String getDescription()
getDescription
in interface ShippingGroup
public void setDescription(java.lang.String pDescription)
setDescription
in interface ShippingGroup
public int getState()
getState
in interface ShippingGroup
public void setState(int pState)
setState
in interface ShippingGroup
pState
- the state to setpublic java.lang.String getStateAsString()
public void setStateAsString(java.lang.String pState)
pState
- the state to setpublic java.lang.String getStateAsUserResource()
public java.lang.String getStateDetail()
getStateDetail
in interface ShippingGroup
public void setStateDetail(java.lang.String pStateDetail)
setStateDetail
in interface ShippingGroup
pStateDetail
- the stateDetail to setpublic ShippingPriceInfo getPriceInfo()
getPriceInfo
in interface ShippingGroup
public void setPriceInfo(ShippingPriceInfo pInfo)
setPriceInfo
in interface ShippingGroup
pInfo
- the ShippingPriceInfo to setpublic MutableRepositoryItem getPriceInfoRepositoryItem()
public void setPriceInfoRepositoryItem(MutableRepositoryItem pPriceInfoRepositoryItem)
public java.util.Date getShipOnDate()
getShipOnDate
in interface ShippingGroup
public void setShipOnDate(java.util.Date pShipOnDate)
setShipOnDate
in interface ShippingGroup
public java.util.Date getActualShipDate()
getActualShipDate
in interface ShippingGroup
public void setActualShipDate(java.util.Date pActualShipDate)
setActualShipDate
in interface ShippingGroup
pActualShipDate
- the value to set for property actualShipDatepublic java.util.Date getSubmittedDate()
getSubmittedDate
in interface ShippingGroup
public void setSubmittedDate(java.util.Date pSubmittedDate)
setSubmittedDate
in interface ShippingGroup
public java.util.Map getSpecialInstructions()
getSpecialInstructions
in interface ShippingGroup
public void setSpecialInstructions(java.util.Map pSpecialInstructions)
public java.util.List getCommerceItemRelationships()
getCommerceItemRelationships
in interface CommerceItemRelationshipContainer
public void addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship) throws DuplicateRelationshipException, InvalidParameterException
addCommerceItemRelationship
in interface CommerceItemRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public void addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship, int pIndex) throws DuplicateRelationshipException, InvalidParameterException
addCommerceItemRelationship
in interface CommerceItemRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public CommerceItemRelationship removeCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
removeCommerceItemRelationship
in interface CommerceItemRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public void removeAllCommerceItemRelationships()
removeAllCommerceItemRelationships
in interface CommerceItemRelationshipContainer
public CommerceItemRelationship getCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
getCommerceItemRelationship
in interface CommerceItemRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public int getCommerceItemRelationshipCount()
getCommerceItemRelationshipCount
in interface CommerceItemRelationshipContainer
public java.util.List getPaymentGroupRelationships()
getPaymentGroupRelationships
in interface PaymentGroupRelationshipContainer
public void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship) throws DuplicateRelationshipException, InvalidParameterException
addPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship, int pIndex) throws DuplicateRelationshipException, InvalidParameterException
addPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public PaymentGroupRelationship removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
removePaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public void removeAllPaymentGroupRelationships()
removeAllPaymentGroupRelationships
in interface PaymentGroupRelationshipContainer
public PaymentGroupRelationship getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
getPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public int getPaymentGroupRelationshipCount()
getPaymentGroupRelationshipCount
in interface PaymentGroupRelationshipContainer
public java.util.List getHandlingInstructions()
getHandlingInstructions
in interface HandlingInstructionContainer
public void addHandlingInstruction(HandlingInstruction pHandlingInstruction) throws DuplicateHandlingInstructionException, InvalidParameterException
addHandlingInstruction
in interface HandlingInstructionContainer
DuplicateHandlingInstructionException
InvalidParameterException
public void addHandlingInstruction(HandlingInstruction pHandlingInstruction, int pIndex) throws DuplicateHandlingInstructionException, InvalidParameterException
addHandlingInstruction
in interface HandlingInstructionContainer
DuplicateHandlingInstructionException
InvalidParameterException
public HandlingInstruction removeHandlingInstruction(java.lang.String pHandlingInstructionId) throws HandlingInstructionNotFoundException, InvalidParameterException
removeHandlingInstruction
in interface HandlingInstructionContainer
HandlingInstructionNotFoundException
InvalidParameterException
public void removeAllHandlingInstructions()
removeAllHandlingInstructions
in interface HandlingInstructionContainer
public HandlingInstruction getHandlingInstruction(java.lang.String pHandlingInstructionId) throws HandlingInstructionNotFoundException, InvalidParameterException
getHandlingInstruction
in interface HandlingInstructionContainer
HandlingInstructionNotFoundException
InvalidParameterException
public int getHandlingInstructionCount()
getHandlingInstructionCount
in interface HandlingInstructionContainer
public java.util.List getCostCenterRelationships()
getCostCenterRelationships
in interface CostCenterRelationshipContainer
public void addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship) throws DuplicateRelationshipException, InvalidParameterException
addCostCenterRelationship
in interface CostCenterRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public void addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship, int pIndex) throws DuplicateRelationshipException, InvalidParameterException
addCostCenterRelationship
in interface CostCenterRelationshipContainer
DuplicateRelationshipException
InvalidParameterException
public CostCenterRelationship removeCostCenterRelationship(java.lang.String pCostCenterRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
removeCostCenterRelationship
in interface CostCenterRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public void removeAllCostCenterRelationships()
removeAllCostCenterRelationships
in interface CostCenterRelationshipContainer
public CostCenterRelationship getCostCenterRelationship(java.lang.String pCostCenterRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
getCostCenterRelationship
in interface CostCenterRelationshipContainer
RelationshipNotFoundException
InvalidParameterException
public int getCostCenterRelationshipCount()
getCostCenterRelationshipCount
in interface CostCenterRelationshipContainer
public void update(java.util.Observable o, java.lang.Object arg)
update
in interface java.util.Observer
o
- the object which changedarg
- the name of the property which changedpublic boolean getSaveAllProperties()
getSaveAllProperties
in interface ChangedProperties
public void setSaveAllProperties(boolean pSaveAllProperties)
setSaveAllProperties
in interface ChangedProperties
public boolean isChanged()
isChanged
in interface ChangedProperties
public void setChanged(boolean pChanged)
setChanged
in interface ChangedProperties
public java.util.Set getChangedProperties()
getChangedProperties
in interface ChangedProperties
public void addChangedProperty(java.lang.String pPropertyName)
addChangedProperty
in interface ChangedProperties
public void clearChangedProperties()
clearChangedProperties
in interface ChangedProperties
public MutableRepositoryItem getRepositoryItem()
getRepositoryItem
in interface ChangedProperties
public void setRepositoryItem(MutableRepositoryItem pRepositoryItem)
setRepositoryItem
in interface ChangedProperties
public java.lang.Object getPropertyValue(java.lang.String pPropertyName)
getPropertyValue
in interface ChangedProperties
java.lang.IllegalStateException
- If the repository item wrapped by this implementation is null.public void setPropertyValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue)
setPropertyValue
in interface ChangedProperties
pPropertyValue
- the value to set for the given property value
java.lang.IllegalStateException
- If the repository item wrapped by this implementation is null.public java.lang.String toString()
toString
in class java.lang.Object
public boolean arePropertiesEmpty(java.util.Collection<java.lang.String> pPropertiesToCheck) throws CommerceException
If any of the list of properties provided in this method is not found, then this method throws an exception.
Also if any of the property is not empty, then this method considers the object as not empty.
pPropertiesToCheck
- -- The list of properties to check
pPropertiesToCheck
is null, false otherwise.
CommerceException
public void copyProperties(ShippingGroup pSrcShippingGroup, java.util.Collection<java.lang.String> pPropertiesToCopy) throws CommerceException
If any of the list of properties provided in this method is not found, then this method throws an exception.
pSrcShippingGroup
- -- The source shipping group from where the information to be copiedpPropertiesToCopy
- -- The list of properties to copy
CommerceException
public boolean doPropertiesMatch(ShippingGroup pShippingGroupToMatchAgainst, java.util.List<java.lang.String> pPropertiesToMatch) throws CommerceException
pShippingGroupToMatchAgainst
- -- The shipping group to be matched against the current instancepPropertiesToMatch
- -- The List of properties to be matched against
CommerceException
AddressTools#compareObjects(Object, Object, List, Set)}
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |