com.ibm.commerce.order.calculation

Class DirectAttachmentHelper

  • java.lang.Object
    • com.ibm.commerce.order.calculation.DirectAttachmentHelper


  • public class DirectAttachmentHelper
    extends java.lang.Object
    A helper class for retrieving and caching direct attachments.
    • Field Summary

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

      Constructors 
      Constructor and Description
      DirectAttachmentHelper()
      Constructor for DirectAttachmentHelper.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      OrderItemCalculationCodeAccessBean[] getOrderItemLevelAttachments(java.lang.Long anOrderItemId, java.lang.Integer anCodeId)
      Returns the orderitem level direct attachments associated with an orderitem that reference the calculation code specified.
      CalculationCodeAccessBean[] getOrderItemLevelCodes(java.lang.Long anOrderItemId, java.lang.Integer anUsageId, java.sql.Timestamp aTimestamp)
      Returns the calculation codes that are directly attached to an orderitem via orderitem level direct attachments.
      OrderCalculationCodeAccessBean[] getOrderLevelAttachments(java.lang.Long anOrderId, java.lang.Integer anCodeId)
      Returns the order level direct attachments associated with an order that reference the calculation code specified.
      CalculationCodeAccessBean[] getOrderLevelCodes(java.lang.Long anOrderId, java.lang.Integer anUsageId, java.sql.Timestamp aTimestamp)
      Returns the calculation codes that are directly attached to an order via order level direct attachments.
      boolean isOrderItemLevelAttachmentsOverride(java.lang.Long anOrderItemId, java.lang.Integer anUsageId, java.sql.Timestamp aTimestamp)
      Returns whether any orderitem level direct attachment associated with an orderitem is marked as "overrideIndirectAttachments".
      boolean isOrderLevelAttachmentsOverride(java.lang.Long anOrderId, java.lang.Integer anUsageId, java.sql.Timestamp aTimestamp)
      Returns whether any order level direct attachment associated with an order is marked as "overrideIndirectAttachments".
      void reset()
      Resets this helper instance.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DirectAttachmentHelper

        public DirectAttachmentHelper()
        Constructor for DirectAttachmentHelper.
    • Method Detail

      • getOrderItemLevelAttachments

        public OrderItemCalculationCodeAccessBean[] getOrderItemLevelAttachments(java.lang.Long anOrderItemId,
                                                                                 java.lang.Integer anCodeId)
                                                                          throws ECException
        Returns the orderitem level direct attachments associated with an orderitem that reference the calculation code specified.
        Parameters:
        anOrderItemId - the orderitem ID.
        anCodeId - the calculation code ID.
        Returns:
        the orderitem level direct attachments.
        Throws:
        ECException
      • getOrderItemLevelCodes

        public CalculationCodeAccessBean[] getOrderItemLevelCodes(java.lang.Long anOrderItemId,
                                                                  java.lang.Integer anUsageId,
                                                                  java.sql.Timestamp aTimestamp)
                                                           throws ECException
        Returns the calculation codes that are directly attached to an orderitem via orderitem level direct attachments.
        Parameters:
        anOrderItemId - the orderitem ID.
        anUsageId - the calculation usage ID.
        aTimestamp - the timestamp.
        Returns:
        the calculation codes.
        Throws:
        ECException
      • getOrderLevelAttachments

        public OrderCalculationCodeAccessBean[] getOrderLevelAttachments(java.lang.Long anOrderId,
                                                                         java.lang.Integer anCodeId)
                                                                  throws ECException
        Returns the order level direct attachments associated with an order that reference the calculation code specified.
        Parameters:
        anOrderId - the order ID.
        anCodeId - the calculation code ID.
        Returns:
        the order level direct attachments.
        Throws:
        ECException
      • getOrderLevelCodes

        public CalculationCodeAccessBean[] getOrderLevelCodes(java.lang.Long anOrderId,
                                                              java.lang.Integer anUsageId,
                                                              java.sql.Timestamp aTimestamp)
                                                       throws ECException
        Returns the calculation codes that are directly attached to an order via order level direct attachments.
        Parameters:
        anOrderId - the orderitem ID.
        anUsageId - the calculation usage ID.
        aTimestamp - the timestamp.
        Returns:
        the calculation codes.
        Throws:
        ECException
      • isOrderItemLevelAttachmentsOverride

        public boolean isOrderItemLevelAttachmentsOverride(java.lang.Long anOrderItemId,
                                                           java.lang.Integer anUsageId,
                                                           java.sql.Timestamp aTimestamp)
                                                    throws ECException
        Returns whether any orderitem level direct attachment associated with an orderitem is marked as "overrideIndirectAttachments". For more information, refer to ORDICALCD.CALFLAGS.
        Parameters:
        anOrderItemId - the orderitem ID.
        anUsageId - the calculation usage ID.
        aTimestamp - the timestamp.
        Returns:
        true if one or more orderitem level direct attachments are marked as such.
        Throws:
        ECException
      • isOrderLevelAttachmentsOverride

        public boolean isOrderLevelAttachmentsOverride(java.lang.Long anOrderId,
                                                       java.lang.Integer anUsageId,
                                                       java.sql.Timestamp aTimestamp)
                                                throws ECException
        Returns whether any order level direct attachment associated with an order is marked as "overrideIndirectAttachments". For more information, refer to ORDCALCD.CALFLAGS.
        Parameters:
        anOrderId - the orderitem ID.
        anUsageId - the calculation usage ID.
        aTimestamp - the timestamp.
        Returns:
        true if one or more order level direct attachments are marked as such.
        Throws:
        ECException
      • reset

        public void reset()
        Resets this helper instance.