Package com.broadleafcommerce.data.tracking.core.filtering.domain

Interface ChangeDetail

All Known Implementing Classes:
DefaultChangeDetail
public interface ChangeDetail
Before and after change information per property. This information is used to drive sandbox promotions, as well as audit history.
Author:
Jeff Fischer

  • Method Details

    • getFieldName

      String getFieldName()
      The name of the field on the repository domain class instance that was changed
      Returns:
      The name of the field that was changed

    • getBusinessFieldName

      String getBusinessFieldName()
      The name of the field on the business domain class instance that was changed
      Returns:
      The name of the field that was changed

    • getBeforeValue

      String getBeforeValue()
      The value of the field before it was changed
      Returns:
      The value of the field before it was changed

    • getAfterValue

      String getAfterValue()
      The value of the field after it was changed
      Returns:
      The value of the field after it was changed

    • getFieldType

      String getFieldType()
      The Java type for the field
      Returns:
      The Java type for the field

    • getSerializedFieldType

      String getSerializedFieldType()
      Base64 encoded, Serialized JavaType instance used when reconstructing a field value.
      Returns:
      serialized JavaType

    • getTimestamp

      Instant getTimestamp()
      The local time the change was made
      Returns:
      The local time the change was made

    • getAuthor

      String getAuthor()
      The user that engaged the change
      Returns:
      The user that engaged the change

    • getChangeType

      String getChangeType()
      The CRUD type for the change. See OperationType
      Returns:
      The CRUD type for the change

    • isEmbeddedCollection

      boolean isEmbeddedCollection()
      Whether this change detail is for a field that is an embedded collection. This is used to enhance performance when building ContextState for ContextStateAware entities.
      Returns:
      Whether this change detail is for a field that is an embedded collection

    • setEmbeddedCollection

      void setEmbeddedCollection(boolean embeddedCollection)
      Set the flag that identifies whether this change detail is for a field that is an embedded collection. This is used to enhance performance when building ContextState for ContextStateAware entities.
      Parameters:
      embeddedCollection - Whether this change detail is for a field that is an embedded collection

    • setFieldName

      void setFieldName(String fieldName)
      The name of the field on the repository domain class instance that was changed
      Parameters:
      fieldName - The name of the field that was changed

    • setBusinessFieldName

      void setBusinessFieldName(String businessFieldName)
      The name of the field on the business domain class instance that was changed
      Parameters:
      businessFieldName - The name of the field that was changed

    • setBeforeValue

      void setBeforeValue(String beforeValue)
      The value of the field before it was changed
      Parameters:
      beforeValue - The value of the field before it was changed

    • setAfterValue

      void setAfterValue(String afterValue)
      The value of the field after it was changed
      Parameters:
      afterValue - The value of the field after it was changed

    • setFieldType

      void setFieldType(String fieldType)
      The Java type for the field
      Parameters:
      fieldType - The Java type for the field

    • setSerializedFieldType

      void setSerializedFieldType(String serializedType)
      Base64 encoded, Serialized JavaType instance used when reconstructing a field value.
      Parameters:
      serializedType - serialized JavaType

    • setTimestamp

      void setTimestamp(Instant timestamp)
      The local time the change was made
      Parameters:
      timestamp - The local time the change was made

    • setAuthor

      void setAuthor(String author)
      The user that engaged the change
      Parameters:
      author - The user that engaged the change

    • setChangeType

      void setChangeType(String operationType)
      The CRUD type for the change. See OperationType
      Parameters:
      operationType - The CRUD type for the change

    • getPropagationId

      String getPropagationId()
      Non-persistent field used to track a change related to a deployment propagation. This is only used in catalog discriminated entities during deployment.
      Returns:
      the identifier for a specific propagation flow

    • setPropagationId

      void setPropagationId(String propagationId)
      Non-persistent field used to track a change related to a deployment propagation. This is only used in catalog discriminated entities during deployment.
      Parameters:
      propagationId - the identifier for a specific propagation flow

    • getPromotionId

      String getPromotionId()
      Used to track a change related to a forward promotion operation.
      Returns:
      the identifier for a specific promotion flow

    • setPromotionId

      void setPromotionId(String promotionId)
      Used to track a change related to a forward promotion operation.
      Parameters:
      promotionId - the identifier for a specific promotion flow

    • getMessage

      String getMessage()
      User defined message describing the purpose of the change. This is optional.
      Returns:
      User defined message describing the purpose of the change

    • setMessage

      void setMessage(String message)
      User defined message describing the purpose of the change. This is optional.
      Parameters:
      message - User defined message describing the purpose of the change

    • getObsolete

      Boolean getObsolete()
      Whether or not this change has already been advanced.
      Returns:
      Whether or not this change has already been advanced.

    • setObsolete

      void setObsolete(Boolean obsolete)
      Whether or not this change has already been advanced.
      Parameters:
      obsolete - Whether or not this change has already been advanced.

    • getVersion

      String getVersion()
      An indicator of change state for a sandbox entity. The highest change detail version on an entity in an indicator of it's current state. This is primarily used during deploy operations where it's important to understand the state being requested for deployment.
      Returns:
      An indicator of change state for a sandbox entity

    • setVersion

      void setVersion(String version)
      An indicator of change state for a sandbox entity. The highest change detail version on an entity in an indicator of it's current state. This is primarily used during deploy operations where it's important to understand the state being requested for deployment.
      Parameters:
      version - An indicator of change state for a sandbox entity

    • getRejected

      Boolean getRejected()
      Whether or not this change represents a rejected change
      Returns:
      Whether or not this change represents a rejected change

    • setRejected

      void setRejected(Boolean rejected)
      Whether or not this change represents a rejected change
      Parameters:
      rejected - Whether or not this change represents a rejected change

    • getRebased

      Boolean getRebased()
      Whether or not this change was inherited as part of a WorkflowMapper#rebaseMap(Trackable, Trackable)
      Returns:
      Whether or not this change was inherited as part of a WorkflowMapper#rebaseMap(Trackable, Trackable).

    • setRebased

      void setRebased(Boolean rebased)
      Whether or not this change was inherited as part of a WorkflowMapper#rebaseMap(Trackable, Trackable)
      Parameters:
      rebased - Whether or not this change was inherited as part of a WorkflowMapper#rebaseMap(Trackable, Trackable)

    • getLevel

      Integer getLevel()
      Used to determine whether or not a change is a user sandbox change, a higher level sandbox change, or a production change. See TrackingLevel. This value is often used to determine the origin of a change after a rebase operation.
      Returns:
      The current state of an change as it relates to sandbox or production status

    • setLevel

      void setLevel(Integer level)
      Used to determine whether or not a change is a user sandbox change, a higher level sandbox change, or a production change. See TrackingLevel. This value is often used to determine the origin of a change after a rebase operation.

    • effectiveEqual

      default boolean effectiveEqual(ChangeDetail other)