atg.b2bcommerce.order
Interface B2BOrderRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CostCenter

All Known Implementing Classes:

B2BOrderRelationshipContainerImpl, CostCenterImpl

public interface B2BOrderRelationshipContainer
extends java.io.Serializable

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

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	addOrderRelationship(B2BOrderRelationship pOrderRelationship) Add the OrderRelationship to the container.
B2BOrderRelationship	getOrderRelationship() Returns the OrderRelationship.
int	getOrderRelationshipCount() Returns the number of OrderRelationships in the container.
B2BOrderRelationship	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(B2BOrderRelationship 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

B2BOrderRelationship 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

B2BOrderRelationship 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.