Package com.day.cq.wcm.api

Class PageModification

java.lang.Object
com.day.cq.wcm.api.PageModification
All Implemented Interfaces:
Serializable
public final class PageModification extends Object implements Serializable
This class encapsulates the information coming along with a page modification.
See Also:

  • Method Details

    • created

      public static PageModification created(String path, String above, String userId)
      Create a new PageModification that represents a page creation.
      Parameters:
      path - path to new page
      above - label of successor sibling
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • modified

      public static PageModification modified(String path, String vid, String userId, Set<String> changes)
      Create a new PageModification that represents a page modification.
      Parameters:
      path - path of page
      vid - the version name
      userId - the id of the user that caused this modification.
      changes - A set of changes (paths) - optional
      Returns:
      modification

    • moved

      public static PageModification moved(String path, String destination, String above, String userId)
      Create a new PageModification that represents a page moval.
      Parameters:
      path - path of page
      destination - new page destination, may be null
      above - label of successor sibling, may be null
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • deleted

      public static PageModification deleted(String path, String userId)
      Create a new PageModification that represents a page deletion.
      Parameters:
      path - path of page
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • versionCreated

      public static PageModification versionCreated(String path, String vid, String userId)
      Create a new PageModification that represents a version created.
      Parameters:
      path - path of page
      vid - the versio name
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • pageRestored

      public static PageModification pageRestored(String path, String vid, String userId)
      Create a new PageModification that represents a version created.
      Parameters:
      path - path of page
      vid - the vesion name
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • pageValid

      public static PageModification pageValid(String path, long time)
      Create a new PageModification that represents that the page became valid due to an on-time reached.
      Parameters:
      path - path of page
      time - the on-time
      Returns:
      modification

    • pageInvalid

      public static PageModification pageInvalid(String path, long time)
      Create a new PageModification that represents that the page became invalid due to an off-time reached.
      Parameters:
      path - path of page
      time - the off-time
      Returns:
      modification

    • rolledout

      public static PageModification rolledout(String path, String userId)
      Create a new PageModification that represents a version deleted.
      Parameters:
      path - path of page
      userId - the id of the user that caused this modification.
      Returns:
      modification

    • getPath

      public String getPath()
      The path of the page.
      Returns:
      The path of the page.

    • getDestination

      public String getDestination()

    • getAbove

      public String getAbove()

    • getType

      public PageModification.ModificationType getType()

    • getVersionId

      public String getVersionId()

    • getUserId

      public String getUserId()

    • getModificationDate

      public Date getModificationDate()

    • getModificationPaths

      public Set<String> getModificationPaths()
      Get the list of changes for a modification of the page.
      Returns:
      A set of relative paths or null.

    • equals

      public final boolean equals(Object o)
      Overridden to alter the preconditions when two modifications are considered equal.
      Overrides:
      equals in class Object
      Parameters:
      o - object to compare this object against
      Returns:
      true if this object is considered equal to the other object, otherwise false

    • hashCode

      public int hashCode()
      Returns a hash code value for the object. Replaced in order to return the same hashcode for two objects that are considered equal according to the equals(java.lang.Object) method implemented above.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object.
      See Also:

    • toString

      public String toString()
      Return a string representation of this object
      Overrides:
      toString in class Object
      Returns:
      string representation

    • getEventProperties

      public Map<String,Object> getEventProperties()
      Get a dictionary with all event properties.
      Returns:
      an map of event properties

    • fromEventProperties

      public static PageModification fromEventProperties(Map<String,Object> props)
      Create a page modification from properties.
      Parameters:
      props - the event properties
      Returns:
      a page modification object

    • toEvent

      public Event toEvent()
      Convert a single modification to an event.
      Returns:
      a page event