Interface SRevisionLog

All Known Implementing Classes:
RevisionLogImpl

public interface SRevisionLog
Manages the revision log for a workbook. Controls whether change tracking is enabled and provides operations to accept/reject revisions.
Since:
7.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Accepts all tracked revisions.
    void
    acceptRevision(long id)
    Accepts the specified revision.
    Returns all tracked revisions in chronological order.
    boolean
    Returns whether change tracking is currently enabled.
    void
    Rejects all tracked revisions.
    void
    rejectRevision(long id)
    Rejects the specified revision.
    void
    Starts tracking changes.
    void
    Stops tracking changes.
  • Method Details

    • getRevisions

      List<SRevision> getRevisions()
      Returns all tracked revisions in chronological order.
      Returns:
      an unmodifiable list of revisions
    • isTracking

      boolean isTracking()
      Returns whether change tracking is currently enabled.
      Returns:
      true if tracking is enabled
    • startTracking

      void startTracking()
      Starts tracking changes. New modifications will be recorded as revisions.
    • stopTracking

      void stopTracking()
      Stops tracking changes. No new revisions will be recorded.
    • acceptRevision

      void acceptRevision(long id)
      Accepts the specified revision. The change is kept and the revision record is removed.
      Parameters:
      id - the revision ID to accept
    • rejectRevision

      void rejectRevision(long id)
      Rejects the specified revision. The change is undone and the revision record is removed.
      Parameters:
      id - the revision ID to reject
    • acceptAll

      void acceptAll()
      Accepts all tracked revisions.
    • rejectAll

      void rejectAll()
      Rejects all tracked revisions.