Package com.ebasetech.xi.api

Interface Snapshot

public interface Snapshot
Interface Snapshot represents a snapshot that contains all of the form and user state when created. See SnapshotManager.createSnapshot(Map, Date) for details.

Further documentation.

Since:
V4.4

  • Method Summary

    Modifier and Type Method Description
    java.util.Date getCreationDate()
    Returns the date the snapshot is created.
    java.util.Date getExpiryDate()
    Returns the expiry date used to create the snapshot or null if the snapshot never expires.
    java.util.Map<java.lang.String,​java.lang.String> getFields()
    Returns a map of snapshot fields that contain key value pairs (additional information for a snapshot) or null if no additional information exists.
    java.lang.String getSnapshotId()
    Returns the snapshot id which is a unique identifier generated automatically and cannot be changed.

  • Method Details

    • getSnapshotId

      java.lang.String getSnapshotId()
      Returns the snapshot id which is a unique identifier generated automatically and cannot be changed.

      Further documentation.

      Since:
      V4.4

    • getCreationDate

      java.util.Date getCreationDate()
      Returns the date the snapshot is created. This is automatically generated and cannot be changed
      Since:
      V4.4

    • getExpiryDate

      java.util.Date getExpiryDate()
      Returns the expiry date used to create the snapshot or null if the snapshot never expires.
      Since:
      V4.4

    • getFields

      java.util.Map<java.lang.String,​java.lang.String> getFields()
      Returns a map of snapshot fields that contain key value pairs (additional information for a snapshot) or null if no additional information exists. Additional information may include security questions, password, user name, application identifier etc...
      Since:
      V4.4