com.ibm.commerce.context.preview

Interface PreviewConstants

  • All Known Implementing Classes:
    PreviewContextImpl

    public interface PreviewConstants
    This interface has all the constants required by the PreviewContext class. The constants are used in one of the following ways:
    • As keys to pass values into PreviewContext, either through URL parameters or Activity Data.
    • As values for the keys.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.Integer INVENTORY_EVAL_FALSE
      Constant that specifies that inventory constraints must be evaluated to false in preview mode.
      static java.lang.Integer INVENTORY_EVAL_REAL
      Constant that specifies that the actual inventory in the database must be used in preview mode.
      static java.lang.Integer INVENTORY_EVAL_TRUE
      Constant that specifies that inventory constraints must evaluate to true in preview mode.
      static java.lang.String PREVIEW_CTXT_DATA
      Constant for previewCtxtData hash map.
      static java.lang.String PREVIEW_HOST
      Constant for preview host.
      static java.lang.String PREVIEW_INVENTORY
      Constant for preview inventory mode key.
      static java.lang.String PREVIEW_MEMBER_GROUP_IDS_INCLUDED
      Constant for the included member groups
      static java.lang.String PREVIEW_PATH
      Constant for preview path.
      static int PREVIEW_PROP_POSITION
      Position of the preview property attributes within the default implementation class.
      static java.lang.String PREVIEW_REST_URI
      Constant for preview rest url.
      static java.lang.String PREVIEW_START_TIME
      Constant for preview start time key.
      static java.lang.String PREVIEW_STATIC
      Constant for static preview key.
      static java.lang.String PREVIEW_TOKEN
      Constants for preview token key.
      static java.lang.String REST_ATTRIBUTE_IN_PREVIEW
      REST request attribute name for request in preview.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • PREVIEW_TOKEN

        static final java.lang.String PREVIEW_TOKEN
        Constants for preview token key.
        See Also:
        Constant Field Values

      • PREVIEW_START_TIME

        static final java.lang.String PREVIEW_START_TIME
        Constant for preview start time key. This constant must be used in a URL when URL parameters are used to pass in the value for preview start time into PreviewContext.
        See Also:
        Constant Field Values

      • PREVIEW_STATIC

        static final java.lang.String PREVIEW_STATIC
        Constant for static preview key. This constant must be used in a URL when URL parameters are used to pass in the value for isStatic into PreviewContext.
        See Also:
        Constant Field Values

      • PREVIEW_INVENTORY

        static final java.lang.String PREVIEW_INVENTORY
        Constant for preview inventory mode key. This constant must be used as a key when the inventory mode value is set using PreviewContext.setPreviewCtxtData(key, value) or the inventory mode value is retrieved using PreviewContext.getPreviewCtxtData(key).
        See Also:
        Constant Field Values

      • PREVIEW_REST_URI

        static final java.lang.String PREVIEW_REST_URI
        Constant for preview rest url. This constant must be used as a key when the preview rest url value is set using PreviewContext.setPreviewCtxtData(key, value) or the preview rest url is retrieved using PreviewContext.getPreviewCtxtData(key).
        See Also:
        Constant Field Values

      • PREVIEW_PATH

        static final java.lang.String PREVIEW_PATH
        Constant for preview path. This constant must be used as a key when the preview path value is set using PreviewContext.setPreviewCtxtData(key, value) or the preview path is retrieved using PreviewContext.getPreviewCtxtData(key).
        See Also:
        Constant Field Values

      • PREVIEW_HOST

        static final java.lang.String PREVIEW_HOST
        Constant for preview host. This constant must be used as a key when the preview host value is set using PreviewContext.setPreviewCtxtData(key, value) or the preview host is retrieved using PreviewContext.getPreviewCtxtData(key).
        See Also:
        Constant Field Values

      • PREVIEW_MEMBER_GROUP_IDS_INCLUDED

        static final java.lang.String PREVIEW_MEMBER_GROUP_IDS_INCLUDED
        Constant for the included member groups
        See Also:
        Constant Field Values

      • INVENTORY_EVAL_REAL

        static final java.lang.Integer INVENTORY_EVAL_REAL
        Constant that specifies that the actual inventory in the database must be used in preview mode. To set this value, run PreviewContext.setPreviewCtxtData(key, value) using PREVIEW_INVENTORY as the key parameter.

      • INVENTORY_EVAL_TRUE

        static final java.lang.Integer INVENTORY_EVAL_TRUE
        Constant that specifies that inventory constraints must evaluate to true in preview mode. To set this value, run PreviewContext.setPreviewCtxtData(key, value) using PREVIEW_INVENTORY as the key parameter.

      • INVENTORY_EVAL_FALSE

        static final java.lang.Integer INVENTORY_EVAL_FALSE
        Constant that specifies that inventory constraints must be evaluated to false in preview mode. To set this value, run PreviewContext.setPreviewCtxtData(key, value) using PREVIEW_INVENTORY as the key parameter.

      • PREVIEW_CTXT_DATA

        static final java.lang.String PREVIEW_CTXT_DATA
        Constant for previewCtxtData hash map. This constant must be used when the hash map is passed to PreviewContext using activity data container.
        See Also:
        Constant Field Values

      • PREVIEW_PROP_POSITION

        static final int PREVIEW_PROP_POSITION
        Position of the preview property attributes within the default implementation class.
        See Also:
        Constant Field Values

      • REST_ATTRIBUTE_IN_PREVIEW

        static final java.lang.String REST_ATTRIBUTE_IN_PREVIEW
        REST request attribute name for request in preview.
        See Also:
        Constant Field Values
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method