atg.commerce.order

Interface CommerceItemRelationship

All Superinterfaces:

CommerceIdentifier, Relationship, java.io.Serializable

All Known Implementing Classes:

CostCenterCommerceItemRelationship, PaymentGroupCommerceItemRelationship, ShippingGroupCommerceItemRelationship

public interface CommerceItemRelationship
extends Relationship

An interface which represents a part of a relationship that is a CommerceItem.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
double	getAmount() Returns the amount that this Relationship represents.
CommerceItem	getCommerceItem() Returns the CommerceItem reference.
long	getQuantity() Returns the quantity that this Relationship represents.
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this Relationship object represents.
double	getQuantityWithFraction() Returns the quantity that this Relationship represents.
long	getReturnedQuantity() Returns the returnedQuantity
double	getReturnedQuantityDerivedAsFloatingPoint() This method will return a derived returned quantity value which this Relationship object represents.
double	getReturnedQuantityWithFraction() Returns the returned quantity (with fraction)
int	getState() Returns the state
java.lang.String	getStateDetail() Returns the stateDetail
boolean	isFractional() This method will return a true if fractional quantity value is being used otherwise it returns false, in case of non-fractional quantity.
void	setAmount(double pAmount) Sets the amount that this Relationship represents.
void	setCommerceItem(CommerceItem pCommerceItem) Sets the CommerceItem reference.
void	setQuantity(long pQuantity) Sets the quantity that this Relationship represents.
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the quantity that this Relationship represents.
void	setReturnedQuantity(long pReturnedQuantity) Sets the returnedQuantity
void	setReturnedQuantityWithFraction(double pReturnedQuantityWithFraction) Sets the returned quantity (with fraction).
void	setState(int pState) Sets the state
void	setStateDetail(java.lang.String pStateDetail) Sets the stateDetail

Methods inherited from interface atg.commerce.order.Relationship

getRelationshipClassType, getRelationshipType, setRelationshipClassType, setRelationshipType

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getCommerceItem

CommerceItem getCommerceItem()

Returns the CommerceItem reference.

setCommerceItem

void setCommerceItem(CommerceItem pCommerceItem)

Sets the CommerceItem reference.

getState

int getState()

Returns the state

setState

void setState(int pState)

Sets the state

getStateDetail

java.lang.String getStateDetail()

Returns the stateDetail

setStateDetail

void setStateDetail(java.lang.String pStateDetail)

Sets the stateDetail

getQuantity

long getQuantity()

Returns the quantity that this Relationship represents.

setQuantity

void setQuantity(long pQuantity)

Sets the quantity that this Relationship represents.

getQuantityWithFraction

double getQuantityWithFraction()

Returns the quantity that this Relationship represents.

setQuantityWithFraction

void setQuantityWithFraction(double pQuantityWithFraction)

Sets the quantity that this Relationship represents.

getQuantityDerivedAsFloatingPoint

double getQuantityDerivedAsFloatingPoint()

This method will return a derived quantity value which this Relationship object represents.

It will decide upon the correct quantity value to return, returning the first non zero value from the methods, getQuantityWithFraction(), getQuantity(), in that order.

The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (getQuantityWithFraction() or getQuantity() holds the value.

Returns:

a derived quantity of CommerceItems which this Relationship object represents

isFractional

boolean isFractional()

This method will return a true if fractional quantity value is being used otherwise it returns false, in case of non-fractional quantity.

Returns:

a boolean value

getReturnedQuantity

long getReturnedQuantity()

Returns the returnedQuantity

setReturnedQuantity

void setReturnedQuantity(long pReturnedQuantity)

Sets the returnedQuantity

setReturnedQuantityWithFraction

void setReturnedQuantityWithFraction(double pReturnedQuantityWithFraction)

Sets the returned quantity (with fraction).

Parameters:

pReturnedQuantityWithFraction - the (fractional) quantity to be returned.

getReturnedQuantityWithFraction

double getReturnedQuantityWithFraction()

Returns the returned quantity (with fraction)

Returns:

a (fractional) quantity to be returned.

getReturnedQuantityDerivedAsFloatingPoint

double getReturnedQuantityDerivedAsFloatingPoint()

This method will return a derived returned quantity value which this Relationship object represents.

It will decide upon the correct returned quantity value to return, returning the first non zero value from the methods, getReturnedQuantityWithFraction(), getReturnedQuantity(), in that order.

The method should be used where there is a need to know the returned quantity of an item but it is unknown to the caller as to which property (getReturnedQuantityWithFraction() or getReturnedQuantity() holds the value.

Returns:

a derived returned quantity of CommerceItems which this Relationship object represents

getAmount

double getAmount()

Returns the amount that this Relationship represents.

setAmount

void setAmount(double pAmount)

Sets the amount that this Relationship represents.