Class ChangeSummaries

java.lang.Object
com.broadleafcommerce.sandbox.domain.ChangeSummaries

public class ChangeSummaries extends Object
Request construct that details a list of ChangeSummary.getId() values to operate on. Alternatively, this construct can define "all change summaries" via the allChangeSummaries property.
Author:
Jeff Fischer
  • Constructor Details

    • ChangeSummaries

      public ChangeSummaries()
  • Method Details

    • getChangeSummaryIds

      public List<String> getChangeSummaryIds()
      The list of id values for ChangeSummary instances that should be targeted for the API request.
      Returns:
      The list of id values for ChangeSummary instances that should be targeted
    • isAllChangeSummaries

      public boolean isAllChangeSummaries()
      Whether or not all valid ChangeSummaries for the current request context (e.g. all user-level ChangeSummary instances belonging to an author) should be included. If true, changeSummaryIds is optional (if provided, it will be used). The default value is false.
      Returns:
      Whether or not all valid ChangeSummaries for the current request context should be included
    • setChangeSummaryIds

      public void setChangeSummaryIds(List<String> changeSummaryIds)
      The list of id values for ChangeSummary instances that should be targeted for the API request.
      Parameters:
      changeSummaryIds - The list of id values for ChangeSummary instances that should be targeted
    • setAllChangeSummaries

      public void setAllChangeSummaries(boolean allChangeSummaries)
      Whether or not all valid ChangeSummaries for the current request context (e.g. all user-level ChangeSummary instances belonging to an author) should be included. If true, changeSummaryIds is optional (if provided, it will be used). The default value is false.
      Parameters:
      allChangeSummaries - Whether or not all valid ChangeSummaries for the current request context should be included
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object