Package com.adobe.cq.launches.api

Interface Launch

All Superinterfaces:
Comparable<Launch>
All Known Subinterfaces:
ContentFragmentLaunch
public interface Launch extends Comparable<Launch>
Represents a Launch (Future versions of resources).

  • Method Details

    • getResource

      Resource getResource()
      Returns the launch resource
      Returns:
      Launch resource

    • getRootResource

      Resource getRootResource()
      Returns the launch root resource (in the launch tree)
      Returns:
      Launch root resource

    • getLaunchSources

      List<LaunchSource> getLaunchSources()
      Returns the list of Launch Sources (in the launch tree)
      Returns:
      LaunchSource List

    • getSourceRootResource

      @Deprecated Resource getSourceRootResource()
      Deprecated.
      Returns the root resource the launch belongs to (in the production tree)
      Returns:
      Launch source root resource

    • getTitle

      String getTitle()
      Returns the title of the Launch
      Returns:
      Launch title

    • getLiveDate

      Calendar getLiveDate()
      Returns the targeted live date for the launch
      Returns:
      Launch live date

    • isProductionReady

      boolean isProductionReady()
      Returns true if the current Launch is production ready If a target live date is set and this flag is set to true, the launch will automatically be promoted and activated at this date
      Returns:
      true if the launch is production ready

    • isLiveCopy

      boolean isLiveCopy()
      Returns true if the current Launch is a live copy
      Returns:
      true if the launch is a live copy

    • isDeep

      @Deprecated boolean isDeep()
      Deprecated.
      Returns true if the current Launch has been created with inclusion of sub pages
      Returns:
      true if the launch is deep

    • getCreated

      Calendar getCreated()
      This method returns the date and time this launch was created
      Returns:
      A Calendar representing the creation date and time

    • getCreatedBy

      String getCreatedBy()
      Returns the id of the user that added this launch
      Returns:
      The identifier of the user who added this launch

    • getModified

      Calendar getModified()
      Returns the date the definition of this launch was last modified
      Returns:
      The date of last modification or the value of getCreated() if never modified.

    • getModifiedBy

      String getModifiedBy()
      Returns the id of the user that effected the last modification of this launch
      Returns:
      The identifier of the user who last modified this launch or the value of getCreatedBy() if never modified

    • getLastPromoted

      Calendar getLastPromoted()
      Returns the date the launch was last promoted
      Returns:
      The date of last promotion or null if never promoted.

    • getLastPromotedBy

      String getLastPromotedBy()
      Returns the id of the user that effected the last promotion of this launch
      Returns:
      The identifier of the user who last promoted this launch or null if never promoted

    • containsResource

      boolean containsResource(Resource productionResource)
      Returns true if the launch contains the provided production resource
      Parameters:
      productionResource - Production resource
      Returns:
      true if the launch contains the provided production resource

    • compareTo

      int compareTo(Launch launch)
      Compares the current launch with another one for sorting. The current launch is supposed to be listed before the provided launch:
      • if the latest is null
      • if its live date comparison returns a negative value
      • if its creation date comparison returns a negative value
      • if its path comparison returns a negative value
      Specified by:
      compareTo in interface Comparable<Launch>
      Parameters:
      launch - The launch which has to be compared with the current one
      Returns:
      a negative integer, zero, or a positive integer as this launch is less than, equal to, or greater than the specified one.
      See Also:

    • getLaunchAutoPromotionScope

      LaunchPromotionScope getLaunchAutoPromotionScope()
      Returns the LaunchPromotionScope of the launch
      Returns:
      LaunchPromotionScope of the launch if exists. Otherwise null is returned.