Package com.echothree.model.control.purchase.server.logic

Class PurchaseOrderLogic

java.lang.Object

com.echothree.util.server.control.BaseLogic

com.echothree.model.control.order.server.logic.OrderLogic

com.echothree.model.control.purchase.server.logic.PurchaseOrderLogic

public class PurchaseOrderLogic
extends OrderLogic

Method Summary

Modifier and Type	Method	Description
void	checkOrderAvailableForModification(Session session, ExecutionErrorAccumulator eea, Order order, PartyPK modifiedBy)	Check to see if an Order is available for modification, and if it isn't, send back an error.
Order	createPurchaseOrder(Session session, ExecutionErrorAccumulator eea, UserVisit userVisit, Party vendorParty, Boolean holdUntilComplete, Boolean allowBackorders, Boolean allowSubstitutions, Boolean allowCombiningShipments, String reference, Term term, FreeOnBoard freeOnBoard, String workflowEntranceName, Party createdByParty)	Create a new Purchase Order using appropriate defaults where possible for Optional parameters.
Order	createPurchaseOrder(Session session, ExecutionErrorAccumulator eea, UserVisit userVisit, String vendorName, String termName, String strHoldUntilComplete, String strAllowBackorders, String strAllowSubstitutions, String strAllowCombiningShipments, String reference, String freeOnBoardName, String workflowEntranceName, Party createdByParty)
CancellationPolicy	getCancellationPolicy(ExecutionErrorAccumulator eea, VendorType vendorType, Vendor billToVendor)
static PurchaseOrderLogic	getInstance()
Party	getOrderBillToParty(Order order)	Find the BILL_TO Party for a given Order.
VendorType	getOrderBillToVendorType(Order order)	Find the VendorType for the BILL_TO Party for a given Order.
Order	getOrderByName(ExecutionErrorAccumulator eea, String orderName)
Order	getOrderByNameForUpdate(ExecutionErrorAccumulator eea, String orderName)
OrderPriority	getOrderPriorityByName(ExecutionErrorAccumulator eea, String orderPriorityName)
OrderPriority	getOrderPriorityByNameForUpdate(ExecutionErrorAccumulator eea, String orderPriorityName)
Party	getOrderShipToParty(Order order, boolean billToFallback, BasePK createdBy)	Attempt to find a SHIP_TO Party for the Order.
PurchaseOrderStatusChoicesBean	getPurchaseOrderStatusChoices(String defaultOrderStatusChoice, Language language, boolean allowNullChoice, Order order, PartyPK partyPK)
ReturnPolicy	getReturnPolicy(ExecutionErrorAccumulator eea, VendorType vendorType, Vendor billToVendor)
VendorType	getVendorTypeFromParty(Party party)	Find the VendorType for a given Party.
boolean	isOrderInWorkflowSteps(ExecutionErrorAccumulator eea, EntityInstance entityInstance, String... workflowStepNames)
boolean	isOrderInWorkflowSteps(ExecutionErrorAccumulator eea, Order order, String... workflowStepNames)
void	setPurchaseOrderStatus(Session session, ExecutionErrorAccumulator eea, Order order, String orderStatusChoice, PartyPK modifiedBy)
void	validatePurchaseOrderReference(ExecutionErrorAccumulator eea, String reference, Vendor vendor)

Methods inherited from class com.echothree.model.control.order.server.logic.OrderLogic

checkItemAgainstOrderPaymentPreferences, checkItemAgainstShippingMethod, createOrder, createOrderPaymentPreference, createOrderShipmentGroup, getDefaultOrderShipmentGroup, getItemsFromOrder, getOrderAliasTypeByName, getOrderByName, getOrderByNameForUpdate, getOrderCurrency, getOrderName, getOrderPaymentPreferenceByName, getOrderPaymentPreferenceByNameForUpdate, getOrderPriorityByName, getOrderPriorityByNameForUpdate, getOrderRoleTypeByName, getOrderSequence, getOrderSequenceType, getOrderTypeByName

Methods inherited from class com.echothree.util.server.control.BaseLogic

addExecutionError, addSecurityMessage, getEntityInstanceByBaseEntity, getEntityInstanceByBasePK, getSession, handleExecutionError, handleSecurityMessage, hasExecutionErrors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static PurchaseOrderLogic getInstance()

validatePurchaseOrderReference

public void validatePurchaseOrderReference(ExecutionErrorAccumulator eea,
 String reference,
 Vendor vendor)

getCancellationPolicy

public CancellationPolicy getCancellationPolicy(ExecutionErrorAccumulator eea,
 VendorType vendorType,
 Vendor billToVendor)

getReturnPolicy

public ReturnPolicy getReturnPolicy(ExecutionErrorAccumulator eea,
 VendorType vendorType,
 Vendor billToVendor)

createPurchaseOrder

public Order createPurchaseOrder(Session session,
 ExecutionErrorAccumulator eea,
 UserVisit userVisit,
 Party vendorParty,
 Boolean holdUntilComplete,
 Boolean allowBackorders,
 Boolean allowSubstitutions,
 Boolean allowCombiningShipments,
 String reference,
 Term term,
 FreeOnBoard freeOnBoard,
 String workflowEntranceName,
 Party createdByParty)

Create a new Purchase Order using appropriate defaults where possible for Optional parameters.

Parameters:

session - Required.

eea - Required.

userVisit - Required.

vendorParty - Required.

holdUntilComplete - Optional.

allowBackorders - Optional.

allowSubstitutions - Optional.

allowCombiningShipments - Optional.

reference - Optional.

term - Optional.

workflowEntranceName - Optional.

createdByParty - Required.

Returns:

The newly created Order, or null if there was an error.

createPurchaseOrder

public Order createPurchaseOrder(Session session,
 ExecutionErrorAccumulator eea,
 UserVisit userVisit,
 String vendorName,
 String termName,
 String strHoldUntilComplete,
 String strAllowBackorders,
 String strAllowSubstitutions,
 String strAllowCombiningShipments,
 String reference,
 String freeOnBoardName,
 String workflowEntranceName,
 Party createdByParty)

isOrderInWorkflowSteps

public boolean isOrderInWorkflowSteps(ExecutionErrorAccumulator eea,
 Order order,
 String... workflowStepNames)

isOrderInWorkflowSteps

public boolean isOrderInWorkflowSteps(ExecutionErrorAccumulator eea,
 EntityInstance entityInstance,
 String... workflowStepNames)

getOrderByName

public Order getOrderByName(ExecutionErrorAccumulator eea,
 String orderName)

getOrderByNameForUpdate

public Order getOrderByNameForUpdate(ExecutionErrorAccumulator eea,
 String orderName)

getOrderPriorityByName

public OrderPriority getOrderPriorityByName(ExecutionErrorAccumulator eea,
 String orderPriorityName)

getOrderPriorityByNameForUpdate

public OrderPriority getOrderPriorityByNameForUpdate(ExecutionErrorAccumulator eea,
 String orderPriorityName)

getPurchaseOrderStatusChoices

public PurchaseOrderStatusChoicesBean getPurchaseOrderStatusChoices(String defaultOrderStatusChoice,
 Language language,
 boolean allowNullChoice,
 Order order,
 PartyPK partyPK)

setPurchaseOrderStatus

public void setPurchaseOrderStatus(Session session,
 ExecutionErrorAccumulator eea,
 Order order,
 String orderStatusChoice,
 PartyPK modifiedBy)

checkOrderAvailableForModification

public void checkOrderAvailableForModification(Session session,
 ExecutionErrorAccumulator eea,
 Order order,
 PartyPK modifiedBy)

Check to see if an Order is available for modification, and if it isn't, send back an error.

Parameters:

session - Required.

eea - Required.

order - Required.

modifiedBy - Required.

getOrderBillToParty

public Party getOrderBillToParty(Order order)

Find the BILL_TO Party for a given Order.

Parameters:

order - Required.

Returns:

The Party used for the BILL_TO OrderRoleType. May be null.

getVendorTypeFromParty

public VendorType getVendorTypeFromParty(Party party)

Find the VendorType for a given Party.

Parameters:

party - Optional.

Returns:

The VendorType for the Party. May be null.

getOrderBillToVendorType

public VendorType getOrderBillToVendorType(Order order)

Find the VendorType for the BILL_TO Party for a given Order.

Parameters:

order - Required.

Returns:

The VendorType for the BILL_TO Party. May be null.

getOrderShipToParty

public Party getOrderShipToParty(Order order,
 boolean billToFallback,
 BasePK createdBy)

Attempt to find a SHIP_TO Party for the Order. If none is found, and billToFallback is set to true, then attempt to find the BILL_TO Party. If a BILL_TO Party is found, copy it to the SHIP_TO.

Parameters:

order - Required.

billToFallback - Required.

createdBy - Required if billToFallback is true.

Returns:

The Party that is to be used for the SHIP_TO OrderRoleType. May be null.