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

Class PageLocationActivityESpot

  • All Implemented Interfaces:
    java.lang.Comparable<PageLocationActivityESpot>

    public class PageLocationActivityESpot
extends AbstractPageLayoutActivityESpot
implements java.lang.Comparable<PageLocationActivityESpot>
    This class represents a value object for a Page Location Activity ESpot.

    A Page Location Activity ESpot has the following Naming Conventions:

    • <pageGroup>_<objectId>
      • e.g. "Category_10008", which specifies the Category Page for the Category Id 10008.
    • <pageGroup>_<objectId>_<subPageGroup>
      • e.g. "Category_10008_CatalogEntry", which specifies all the sub Catalog Entry Pages under the Category with Id 10008.
    See Also:
    AbstractPageLayoutActivityESpot

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String buildESpotName()
      This method builds the ESpot Name using the following naming conventions: <pageGroup>_<objectId> e.g.
      int compareTo(PageLocationActivityESpot o)
      Compares this object with the specified object to determine if the ESpot Name is similar or different.
      java.lang.String getObjectId()
      Returns the Object Id of this Page Location Activity ESpot.
      java.lang.String getObjectName()
      Returns the Object Name of this Page Location Activity ESpot.
      java.lang.String getPageGroup()
      Returns the Page Group of this Page Location Activity ESpot.
      java.lang.String getStoreId()
      Returns the Store Id of this Page Location Activity ESpot.
      java.lang.String getSubPageGroup()
      Returns the Sub-Page Group of this Page Location Activity ESpot.
      void setObjectId(java.lang.String objectId)
      Sets the Object Id of this Page Location Activity ESpot.
      void setObjectName(java.lang.String objectName)
      Sets the Object Name of this Page Location Activity ESpot.
      void setPageGroup(java.lang.String pageGroup)
      Sets the Page Group of this Page Location Activity ESpot.
      void setStoreId(java.lang.String storeId)
      Sets the Store Id of this Page Location Activity ESpot.
      void setSubPageGroup(java.lang.String subPageGroup)
      Sets the Sub-Page Group of this Page Location Activity ESpot.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PageLocationActivityESpot

        public PageLocationActivityESpot()
        Default Constructor.

    • Method Detail

      • getPageGroup

        public final java.lang.String getPageGroup()
        Returns the Page Group of this Page Location Activity ESpot.
        Returns:
        The Page Group of this Page Location Activity ESpot.

      • setPageGroup

        public final void setPageGroup(java.lang.String pageGroup)
        Sets the Page Group of this Page Location Activity ESpot.
        Parameters:
        pageGroup - The Page Group to set.

      • getObjectId

        public final java.lang.String getObjectId()
        Returns the Object Id of this Page Location Activity ESpot.
        Returns:
        The Object Id of this Page Location Activity ESpot.

      • setObjectId

        public final void setObjectId(java.lang.String objectId)
        Sets the Object Id of this Page Location Activity ESpot.
        Parameters:
        objectId - The Object Id to set.

      • getSubPageGroup

        public final java.lang.String getSubPageGroup()
        Returns the Sub-Page Group of this Page Location Activity ESpot.
        Returns:
        The Sub-Page Group of this Page Location Activity ESpot.

      • setSubPageGroup

        public final void setSubPageGroup(java.lang.String subPageGroup)
        Sets the Sub-Page Group of this Page Location Activity ESpot.
        Parameters:
        subPageGroup - The Sub-Page Group to set.

      • getObjectName

        public final java.lang.String getObjectName()
        Returns the Object Name of this Page Location Activity ESpot.
        Returns:
        The Object Name of this Page Location Activity ESpot.

      • setObjectName

        public final void setObjectName(java.lang.String objectName)
        Sets the Object Name of this Page Location Activity ESpot.
        Parameters:
        objectName - The Object Name to set.

      • getStoreId

        public final java.lang.String getStoreId()
        Returns the Store Id of this Page Location Activity ESpot.
        Returns:
        The Store Id of this Page Location Activity ESpot.

      • setStoreId

        public final void setStoreId(java.lang.String storeId)
        Sets the Store Id of this Page Location Activity ESpot.
        Parameters:
        storeId - The Store Id to set.

      • buildESpotName

        public java.lang.String buildESpotName()
        This method builds the ESpot Name using the following naming conventions:
        • <pageGroup>_<objectId>
          • e.g. "Category_10008", which specifies the Category Page for the Category Id 10008.
        • <pageGroup>_<objectId>_<subPageGroup>
          • e.g. "Category_10008_CatalogEntry", which specifies all the sub Catalog Entry Pages under the Category with Id 10008.
        Specified by:
        buildESpotName in class AbstractPageLayoutActivityESpot
        Returns:
        The ESpot Name, e.g. "Category_10008".

      • compareTo

        public int compareTo(PageLocationActivityESpot o)
        Compares this object with the specified object to determine if the ESpot Name is similar or different.
        Specified by:
        compareTo in interface java.lang.Comparable<PageLocationActivityESpot>
        Parameters:
        o - The PageLocationActivityESpot to compare to.
        Returns:
        0 if the ESpot names are the same, negative otherwise.
Skip navigation links