com.ibm.commerce.order.beans

Class ShipCarrAccntDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.order.objects.ShipInfoAccessBean

com.ibm.commerce.order.beansrc.ShipInfoDataBeanBase

com.ibm.commerce.order.beans.ShipCarrAccntDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable

public class ShipCarrAccntDataBean
extends ShipInfoDataBeanBase
implements InputDataBean, SmartDataBean

This databean represents a ShipCarrAccnt object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
ShipCarrAccntDataBean() ShipCarrAccntDataBean constructor .
ShipCarrAccntDataBean(ShipInfoAccessBean aShipInfoAccessBean) Constructs an ShipCarrAccntDataBean from an ShipInfoAccessBean by extracting the SHIPINFO EJB reference from the ShipInfoAccessBean.
ShipCarrAccntDataBean(ShipInfoAccessBean aShipInfoAccessBean, CommandContext aCommandContext) Constructs a ShipCarrAccntDataBean from a ShipInfoAccessBean by extracting the SHIPINFO EJB reference from the ShipInfoAccessBean and setting the commandContext

Method Summary

Modifier and Type	Method and Description
CommandContext	getCommandContext() This method returns the command context.
TypedProperty	getIRequestProperties() This method returns the request properties.
java.lang.String	getOrderID() This method returns the order ID number of this ShipCarrAccntDataBean object.
java.lang.String	getPolicyID() This method returns the policy ID number of this ShipCarrAccntDataBean object.
TypedProperty	getRequestProperties() This method returns the request property set within this bean.
ShipCarrAccntDataBean	getShipCarrAccntDB(java.lang.String orderId, java.lang.String shipModeId) This method returns a ShipCarrAccntDataBean object based on the parameters passed in.
java.lang.String	getShipCarrAccntNum() This method returns the carrier account number of this ShipCarrAccntDataBean object.
java.lang.Long	getShipInfoId() This method returns the ship mode ID of the order
java.lang.String	getShipModeID() This method returns the ship mode ID of this ShipCarrAccntDataBean object.
void	populate() This method is used to populate the ShipCarrAccntDataBean.
void	setCommandContext(CommandContext context) This method sets CommandContext method comment.
void	setDataBeanKeyShipInfoId(java.lang.String aShipInfoID) This method sets the SHIPINFO ID of the primary key.
void	setIRequestProperties(TypedProperty property) This method sets request properties.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the request properties within this bean.

Methods inherited from class com.ibm.commerce.order.beansrc.ShipInfoDataBeanBase

getDelegate

Methods inherited from class com.ibm.commerce.order.objects.ShipInfoAccessBean

findByOrderId, findByOrderIdAddressIdShipModeId, findByOrderIdShipModeId, findShipCarrAccntsByOrderId, findShipInstructsByOrderId, fulfills, getAddressId, getCarrierAccntNum, getEntity, getInstructions, getOrderId, getOwner, getPolicyId, getShipModeId, instantiateEntity, setAddressId, setCarrierAccntNum, setInitKey_shipInfoId, setInstructions, setOrderId, setPolicyId, setShipModeId

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ShipCarrAccntDataBean

public ShipCarrAccntDataBean()

ShipCarrAccntDataBean constructor .

ShipCarrAccntDataBean

public ShipCarrAccntDataBean(ShipInfoAccessBean aShipInfoAccessBean,
                             CommandContext aCommandContext)

Constructs a ShipCarrAccntDataBean from a ShipInfoAccessBean by extracting the SHIPINFO EJB reference from the ShipInfoAccessBean and setting the commandContext

Parameters:

aShipInfoAccessBean - ShipInfoAccessBean

aCommandContext - Command Context

Throws:

java.lang.Exception

ShipCarrAccntDataBean

public ShipCarrAccntDataBean(ShipInfoAccessBean aShipInfoAccessBean)

Constructs an ShipCarrAccntDataBean from an ShipInfoAccessBean by extracting the SHIPINFO EJB reference from the ShipInfoAccessBean. Note: Consider using ShipCarrAccntDataBean(ShipInfoAccessBean aShipInfoAccessBean,CommandContext aCommandContext) if commandContext is available.

Parameters:

aShipInfoAccessBean - ShipInfoAccessBean

Throws:

java.lang.Exception

Method Detail

setDataBeanKeyShipInfoId

public void setDataBeanKeyShipInfoId(java.lang.String aShipInfoID)

This method sets the SHIPINFO ID of the primary key.

Parameters:

aShipInfoID - the SHIPINFO ID - the key

getCommandContext

public CommandContext getCommandContext()

This method returns the command context.

Specified by:

getCommandContext in interface SmartDataBean

Returns:

CommandContext

setCommandContext

public void setCommandContext(CommandContext context)

This method sets CommandContext method comment.

Specified by:

setCommandContext in interface SmartDataBean

Parameters:

context - CommandContext

getRequestProperties

public TypedProperty getRequestProperties()

This method returns the request property set within this bean.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

com.ibm.commerce.datatype.TypedProperty

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)

This method sets the request properties within this bean.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

aRequestProperties - com.ibm.commerce.datatype.TypedProperty

populate

public void populate()

This method is used to populate the ShipCarrAccntDataBean. You must set ShipInfoId using the setDataBeanKeyShipInfoId method before running the populate() method.

Specified by:

populate in interface SmartDataBean

Throws:

java.lang.Exception

See Also:

setDataBeanKeyShipInfoId(String)

getIRequestProperties

public TypedProperty getIRequestProperties()

This method returns the request properties.

Returns:

iRequestProperties

setIRequestProperties

public void setIRequestProperties(TypedProperty property)

This method sets request properties.

Parameters:

property -

getShipInfoId

public java.lang.Long getShipInfoId()

This method returns the ship mode ID of the order

Overrides:

getShipInfoId in class ShipInfoAccessBean

Returns:

Long ship mode ID

getShipCarrAccntDB

public ShipCarrAccntDataBean getShipCarrAccntDB(java.lang.String orderId,
                                                java.lang.String shipModeId)

This method returns a ShipCarrAccntDataBean object based on the parameters passed in.

Parameters:

orderId - the order ID number of the carrier account data to read

shipModeId - the ship mode ID of the carrier account data to read

Returns:

ShipCarrAccntDataBean databean holding carrier account data

getShipCarrAccntNum

public java.lang.String getShipCarrAccntNum()

This method returns the carrier account number of this ShipCarrAccntDataBean object.

Returns:

String the carrier account number

getPolicyID

public java.lang.String getPolicyID()

This method returns the policy ID number of this ShipCarrAccntDataBean object.

Returns:

String the policy ID number

getOrderID

public java.lang.String getOrderID()

This method returns the order ID number of this ShipCarrAccntDataBean object.

Returns:

String the order ID number

getShipModeID

public java.lang.String getShipModeID()

This method returns the ship mode ID of this ShipCarrAccntDataBean object.

Returns:

String the ship mode ID