Interface VersionDef

All Superinterfaces:
Adaptable

public interface VersionDef extends Adaptable
Represents a version of a content item (like the entire fragment, an element or a variation of it).

Instances of this interface are considered to hold "lightweight" representations of a version - they're just defining the basic data required to reference a version, not to access its content.

To access the actual versioned content, see Versionable.getVersion(VersionDef).

  • Method Summary

    Modifier and Type
    Method
    Description
    Gets a human-readable description of the represented version.
    Gets a text-based identifier for the represented version.

    Methods inherited from interface org.apache.sling.api.adapter.Adaptable

    adaptTo
  • Method Details

    • getIdentifier

      String getIdentifier()
      Gets a text-based identifier for the represented version.

      The identifier has to be unique for the implementation. Otherwise, it is left to the implementation what that identifier may look like.

      Returns:
      The text-based identifier for the version
    • getDescription

      String getDescription()
      Gets a human-readable description of the represented version.
      Returns:
      The human-readable description for the version