com.beasys.commerce.ebusiness.shipping
Interface ShippingMethod

public interface ShippingMethod

extends Entity

A shipping method is a mechanism by which product is delivered. It stores a standard set of attributes and allows for complex shipping cost calculation.

 Primary Key = com.beasys.commerce.ebusiness.shipping.ShippingMethodPk
 

A key that uniquely identifies this shipping method.

• Containment: By Value
• Multiplicity: 1:1
• PRIMARY KEY FIELD

Attribute: sizeLimit The maximum deliverable quantity.

• Containment: By Value
• Multiplicity: 1:1

Attribute: description An textual description of this shipping mechanism.

• Containment: By Value
• Multiplicity: 1:1

Attribute: signatureRequired True if the customer is required to acknowled delivery with a signature.

• Containment: By Value
• Multiplicity: 1:1

Attribute: weightLimit The maximum weight limit for this shipping mechanism.

• Containment: By Value
• Multiplicity: 1:1

Attribute: percentage Used when the shipping cost is a percentage of the total value of the order.

• Containment: By Value
• Multiplicity: 1:1

Attribute: poBoxAllowed True if this mechanism will allow delivery to a post office box.

• Containment: By Value
• Multiplicity: 1:1

Attribute: restrictions A description of any restrictions that apply to this shipping mechanism.

• Containment: By Value
• Multiplicity: 1:1

Attribute: averageShippingTime The average delivery time.

• Containment: By Value
• Multiplicity: 1:1

Attribute: carrier The service provider used for delivery.

• Containment: By Value
• Multiplicity: 1:1

Attribute: saturdayDelivery True if ths shipping mechanism will deliver on a Saturday.

• Containment: By Value
• Multiplicity: 1:1

Attribute: price The base shipping cost.

• Containment: By Value
• Multiplicity: 1:1

Attribute: packagingType

• Containment: By Value
• Multiplicity: 1:1

Attribute: costCalculationMechanism Used to specify one of the pre-programmed shipping cost calculation mechanisms. * Policy:Uses the Shipping Cost Calculation Policy to determine the total cost. * FlatRate: A single flat rate price is returned as specified in the price field. * PerItem: The count of items in the order is multiplied by the price field to determine the shipping cost. * Percentage: The total cost of the order is multiplied by the percenate specified to determine the cost.

• Containment: By Value
• Multiplicity: 1:1

Attribute: method The mechanism by which the item will be shipped. These include Air, Ship, Truck, etc..

• Containment: By Value
• Multiplicity: 1:1

Attribute: internationalDelivery True if this mechanism will deliver internationally.

• Containment: By Value
• Multiplicity: 1:1

See Also:

ShippingMethodPk, ShippingMethodHome, ShippingMethodImpl, ShippingMethodValue

Method Summary

int	getAverageShippingTime() Get the value of averageShippingTime
java.lang.String	getCarrier() Get the value of carrier
java.lang.String	getCostCalculationMechanism() Get the value of costCalculationMechanism
java.lang.String	getDescription() Get the value of description
java.lang.String	getIdentifier()
boolean	getInternationalDelivery() Get the value of internationalDelivery
java.lang.String	getMethod() Get the value of method
java.lang.String	getPackagingType() Get the value of packagingType
double	getPercentage() Get the value of percentage
boolean	getPoBoxAllowed() Get the value of poBoxAllowed
Money	getPrice() Get the value of price
java.lang.String	getRestrictions() Get the value of restrictions
boolean	getSaturdayDelivery() Get the value of saturdayDelivery
ShippingMethodValue	getShippingMethodByValue() Get all of ShippingMethod's attributes.
boolean	getSignatureRequired() Get the value of signatureRequired
double	getSizeLimit() Get the value of sizeLimit
double	getWeightLimit() Get the value of weightLimit
void	setAverageShippingTime(int averageShippingTime) Set the value of averageShippingTime
void	setCarrier(java.lang.String carrier) Set the value of carrier
void	setCostCalculationMechanism(java.lang.String costCalculationMechanism) Set the value of costCalculationMechanism
void	setDescription(java.lang.String description) Set the value of description
void	setInternationalDelivery(boolean internationalDelivery) Set the value of internationalDelivery
void	setMethod(java.lang.String method) Set the value of method
void	setPackagingType(java.lang.String packagingType) Set the value of packagingType
void	setPercentage(double percentage) Set the value of percentage
void	setPoBoxAllowed(boolean poBoxAllowed) Set the value of poBoxAllowed
void	setPrice(Money price) Set the value of price
void	setRestrictions(java.lang.String restrictions) Set the value of restrictions
void	setSaturdayDelivery(boolean saturdayDelivery) Set the value of saturdayDelivery
void	setShippingMethodByValue(ShippingMethodValue value) Set all of ShippingMethod's attributes to the passed in value.
void	setSignatureRequired(boolean signatureRequired) Set the value of signatureRequired
void	setSizeLimit(double sizeLimit) Set the value of sizeLimit
void	setWeightLimit(double weightLimit) Set the value of weightLimit

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Methods inherited from interface com.beasys.commerce.foundation.RemoteRelationalReference

get__classIdentifier, get__containingBelonging, get__containingEntity, get__mapKey, get__sequenceNumber, set__containingBelonging, set__containingEntity, set__mapKey

Method Detail

getShippingMethodByValue

public ShippingMethodValue getShippingMethodByValue()
                                             throws java.rmi.RemoteException

Get all of ShippingMethod's attributes.

Returns:

ShippingMethodValue the ShippingMethod value object

setShippingMethodByValue

public void setShippingMethodByValue(ShippingMethodValue value)
                              throws java.rmi.RemoteException

Set all of ShippingMethod's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters:

ShippingMethodValue - the ShippingMethod value object

getIdentifier

public java.lang.String getIdentifier()
                               throws java.rmi.RemoteException

getSizeLimit

public double getSizeLimit()
                    throws java.rmi.RemoteException

Get the value of sizeLimit

Returns:

sizeLimit.

setSizeLimit

public void setSizeLimit(double sizeLimit)
                  throws java.rmi.RemoteException

Set the value of sizeLimit

Parameters:

sizeLimit - sizeLimit to be added

getDescription

public java.lang.String getDescription()
                                throws java.rmi.RemoteException

Get the value of description

Returns:

description.

setDescription

public void setDescription(java.lang.String description)
                    throws java.rmi.RemoteException

Set the value of description

Parameters:

description - description to be added

getSignatureRequired

public boolean getSignatureRequired()
                             throws java.rmi.RemoteException

Get the value of signatureRequired

Returns:

signatureRequired.

setSignatureRequired

public void setSignatureRequired(boolean signatureRequired)
                          throws java.rmi.RemoteException

Set the value of signatureRequired

Parameters:

signatureRequired - signatureRequired to be added

getWeightLimit

public double getWeightLimit()
                      throws java.rmi.RemoteException

Get the value of weightLimit

Returns:

weightLimit.

setWeightLimit

public void setWeightLimit(double weightLimit)
                    throws java.rmi.RemoteException

Set the value of weightLimit

Parameters:

weightLimit - weightLimit to be added

getPercentage

public double getPercentage()
                     throws java.rmi.RemoteException

Get the value of percentage

Returns:

percentage.

setPercentage

public void setPercentage(double percentage)
                   throws java.rmi.RemoteException

Set the value of percentage

Parameters:

percentage - percentage to be added

getPoBoxAllowed

public boolean getPoBoxAllowed()
                        throws java.rmi.RemoteException

Get the value of poBoxAllowed

Returns:

poBoxAllowed.

setPoBoxAllowed

public void setPoBoxAllowed(boolean poBoxAllowed)
                     throws java.rmi.RemoteException

Set the value of poBoxAllowed

Parameters:

poBoxAllowed - poBoxAllowed to be added

getRestrictions

public java.lang.String getRestrictions()
                                 throws java.rmi.RemoteException

Get the value of restrictions

Returns:

restrictions.

setRestrictions

public void setRestrictions(java.lang.String restrictions)
                     throws java.rmi.RemoteException

Set the value of restrictions

Parameters:

restrictions - restrictions to be added

getAverageShippingTime

public int getAverageShippingTime()
                           throws java.rmi.RemoteException

Get the value of averageShippingTime

Returns:

averageShippingTime.

setAverageShippingTime

public void setAverageShippingTime(int averageShippingTime)
                            throws java.rmi.RemoteException

Set the value of averageShippingTime

Parameters:

averageShippingTime - averageShippingTime to be added

getCarrier

public java.lang.String getCarrier()
                            throws java.rmi.RemoteException

Get the value of carrier

Returns:

carrier.

setCarrier

public void setCarrier(java.lang.String carrier)
                throws java.rmi.RemoteException

Set the value of carrier

Parameters:

carrier - carrier to be added

getSaturdayDelivery

public boolean getSaturdayDelivery()
                            throws java.rmi.RemoteException

Get the value of saturdayDelivery

Returns:

saturdayDelivery.

setSaturdayDelivery

public void setSaturdayDelivery(boolean saturdayDelivery)
                         throws java.rmi.RemoteException

Set the value of saturdayDelivery

Parameters:

saturdayDelivery - saturdayDelivery to be added

getPrice

public Money getPrice()
               throws java.rmi.RemoteException

Get the value of price

Returns:

price.

setPrice

public void setPrice(Money price)
              throws java.rmi.RemoteException

Set the value of price

Parameters:

price - price to be added

getPackagingType

public java.lang.String getPackagingType()
                                  throws java.rmi.RemoteException

Get the value of packagingType

Returns:

packagingType.

setPackagingType

public void setPackagingType(java.lang.String packagingType)
                      throws java.rmi.RemoteException

Set the value of packagingType

Parameters:

packagingType - packagingType to be added

getCostCalculationMechanism

public java.lang.String getCostCalculationMechanism()
                                             throws java.rmi.RemoteException

Get the value of costCalculationMechanism

Returns:

costCalculationMechanism.

setCostCalculationMechanism

public void setCostCalculationMechanism(java.lang.String costCalculationMechanism)
                                 throws java.rmi.RemoteException

Set the value of costCalculationMechanism

Parameters:

costCalculationMechanism - costCalculationMechanism to be added

getMethod

public java.lang.String getMethod()
                           throws java.rmi.RemoteException

Get the value of method

Returns:

method.

setMethod

public void setMethod(java.lang.String method)
               throws java.rmi.RemoteException

Set the value of method

Parameters:

method - method to be added

getInternationalDelivery

public boolean getInternationalDelivery()
                                 throws java.rmi.RemoteException

Get the value of internationalDelivery

Returns:

internationalDelivery.

setInternationalDelivery

public void setInternationalDelivery(boolean internationalDelivery)
                              throws java.rmi.RemoteException

Set the value of internationalDelivery

Parameters:

internationalDelivery - internationalDelivery to be added