com.ibm.commerce.pagelayout.facade.server.helpers

Class PageLayoutServerConstants

  • java.lang.Object
    • com.ibm.commerce.pagelayout.facade.server.helpers.PageLayoutServerConstants


  • public class PageLayoutServerConstants
    extends java.lang.Object
    This class defines the constants used in server side for PageLayout service.
    • Field Detail

      • COPYRIGHT

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

        public static final java.lang.String COMPONENT_NAME
        This constant represents the component name for the page layout component.
        See Also:
        Constant Field Values
      • WIDGETDEFINITION_STATE_ENUMERATION

        public static final java.lang.String WIDGETDEFINITION_STATE_ENUMERATION
        The state of the WidgetDefintion
        See Also:
        Constant Field Values
      • WIDGETDEFINITION_TYPE_ENUMERATION

        public static final java.lang.String WIDGETDEFINITION_TYPE_ENUMERATION
        The Widget type of the WidgetDefintion
        See Also:
        Constant Field Values
      • PAGELAYOUT_STATE_ENUMERATION

        public static final java.lang.String PAGELAYOUT_STATE_ENUMERATION
        The state of the PageLayout
        See Also:
        Constant Field Values
      • SLOT_TYPE_ENUMERATION

        public static final java.lang.String SLOT_TYPE_ENUMERATION
        The type of the Slot
        See Also:
        Constant Field Values
      • REQ_PARAM_PAGE_GROUP

        public static final java.lang.String REQ_PARAM_PAGE_GROUP
        Constant representing the pageGroup parameter in the request.
        See Also:
        Constant Field Values
      • APPLY_LAYOUT_TO_THIS_PAGE

        public static final java.lang.String APPLY_LAYOUT_TO_THIS_PAGE
        Constant representing the layout is only applies to this page.
        See Also:
        Constant Field Values
      • APPLY_LAYOUT_THIS_PAGE_AND_SUBCATEGORY

        public static final java.lang.String APPLY_LAYOUT_THIS_PAGE_AND_SUBCATEGORY
        Constant representing the layout is applies to this page and sub category pages.
        See Also:
        Constant Field Values
      • PAGE_GROUP_CATEGORY

        public static final java.lang.String PAGE_GROUP_CATEGORY
        The constant for Page Group - Category
        See Also:
        Constant Field Values
      • PAGE_GROUP_PRODUCT

        public static final java.lang.String PAGE_GROUP_PRODUCT
        The constant for Page Group - Product
        See Also:
        Constant Field Values
      • PAGE_GROUP_ITEM

        public static final java.lang.String PAGE_GROUP_ITEM
        The constant for Page Group - Item
        See Also:
        Constant Field Values
      • PAGE_GROUP_BUNDLE

        public static final java.lang.String PAGE_GROUP_BUNDLE
        The constant for Page Group - Bundle
        See Also:
        Constant Field Values
      • PAGE_GROUP_KIT

        public static final java.lang.String PAGE_GROUP_KIT
        The constant for Page Group - Kit
        See Also:
        Constant Field Values
      • PAGE_GROUP_DYNAMIC_KIT

        public static final java.lang.String PAGE_GROUP_DYNAMIC_KIT
        The constant for Page Group - DynamicKit
        See Also:
        Constant Field Values
      • PAGE_GROUP_PREDEFINED_DYNAMIC_KIT

        public static final java.lang.String PAGE_GROUP_PREDEFINED_DYNAMIC_KIT
        The constant for Page Group - PredDynaKit
        See Also:
        Constant Field Values
      • PAGE_GROUP_CONTENT

        public static final java.lang.String PAGE_GROUP_CONTENT
        The constant for Page Group - Content
        See Also:
        Constant Field Values
      • PAGE_GROUP_SEARCH

        public static final java.lang.String PAGE_GROUP_SEARCH
        The constant for Page Group - Search
        See Also:
        Constant Field Values
      • PAGE_GROUP_IN_CATEGORY_ACTIVITY_TEMPLATE

        public static final java.lang.String PAGE_GROUP_IN_CATEGORY_ACTIVITY_TEMPLATE
        The constant for Page Group Activity Template for In Category
        See Also:
        Constant Field Values
      • VALUE_MAPPING_EXTERNAL_NAME_COMMON_MAPPING

        public static final java.lang.String VALUE_MAPPING_EXTERNAL_NAME_COMMON_MAPPING
        true/false mapping to 1/0.
        See Also:
        Constant Field Values
      • FIND_PAGE_BY_UNIQUEID

        public static final java.lang.String FIND_PAGE_BY_UNIQUEID
        Constant representing the XPath key to find the page by unique id.
        See Also:
        Constant Field Values
      • FIND_PAGE_BY_NAME_AND_STOREIDENTIFIER

        public static final java.lang.String FIND_PAGE_BY_NAME_AND_STOREIDENTIFIER
        Constant representing the XPath key to find the page by name and store identifier.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ADMIN_PAGE_UPDATE

        public static final java.lang.String ACCESS_PROFILE_ADMIN_PAGE_UPDATE
        The constant for access profile IBM_Admin_PageUpdate.
        See Also:
        Constant Field Values
      • XPATH_CHANGE_PAGELOCATION_NOUN_PART

        public static final java.lang.String XPATH_CHANGE_PAGELOCATION_NOUN_PART
        The XPATH for change page location noun part.
        See Also:
        Constant Field Values
      • XPATH_FIND_PAGE_LOCATION_BY_PAGELOCATIONID

        public static final java.lang.String XPATH_FIND_PAGE_LOCATION_BY_PAGELOCATIONID
        Constant representing the XPath key to find the Page Location by Page Location ID.
        See Also:
        Constant Field Values
      • XPATH_FIND_PAGE_LOCATION_BY_LAYOUT_ID

        public static final java.lang.String XPATH_FIND_PAGE_LOCATION_BY_LAYOUT_ID
        Constant representing the XPath key to find the Page Location by Layout Unique ID.
        See Also:
        Constant Field Values
      • XPATH_FIND_RELATED_LAYOUTS_FOR_TEMPLATE_BY_TEMPLATE_ID

        public static final java.lang.String XPATH_FIND_RELATED_LAYOUTS_FOR_TEMPLATE_BY_TEMPLATE_ID
        Constant representing the XPath key to find the Page Layouts for Template by by Template Unique ID.
        See Also:
        Constant Field Values
      • NOUN_PART_ATTRIBUTE_NAME_PAGE_LOCATION_PAGELOCATIONID

        public static final java.lang.String NOUN_PART_ATTRIBUTE_NAME_PAGE_LOCATION_PAGELOCATIONID
        The attribute name of PageLocationID in Page Location noun part.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ADMIN_LAYOUT_PAGELOCATION_UPDATE

        public static final java.lang.String ACCESS_PROFILE_ADMIN_LAYOUT_PAGELOCATION_UPDATE
        The constant for access profile IBM_Admin_Layout_PageLocation_Update.
        See Also:
        Constant Field Values
      • IBM_LAYOUT_WIDGET_UPDATE

        public static final java.lang.String IBM_LAYOUT_WIDGET_UPDATE
        The constant for access profile IBM_Layout_Widget_Update.
        See Also:
        Constant Field Values
      • EXTENDED_CONFIGURATION_FOR_CACHED_ACCESS_PROFILES_OF_WIDGETDEFINITION

        public static final java.lang.String EXTENDED_CONFIGURATION_FOR_CACHED_ACCESS_PROFILES_OF_WIDGETDEFINITION
        The extended configuration grouping name for identifying the cached access profiles for WidgetDefinition logical type.
        See Also:
        Constant Field Values
      • EXTENDED_CONFIGURATION_FOR_CACHED_ACCESS_PROFILES_OF_LAYOUT

        public static final java.lang.String EXTENDED_CONFIGURATION_FOR_CACHED_ACCESS_PROFILES_OF_LAYOUT
        The extended configuration grouping name for identifying the cached access profiles for Layout logical type.
        See Also:
        Constant Field Values
      • IBM_Layout_Update

        public static final java.lang.String IBM_Layout_Update
        The constant for access profile IBM_Layout_Update. NOTE: Cannot change to IBM_LAYOUT_UPDATE because of API compatibility error - [1] field IBM_Layout_Update is missing in 7.0.9
        See Also:
        Constant Field Values
      • FETCH_EXTENDED_DATA_DATATYPE_XPATH_KEY_1

        public static final java.lang.String FETCH_EXTENDED_DATA_DATATYPE_XPATH_KEY_1
        The mapping key for fetch the data type of the widget extended data.
        See Also:
        Constant Field Values
      • CONTROL_PARAM_EVAL_STRATEGY

        public static final java.lang.String CONTROL_PARAM_EVAL_STRATEGY
        The key used to fetch the evaluation strategy used to come up with list of ESpot names which are then passed to Marketing Engine to identify winning layout
        See Also:
        Constant Field Values
      • IBM_DEPTH_FIRST_EVAL_STRATEGY

        public static final java.lang.String IBM_DEPTH_FIRST_EVAL_STRATEGY
        Depth First algorithm name. This is the default algorithm used if client doesn't specify any evaluation strategy
        See Also:
        Constant Field Values
      • IBM_CLOSEST_PARENT_EVAL_STRATEGY

        public static final java.lang.String IBM_CLOSEST_PARENT_EVAL_STRATEGY
        Closest Parent First algorithm name.
        See Also:
        Constant Field Values
      • WIDGET_DEFINITION_INTERNAL_STATE_INACTIVE

        public static final short WIDGET_DEFINITION_INTERNAL_STATE_INACTIVE
        Constant to represent the inactive state of a widget definition.
        See Also:
        Constant Field Values
      • WIDGET_DEFINITION_INTERNAL_STATE_ACTIVE

        public static final short WIDGET_DEFINITION_INTERNAL_STATE_ACTIVE
        Constant to represent the active state of a widget definition.
        See Also:
        Constant Field Values
      • WIDGETDEFINITION_INTERNAL_TYPE_CONTAINER

        public static final short WIDGETDEFINITION_INTERNAL_TYPE_CONTAINER
        Constant to represent the internal value for the container widget type.
        See Also:
        Constant Field Values
      • DEFAULT_MANAGING_TOOL

        public static final java.lang.String DEFAULT_MANAGING_TOOL
        Constant to represent the default managing tool.
        See Also:
        Constant Field Values
      • XPATH_PARAM_MANAGING_TOOL

        public static final java.lang.String XPATH_PARAM_MANAGING_TOOL
        Constant for XPath parameter: managingTool
        See Also:
        Constant Field Values
      • MANAGING_TOOL_VALUE_MAPPING_SERVICE_NAME

        public static final java.lang.String MANAGING_TOOL_VALUE_MAPPING_SERVICE_NAME
        Constant for value mapping service name to map managing tool names of a layout.
        See Also:
        Constant Field Values
      • XPATH_FIND_LAYOUT_PROPERTY_BY_NAME_AND_VALUE

        public static final java.lang.String XPATH_FIND_LAYOUT_PROPERTY_BY_NAME_AND_VALUE
        Constant for XPath key to fetch Layout property based on name and value.
        See Also:
        Constant Field Values
      • XPATH_PARAM_PROPERTY_NAME

        public static final java.lang.String XPATH_PARAM_PROPERTY_NAME
        Constant for XPath parameter: Name
        See Also:
        Constant Field Values
      • XPATH_PARAM_PROPERTY_VALUE

        public static final java.lang.String XPATH_PARAM_PROPERTY_VALUE
        Constant for XPath parameter: Value
        See Also:
        Constant Field Values
      • XPATH_FIND_LAYOUT_PROPERTY_BY_PROPERTY_ID

        public static final java.lang.String XPATH_FIND_LAYOUT_PROPERTY_BY_PROPERTY_ID
        Constant for XPath key to fetch layout property by property unique ID
        See Also:
        Constant Field Values
      • XPATH_PARAM_LAYOUT_PROPERTY_ID

        public static final java.lang.String XPATH_PARAM_LAYOUT_PROPERTY_ID
        Constant for XPath parameter: LayoutPropertyID
        See Also:
        Constant Field Values
      • XPATH_FIND_STATIC_LAYOUT_LOCATION_BY_ID

        public static final java.lang.String XPATH_FIND_STATIC_LAYOUT_LOCATION_BY_ID
        Constant for XPath key to fetch layout static locations by unique ID.
        See Also:
        Constant Field Values
      • XPATH_PARAM_LAYOUT_LOCATION_STATIC_ID

        public static final java.lang.String XPATH_PARAM_LAYOUT_LOCATION_STATIC_ID
        Constant for XPath parameter: LayoutStaticLocationID
        See Also:
        Constant Field Values
      • XPATH_CHANGE_WIDGET_NOUN_PART

        public static final java.lang.String XPATH_CHANGE_WIDGET_NOUN_PART
        Constant representing the XPath Key for changing widgets.
        See Also:
        Constant Field Values
      • XPATH_CHANGE_WIDGET_EXTENDED_DATA_NOUN_PART

        public static final java.lang.String XPATH_CHANGE_WIDGET_EXTENDED_DATA_NOUN_PART
        Constant representing the XPath key for changing extended data for widgets.
        See Also:
        Constant Field Values
      • XPATH_KEY_FIND_LAYOUT_LOCATION_STATIC_FOR_USER

        public static final java.lang.String XPATH_KEY_FIND_LAYOUT_LOCATION_STATIC_FOR_USER
        XPath key to fetch Static location physical SDOs by Owner ID
        See Also:
        Constant Field Values
      • XPATH_PARAM_OWNER_ID

        public static final java.lang.String XPATH_PARAM_OWNER_ID
        XPath parameter : OWNER_ID
        See Also:
        Constant Field Values
      • ROOT_ORGANIZATION

        public static final java.lang.Long ROOT_ORGANIZATION
        The member ID for the root organization
      • RELATIONAL_PARAMETER_MANAGING_TOOL

        public static final java.lang.String RELATIONAL_PARAMETER_MANAGING_TOOL
        Constant representing the managing tool parameter in the search expression.
        See Also:
        Constant Field Values
      • RELATIONAL_PARAMETER_LAYOUT_STATE

        public static final java.lang.String RELATIONAL_PARAMETER_LAYOUT_STATE
        Constant representing the layout state parameter in the search expression.
        See Also:
        Constant Field Values
      • RELATIONAL_PARAMETER_OWNER_ID

        public static final java.lang.String RELATIONAL_PARAMETER_OWNER_ID
        Constant representing the OwnerID parameter in the search expression.
        See Also:
        Constant Field Values
      • RELATIONAL_PARAMETER_UNIQUE_ID

        public static final java.lang.String RELATIONAL_PARAMETER_UNIQUE_ID
        Constant representing the UniqueID parameter in the search expression.
        See Also:
        Constant Field Values
      • LAYOUT_STATE_ACTIVE

        public static final java.lang.String LAYOUT_STATE_ACTIVE
        Constant representing the active state of the layout.
        See Also:
        Constant Field Values
      • RELATIONAL_PARAMETER_SORT_BY

        public static final java.lang.String RELATIONAL_PARAMETER_SORT_BY
        Constant representing the sort by parameter in the search expression.
        See Also:
        Constant Field Values
      • RELATIONAL_PARAMETER_SORT_ORDER

        public static final java.lang.String RELATIONAL_PARAMETER_SORT_ORDER
        Constant representing the sort order parameter in the search expression.
        See Also:
        Constant Field Values
      • SORT_BY_TO_TABLE_COLUMN_MAPPING

        public static final java.lang.String SORT_BY_TO_TABLE_COLUMN_MAPPING
        Constant representing the mapping from sort by option to its corresponding table column
        See Also:
        Constant Field Values
      • CONFIG_PARAM_DEFAULT_SORT_BY

        public static final java.lang.String CONFIG_PARAM_DEFAULT_SORT_BY
        Constant representing the configuration parameter: defaultSortBy. This parameter sets the default sort by for an XPath that supports multiple sorting options.
        See Also:
        Constant Field Values
      • CONFIG_PARAM_DEFAULT_SORT_ORDER

        public static final java.lang.String CONFIG_PARAM_DEFAULT_SORT_ORDER
        Constant representing the configuration parameter: defaultSortOrder. This parameter sets the default sorting order for an XPath that supports multiple sorting options.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PageLayoutServerConstants

        public PageLayoutServerConstants()