# com.beasys.commerce.ebusiness.shipping
ShippingMethodImpl Class

public class ShippingMethodImpl
extends `EntityImpl`

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

Related Topics

``ShippingMethod``
``ShippingMethodHome``
``ShippingMethodValue``

Hierarchy
  `Object`
  `EntityImpl`
  `ShippingMethodImpl`

All Implemented Interfaces
  `EnterpriseBean`, `EntityBean`, `RelationalReference`, `Serializable`

## Field Summary

`public int` | `averageShippingTime` The average delivery time.
`public `String`` | `carrier` The service provider used for delivery.
`public `String`` | `costCalculationMechanism` Used to specify one of the pre-programmed shipping cost calculation mechanisms.
`public `String`` | `description` An textual description of this shipping mechanism.
`public `String`` | `identifier` A key that uniquely identifies this shipping method.
`public boolean` | `internationalDelivery` True if this mechanism will deliver internationally.
`public `String`` | `method` The mechanism by which the item will be shipped.
`public `String`` | `packagingType` Containment: By Value Multiplicity: 1:1
`public double` | `percentage` Used when the shipping cost is a percentage of the total value of the order.
`public boolean` | `poBoxAllowed` True if this mechanism will allow delivery to a post office box.
`public `Money`` | `price` The base shipping cost.
`public `String`` | `restrictions` A description of any restrictions that apply to this shipping mechanism.
`public boolean` | `saturdayDelivery` True if ths shipping mechanism will deliver on a Saturday.
`public boolean` | `signatureRequired` True if the customer is required to acknowled delivery with a signature.
`public double` | `sizeLimit` The maximum deliverable quantity.
`public double` | `weightLimit` The maximum weight limit for this shipping mechanism.

Fields from com.beasys.commerce.foundation`.`EntityImpl``
``__classIdentifier`, `__containingEntity`, `__mapKey`, `__sequenceNumber`, `_ctx`, `_environmentNamingContext`, `_environmentPropertyCache`, `_isDirty`, `_smartBMP``

## Constructor Summary

ShippingMethodImpl()

## Method Summary

`protected void` | `bscInitializeAttributes`(`ShippingMethodPk` shippingMethodPk)
`public void` | `ejbActivate`() ejbActivate method.
`public `ShippingMethodPk`` | `ejbCreate`(`ShippingMethodPk` shippingMethodPk)
`public `Enumeration`` | `ejbFindAll`() ejbFindAll method.
`public `ShippingMethodPk`` | `ejbFindByPrimaryKey`(`ShippingMethodPk` pk)
`public void` | `ejbLoad`() ejbLoad method.
`public void` | `ejbPassivate`() ejbPassivate method.
`public void` | `ejbPostCreate`(`ShippingMethodPk` shippingMethodPk)
`public void` | `ejbRemove`() ejbRemove method.
`public void` | `ejbStore`() ejbStore method.
`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` | `setEntityContext`(`EntityContext` ctx) setEntityContext method.
`public void` | `setIdentifier`(`String` value)
`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
`public void` | `unsetEntityContext`() unsetEntityContext method.

Methods from `com.beasys.commerce.foundation.`EntityImpl``
``bscInitializeAttributes`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `doRelationalBinding`, `doRelationalBinding`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `ejbCreate`, `ejbFindByPrimaryKey`, `ejbPostCreate`, `enumerateRelationalBinding`, `enumerateRelationalBinding`, `get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__containingEntityReference`, `get__mapKey`, `get__sequenceNumber`, `getEntityContext`, `getEnvironmentNamingContext`, `getEnvironmentProperty`, `getEnvironmentProperty`, `getEnvironmentPropertyCache`, `getPersistenceHelperPlugin`, `getSmartBMP`, `initSmartBMP`, `isModified`, `set__classIdentifier`, `set__containingBelonging`, `set__containingEntity`, `set__containingEntityReference`, `set__mapKey`,`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.ejb.`EntityBean``
`ejbActivate, ejbLoad, ejbPassivate, ejbRemove, ejbStore, setEntityContext, unsetEntityContext`

Methods from interface `com.beasys.commerce.foundation.`RelationalReference``
``get__classIdentifier`, `get__containingBelonging`, `get__containingEntity`, `get__mapKey`, `get__sequenceNumber`, `set__containingBelonging`, `set__containingEntity`, `set__mapKey``

## Field Detail

### averageShippingTime

    public int averageShippingTime

  The average delivery time.
  - Containment: By Value
  - Multiplicity: 1:1

### carrier

    public String carrier

  The service provider used for delivery.
  - Containment: By Value
  - Multiplicity: 1:1

### costCalculationMechanism

    public String 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

### description

    public String description

  An textual description of this shipping mechanism.
  - Containment: By Value
  - Multiplicity: 1:1

### identifier

    public String identifier

  A key that uniquely identifies this shipping method.
  - Containment: By Value
  - Multiplicity: 1:1
  - PRIMARY KEY FIELD

### internationalDelivery

    public boolean internationalDelivery

  True if this mechanism will deliver internationally.
  - Containment: By Value
  - Multiplicity: 1:1

### method

    public String method

  The mechanism by which the item will be shipped. These include Air, Ship, Truck, etc..
  - Containment: By Value
  - Multiplicity: 1:1

### packagingType

    public String packagingType

  - Containment: By Value
  - Multiplicity: 1:1

### percentage

    public double percentage

  Used when the shipping cost is a percentage of the total value of the order.
  - Containment: By Value
  - Multiplicity: 1:1

### poBoxAllowed

    public boolean poBoxAllowed

  True if this mechanism will allow delivery to a post office box.
  - Containment: By Value
  - Multiplicity: 1:1

### price

    public Money price

  The base shipping cost.
  - Containment: By Value
  - Multiplicity: 1:1

### restrictions

    public String restrictions

  A description of any restrictions that apply to this shipping mechanism.
  - Containment: By Value
  - Multiplicity: 1:1

### saturdayDelivery

    public boolean saturdayDelivery

  True if ths shipping mechanism will deliver on a Saturday.
  - Containment: By Value
  - Multiplicity: 1:1

### signatureRequired

    public boolean signatureRequired

  True if the customer is required to acknowled delivery with a signature.
  - Containment: By Value
  - Multiplicity: 1:1

### sizeLimit

    public double sizeLimit

  The maximum deliverable quantity.
  - Containment: By Value
  - Multiplicity: 1:1

### weightLimit

    public double weightLimit

  The maximum weight limit for this shipping mechanism.
  - Containment: By Value
  - Multiplicity: 1:1

## Constructor Detail

### ShippingMethodImpl

    public ShippingMethodImpl()

## Method Detail

### bscInitializeAttributes(ShippingMethodPk) Method

    protected void bscInitializeAttributes(ShippingMethodPk shippingMethodPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbActivate() Method

    public void ejbActivate()
         throws EJBException

Description copied from `EntityImpl.ejbActivate()`
ejbActivate method.

Overrides
  `EntityImpl.ejbActivate()`

#### Exceptions

``EJBException``

### ejbCreate(ShippingMethodPk) Method

    public ShippingMethodPk ejbCreate(ShippingMethodPk shippingMethodPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbFindAll() Method

    public Enumeration ejbFindAll()
         throws FinderException

Description copied from `EntityImpl.ejbFindAll()`
ejbFindAll method.

Overrides
  `EntityImpl.ejbFindAll()`

#### Exceptions

``FinderException``

### ejbFindByPrimaryKey(ShippingMethodPk) Method

    public ShippingMethodPk ejbFindByPrimaryKey(ShippingMethodPk pk)
         throws FinderException

#### Exceptions

``FinderException``

### ejbLoad() Method

    public void ejbLoad()
         throws EJBException

Description copied from `EntityImpl.ejbLoad()`
ejbLoad method.

Overrides
  `EntityImpl.ejbLoad()`

#### Exceptions

``EJBException``

### ejbPassivate() Method

    public void ejbPassivate()
         throws EJBException

Description copied from `EntityImpl.ejbPassivate()`
ejbPassivate method.

Overrides
  `EntityImpl.ejbPassivate()`

#### Exceptions

``EJBException``

### ejbPostCreate(ShippingMethodPk) Method

    public void ejbPostCreate(ShippingMethodPk shippingMethodPk)
         throws CreateException

#### Exceptions

``CreateException``

### ejbRemove() Method

    public void ejbRemove()
         throws RemoveException

Description copied from `EntityImpl.ejbRemove()`
ejbRemove method.

Overrides
  `EntityImpl.ejbRemove()`

#### Exceptions

``RemoveException``

### ejbStore() Method

    public void ejbStore()
         throws EJBException

Description copied from `EntityImpl.ejbStore()`
ejbStore method.

Overrides
  `EntityImpl.ejbStore()`

#### Exceptions

``EJBException``

### getAverageShippingTime() Method

    public int getAverageShippingTime()

Get the value of averageShippingTime

#### Returns

averageShippingTime.

### getCarrier() Method

    public String getCarrier()

Get the value of carrier

#### Returns

carrier.

### getCostCalculationMechanism() Method

    public String getCostCalculationMechanism()

Get the value of costCalculationMechanism

#### Returns

costCalculationMechanism.

### getDescription() Method

    public String getDescription()

Get the value of description

#### Returns

description.

### getIdentifier() Method

    public String getIdentifier()

### getInternationalDelivery() Method

    public boolean getInternationalDelivery()

Get the value of internationalDelivery

#### Returns

internationalDelivery.

### getMethod() Method

    public String getMethod()

Get the value of method

#### Returns

method.

### getPackagingType() Method

    public String getPackagingType()

Get the value of packagingType

#### Returns

packagingType.

### getPercentage() Method

    public double getPercentage()

Get the value of percentage

#### Returns

percentage.

### getPoBoxAllowed() Method

    public boolean getPoBoxAllowed()

Get the value of poBoxAllowed

#### Returns

poBoxAllowed.

### getPrice() Method

    public Money getPrice()

Get the value of price

#### Returns

price.

### getRestrictions() Method

    public String getRestrictions()

Get the value of restrictions

#### Returns

restrictions.

### getSaturdayDelivery() Method

    public boolean getSaturdayDelivery()

Get the value of saturdayDelivery

#### Returns

saturdayDelivery.

### getShippingMethodByValue() Method

    public ShippingMethodValue getShippingMethodByValue()

Get all of ShippingMethod's attributes.

#### Returns

ShippingMethodValue the ShippingMethod value object

### getSignatureRequired() Method

    public boolean getSignatureRequired()

Get the value of signatureRequired

#### Returns

signatureRequired.

### getSizeLimit() Method

    public double getSizeLimit()

Get the value of sizeLimit

#### Returns

sizeLimit.

### getWeightLimit() Method

    public double getWeightLimit()

Get the value of weightLimit

#### Returns

weightLimit.

### setAverageShippingTime(int) Method

    public void setAverageShippingTime(int averageShippingTime)

Set the value of averageShippingTime

#### Parameters

averageShippingTime
  averageShippingTime to be added

### setCarrier(String) Method

    public void setCarrier(String carrier)

Set the value of carrier

#### Parameters

carrier
  carrier to be added

### setCostCalculationMechanism(String) Method

    public void setCostCalculationMechanism(String costCalculationMechanism)

Set the value of costCalculationMechanism

#### Parameters

costCalculationMechanism
  costCalculationMechanism to be added

### setDescription(String) Method

    public void setDescription(String description)

Set the value of description

#### Parameters

description
  description to be added

### setEntityContext(EntityContext) Method

    public void setEntityContext(EntityContext ctx)
         throws EJBException

Description copied from `EntityImpl.setEntityContext(EntityContext)`
setEntityContext method.

Overrides
  `EntityImpl.setEntityContext(EntityContext)`

#### Exceptions

``EJBException``

### setIdentifier(String) Method

    public void setIdentifier(String value)

### setInternationalDelivery(boolean) Method

    public void setInternationalDelivery(boolean internationalDelivery)

Set the value of internationalDelivery

#### Parameters

internationalDelivery
  internationalDelivery to be added

### setMethod(String) Method

    public void setMethod(String method)

Set the value of method

#### Parameters

method
  method to be added

### setPackagingType(String) Method

    public void setPackagingType(String packagingType)

Set the value of packagingType

#### Parameters

packagingType
  packagingType to be added

### setPercentage(double) Method

    public void setPercentage(double percentage)

Set the value of percentage

#### Parameters

percentage
  percentage to be added

### setPoBoxAllowed(boolean) Method

    public void setPoBoxAllowed(boolean poBoxAllowed)

Set the value of poBoxAllowed

#### Parameters

poBoxAllowed
  poBoxAllowed to be added

### setPrice(Money) Method

    public void setPrice(Money price)

Set the value of price

#### Parameters

price
  price to be added

### setRestrictions(String) Method

    public void setRestrictions(String restrictions)

Set the value of restrictions

#### Parameters

restrictions
  restrictions to be added

### setSaturdayDelivery(boolean) Method

    public void setSaturdayDelivery(boolean saturdayDelivery)

Set the value of saturdayDelivery

#### Parameters

saturdayDelivery
  saturdayDelivery to be added

### setShippingMethodByValue(ShippingMethodValue) Method

    public void setShippingMethodByValue(ShippingMethodValue value)

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

#### Parameters

value
  the ShippingMethod value object

### setSignatureRequired(boolean) Method

    public void setSignatureRequired(boolean signatureRequired)

Set the value of signatureRequired

#### Parameters

signatureRequired
  signatureRequired to be added

### setSizeLimit(double) Method

    public void setSizeLimit(double sizeLimit)

Set the value of sizeLimit

#### Parameters

sizeLimit
  sizeLimit to be added

### setWeightLimit(double) Method

    public void setWeightLimit(double weightLimit)

Set the value of weightLimit

#### Parameters

weightLimit
  weightLimit to be added

### unsetEntityContext() Method

    public void unsetEntityContext()
         throws EJBException

Description copied from `EntityImpl.unsetEntityContext()`
unsetEntityContext method.

Overrides
  `EntityImpl.unsetEntityContext()`

#### Exceptions

``EJBException``