atg.commerce.order
Interface OrderRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

PaymentGroup

All Known Implementing Classes:

CreditCard, GiftCertificate, InvoiceRequest, OrderRelationshipContainerImpl, PaymentGroupImpl, StoreCredit

public interface OrderRelationshipContainer
extends java.io.Serializable

Implemented by a class that contains and manages OrderRelationship objects. This interface defines methods for adding and removing OrderRelationship objects.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	addOrderRelationship(OrderRelationship pOrderRelationship) Add the OrderRelationship to the container.
OrderRelationship	getOrderRelationship() Returns the OrderRelationship.
int	getOrderRelationshipCount() Returns the number of OrderRelationships in the container.
OrderRelationship	removeOrderRelationship() Removes a OrderRelationship.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

addOrderRelationship

void addOrderRelationship(OrderRelationship pOrderRelationship)
                          throws DuplicateRelationshipException,
                                 InvalidParameterException

Add the OrderRelationship to the container. If the OrderRelationship was already in the container a DuplicateRelationshipException is thrown.

Throws:

DuplicateRelationshipException

InvalidParameterException

removeOrderRelationship

OrderRelationship removeOrderRelationship()
                                          throws RelationshipNotFoundException,
                                                 InvalidParameterException

Removes a OrderRelationship. If the OrderRelationship is not in the container then a RelationshipNotFoundException is thrown. Otherwise a reference to the removed OrderRelationship is returned.

Throws:

RelationshipNotFoundException

InvalidParameterException

getOrderRelationship

OrderRelationship getOrderRelationship()
                                       throws RelationshipNotFoundException,
                                              InvalidParameterException

Returns the OrderRelationship. If the OrderRelationship with the corresponding id is not in the container then a RelationshipNotFoundException is thrown.

Throws:

RelationshipNotFoundException

InvalidParameterException

getOrderRelationshipCount

int getOrderRelationshipCount()

Returns the number of OrderRelationships in the container. The returned value will be either 0 or 1.