Package com.day.cq.wcm.msm.api

Interface LiveStatus

All Superinterfaces:
JSONItem
@ProviderType public interface LiveStatus extends JSONItem

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Boolean>
    getAdvancedStatus()
    Returns a map of pairs (name, status) which contains advanced status for the current relationship.
    Boolean
    getAdvancedStatus(String status)
    Returns value of an advanced status.
    List<String>
    getCanceledProperties()
    Returns names of properties for which inheritance is canceled.
    Date
    getLastRolledOut()
    Return the timestamp of the last roll-out on the LiveRelationship this is the LiveStatus for.
    String
    getLastRolledOutBy()
    Return an identifier for the User that triggered the last Roll-out on the LiveRelationship this is the LiveStatus for.
    boolean
    isCancelled()
    Returns true if relationship is cancelled
    boolean
    isCancelledForChildren()
    Returns true if relationship is cancelled for children relationships.
    boolean
    isEditable()
    Returns true if relationship can be edited, ie can be cancelled.
    boolean
    isPage()
    Returns true if relationship concerns a page, false if it concerns a paragraph
    boolean
    isSourceExisting()
    Returns true if relationship's source exists
    boolean
    isTargetExisting()
    Returns true if relationship's target exists

    Methods inherited from interface com.day.cq.commons.JSONItem

    write

  • Method Details

    • isCancelled

      boolean isCancelled()
      Returns true if relationship is cancelled
      Returns:
      true if relationship is cancelled

    • isCancelledForChildren

      boolean isCancelledForChildren()
      Returns true if relationship is cancelled for children relationships. Only possible if isCancelled() is true.
      Returns:
      true if relationship is cancelled for children relationships

    • isEditable

      boolean isEditable()
      Returns true if relationship can be edited, ie can be cancelled.
      Returns:
      true if relationship can be edited

    • isSourceExisting

      boolean isSourceExisting()
      Returns true if relationship's source exists
      Returns:
      true if relationship's source exists

    • isTargetExisting

      boolean isTargetExisting()
      Returns true if relationship's target exists
      Returns:
      true if relationship's target exists

    • getAdvancedStatus

      Map<String,Boolean> getAdvancedStatus()
      Returns a map of pairs (name, status) which contains advanced status for the current relationship.
      Returns:
      map of status

    • getAdvancedStatus

      Boolean getAdvancedStatus(String status)
      Returns value of an advanced status.
      Parameters:
      status - the name of the status to be accessed
      Returns:
      value of advanced status

    • isPage

      boolean isPage()
      Returns true if relationship concerns a page, false if it concerns a paragraph
      Returns:
      true if relationship concerns a page

    • getCanceledProperties

      List<String> getCanceledProperties()
      Returns names of properties for which inheritance is canceled.
      Returns:
      value of advanced status

    • getLastRolledOutBy

      String getLastRolledOutBy()
      Return an identifier for the User that triggered the last Roll-out on the LiveRelationship this is the LiveStatus for. The identifier matches the one of the ResourceResolver used (s. ResourceResolver.getUserID()).
      The returned value can be null. Such cases could be. A LiveRelationship that has never been rolled out, has a no LiveStatus for the User
      Returns:
      an identifier of the subject that triggered the last Roll-out.
      Since:
      5.8.0
      See Also:

    • getLastRolledOut

      Date getLastRolledOut()
      Return the timestamp of the last roll-out on the LiveRelationship this is the LiveStatus for. It is not necessary that the Resource changed at that time. The returned value can be null in case of a LiveStatus for a LiveRelationship that has never been rolled-out.
      Returns:
      Calendar of the time the LiveRelationship this LiveStatus is for was roll-ed out
      Since:
      5.8.0
      See Also: