# com.beasys.commerce.ebusiness.shipping
ShippingMethod Interface

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 = 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

Related Topics

``ShippingMethodPk``
``ShippingMethodHome``
``ShippingMethodImpl``
``ShippingMethodValue``

All Superinterfaces
  `BusinessSmartComponent`, `EJBObject`, `Entity`, `Remote`, `RemoteRelationalReference`, `Serializable`

## Method Summary

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

Methods from interface `javax.ejb.`EJBObject``
`getEJBHome, getHandle, getPrimaryKey, isIdentical, remove`

Methods 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

### getAverageShippingTime() Method

    public int getAverageShippingTime()
         throws RemoteException

Get the value of averageShippingTime

#### Returns

averageShippingTime.

#### Exceptions

``RemoteException``

### getCarrier() Method

    public String getCarrier()
         throws RemoteException

Get the value of carrier

#### Returns

carrier.

#### Exceptions

``RemoteException``

### getCostCalculationMechanism() Method

    public String getCostCalculationMechanism()
         throws RemoteException

Get the value of costCalculationMechanism

#### Returns

costCalculationMechanism.

#### Exceptions

``RemoteException``

### getDescription() Method

    public String getDescription()
         throws RemoteException

Get the value of description

#### Returns

description.

#### Exceptions

``RemoteException``

### getIdentifier() Method

    public String getIdentifier()
         throws RemoteException

#### Exceptions

``RemoteException``

### getInternationalDelivery() Method

    public boolean getInternationalDelivery()
         throws RemoteException

Get the value of internationalDelivery

#### Returns

internationalDelivery.

#### Exceptions

``RemoteException``

### getMethod() Method

    public String getMethod()
         throws RemoteException

Get the value of method

#### Returns

method.

#### Exceptions

``RemoteException``

### getPackagingType() Method

    public String getPackagingType()
         throws RemoteException

Get the value of packagingType

#### Returns

packagingType.

#### Exceptions

``RemoteException``

### getPercentage() Method

    public double getPercentage()
         throws RemoteException

Get the value of percentage

#### Returns

percentage.

#### Exceptions

``RemoteException``

### getPoBoxAllowed() Method

    public boolean getPoBoxAllowed()
         throws RemoteException

Get the value of poBoxAllowed

#### Returns

poBoxAllowed.

#### Exceptions

``RemoteException``

### getPrice() Method

    public Money getPrice()
         throws RemoteException

Get the value of price

#### Returns

price.

#### Exceptions

``RemoteException``

### getRestrictions() Method

    public String getRestrictions()
         throws RemoteException

Get the value of restrictions

#### Returns

restrictions.

#### Exceptions

``RemoteException``

### getSaturdayDelivery() Method

    public boolean getSaturdayDelivery()
         throws RemoteException

Get the value of saturdayDelivery

#### Returns

saturdayDelivery.

#### Exceptions

``RemoteException``

### getShippingMethodByValue() Method

    public ShippingMethodValue getShippingMethodByValue()
         throws RemoteException

Get all of ShippingMethod's attributes.

#### Returns

ShippingMethodValue the ShippingMethod value object

#### Exceptions

``RemoteException``

### getSignatureRequired() Method

    public boolean getSignatureRequired()
         throws RemoteException

Get the value of signatureRequired

#### Returns

signatureRequired.

#### Exceptions

``RemoteException``

### getSizeLimit() Method

    public double getSizeLimit()
         throws RemoteException

Get the value of sizeLimit

#### Returns

sizeLimit.

#### Exceptions

``RemoteException``

### getWeightLimit() Method

    public double getWeightLimit()
         throws RemoteException

Get the value of weightLimit

#### Returns

weightLimit.

#### Exceptions

``RemoteException``

### setAverageShippingTime(int) Method

    public void setAverageShippingTime(int averageShippingTime)
         throws RemoteException

Set the value of averageShippingTime

#### Parameters

averageShippingTime
  averageShippingTime to be added

#### Exceptions

``RemoteException``

### setCarrier(String) Method

    public void setCarrier(String carrier)
         throws RemoteException

Set the value of carrier

#### Parameters

carrier
  carrier to be added

#### Exceptions

``RemoteException``

### setCostCalculationMechanism(String) Method

    public void setCostCalculationMechanism(String costCalculationMechanism)
         throws RemoteException

Set the value of costCalculationMechanism

#### Parameters

costCalculationMechanism
  costCalculationMechanism to be added

#### Exceptions

``RemoteException``

### setDescription(String) Method

    public void setDescription(String description)
         throws RemoteException

Set the value of description

#### Parameters

description
  description to be added

#### Exceptions

``RemoteException``

### setInternationalDelivery(boolean) Method

    public void setInternationalDelivery(boolean internationalDelivery)
         throws RemoteException

Set the value of internationalDelivery

#### Parameters

internationalDelivery
  internationalDelivery to be added

#### Exceptions

``RemoteException``

### setMethod(String) Method

    public void setMethod(String method)
         throws RemoteException

Set the value of method

#### Parameters

method
  method to be added

#### Exceptions

``RemoteException``

### setPackagingType(String) Method

    public void setPackagingType(String packagingType)
         throws RemoteException

Set the value of packagingType

#### Parameters

packagingType
  packagingType to be added

#### Exceptions

``RemoteException``

### setPercentage(double) Method

    public void setPercentage(double percentage)
         throws RemoteException

Set the value of percentage

#### Parameters

percentage
  percentage to be added

#### Exceptions

``RemoteException``

### setPoBoxAllowed(boolean) Method

    public void setPoBoxAllowed(boolean poBoxAllowed)
         throws RemoteException

Set the value of poBoxAllowed

#### Parameters

poBoxAllowed
  poBoxAllowed to be added

#### Exceptions

``RemoteException``

### setPrice(Money) Method

    public void setPrice(Money price)
         throws RemoteException

Set the value of price

#### Parameters

price
  price to be added

#### Exceptions

``RemoteException``

### setRestrictions(String) Method

    public void setRestrictions(String restrictions)
         throws RemoteException

Set the value of restrictions

#### Parameters

restrictions
  restrictions to be added

#### Exceptions

``RemoteException``

### setSaturdayDelivery(boolean) Method

    public void setSaturdayDelivery(boolean saturdayDelivery)
         throws RemoteException

Set the value of saturdayDelivery

#### Parameters

saturdayDelivery
  saturdayDelivery to be added

#### Exceptions

``RemoteException``

### setShippingMethodByValue(ShippingMethodValue) Method

    public void setShippingMethodByValue(ShippingMethodValue value)
         throws RemoteException

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

#### Parameters

value
  the ShippingMethod value object

#### Exceptions

``RemoteException``

### setSignatureRequired(boolean) Method

    public void setSignatureRequired(boolean signatureRequired)
         throws RemoteException

Set the value of signatureRequired

#### Parameters

signatureRequired
  signatureRequired to be added

#### Exceptions

``RemoteException``

### setSizeLimit(double) Method

    public void setSizeLimit(double sizeLimit)
         throws RemoteException

Set the value of sizeLimit

#### Parameters

sizeLimit
  sizeLimit to be added

#### Exceptions

``RemoteException``

### setWeightLimit(double) Method

    public void setWeightLimit(double weightLimit)
         throws RemoteException

Set the value of weightLimit

#### Parameters

weightLimit
  weightLimit to be added

#### Exceptions

``RemoteException``