Package com.i2group.disco.audit

Interface IWebChartSessionOpenAuditEvent

All Superinterfaces:
IAuditEvent
public interface IWebChartSessionOpenAuditEvent extends IAuditEvent
An event that was generated when a principal attempted to open a web chart session. IWebChartSessionOpenAuditEvent makes information about the operation available to the audit logging mechanism.

Recorded for both a successful open and a denied attempt, distinguished by getOutcome() — there is no separate "chart session open denied" event. Recorded for both an open for editing and a read-only open, distinguished by isReadOnly().

Since:
13.8

  • Method Details

    • getChartId

      String getChartId()
      Gets the identifier of the web chart session that the principal attempted to open.
      Returns:
      See above.

    • getOutcome

      WebChartSessionOpenOutcome getOutcome()
      Gets the WebChartSessionOpenOutcome of the attempt.
      Returns:
      See above.

    • getLockHolderUserId

      Optional<String> getLockHolderUserId()
      Gets the identifier of the user who currently holds the web chart's edit lease, when getOutcome() is WebChartSessionOpenOutcome.FAILED_LOCKED.
      Returns:
      See above. Empty for every other outcome.

    • isReadOnly

      boolean isReadOnly()
      Indicates whether the principal attempted to open the web chart session read-only, without taking its edit lease or control of it. A read-only open is recorded with the same outcomes as an open for editing, except that it is never WebChartSessionOpenOutcome.FAILED_LOCKED.
      Returns:
      true if the attempt was a read-only open; false if it was an open for editing, or the creation of a web chart.