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

Class AbstractPageLayoutActivityESpot

  • java.lang.Object
    • com.ibm.commerce.pagelayout.facade.server.helpers.activity.AbstractPageLayoutActivityESpot
  • Direct Known Subclasses:
    PageLocationActivityESpot


    public abstract class AbstractPageLayoutActivityESpot
    extends java.lang.Object
    This class is the base class for a Page Layout Activity ESpot.

    This class is used in conjunction with AbstractPageLayoutActivityHelper and AbstractPageLayoutActivity. A Page Layout Activity follows a naming convention where the ESpot Name itself identifies a specific Page, e.g. a name like "Category_1008" identifies that the ESpot corresponds to a Category Page and the Id of the Category is 10008. This class contains methods that parses the ESpot Name into different properties like page group, id, etc, and also contains methods to do the reverse - to build the ESpot Name for the specified properties.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      abstract java.lang.String buildESpotName()
      This method builds the ESpot Name using the ESpot properties present in this ESpot.
      java.lang.String toString()
      Returns the string representation of the properties of this ESpot.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AbstractPageLayoutActivityESpot

        public AbstractPageLayoutActivityESpot()
        Default Constructor.
    • Method Detail

      • buildESpotName

        public abstract java.lang.String buildESpotName()
        This method builds the ESpot Name using the ESpot properties present in this ESpot.

        The child classes that extend this class must implement this method according to the ESpot Naming Convention that it follows.

        Returns:
        The ESpot Name, e.g. "Category_10008".
      • toString

        public java.lang.String toString()
        Returns the string representation of the properties of this ESpot.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation of the properties of this ESpot.
        See Also:
        buildProperties()