Package com.broadleafcommerce.bulk.v2.domain

Class BulkOperationRequest

java.lang.Object
com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest
All Implemented Interfaces:
Serializable
public class BulkOperationRequest extends Object implements Serializable
The request DTO which should be sent by API callers to request the creation of a bulk operation.
See Also:

  • Constructor Details

    • BulkOperationRequest

      public BulkOperationRequest()

  • Method Details

    • addOperationData

      public void addOperationData(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute

    • getOperationData

      public Map<String,Object> getOperationData()
      Return any additional attributes passed in the request not matching any defined properties.
      Returns:
      any additional attributes passed in the request not matching any defined properties.

    • getName

      public String getName()
      The friendly name of the bulk operation.

    • getEntityType

      @Nullable public String getEntityType()
      The type of entity to operate on. Optional.

    • getQuery

      @Nullable public String getQuery()
      The search query string to lookup searchable entities to operate on. Optional.

    • getFilters

      public List<SearchFilter> getFilters()
      A list of search filters to identify the entities to operate on.

    • getOperationType

      public String getOperationType()
      The type of bulk operation to perform.

    • getInclusions

      public List<String> getInclusions()
      A list of entity context IDs which should receive updates. If this list is populated, the search filters & query are ignored in favor of this list.

    • getExclusions

      public List<String> getExclusions()
      A list of entity context IDs which should not receive updates. The entities for these IDs will be filtered out after performing a search based on the query & filters.

    • getSandboxId

      public String getSandboxId()
      The ID of the sandbox these changes should be contained within.

    • getAuthor

      public String getAuthor()
      The author of these bulk operation changes.

    • isTemporarySandbox

      public boolean isTemporarySandbox()
      Whether the sandbox is temporary and should be deleted after the bulk operation is complete.

    • setName

      public void setName(String name)
      The friendly name of the bulk operation.

    • setEntityType

      public void setEntityType(@Nullable String entityType)
      The type of entity to operate on. Optional.

    • setQuery

      public void setQuery(@Nullable String query)
      The search query string to lookup searchable entities to operate on. Optional.

    • setFilters

      public void setFilters(List<SearchFilter> filters)
      A list of search filters to identify the entities to operate on.

    • setOperationType

      public void setOperationType(String operationType)
      The type of bulk operation to perform.

    • setInclusions

      public void setInclusions(List<String> inclusions)
      A list of entity context IDs which should receive updates. If this list is populated, the search filters & query are ignored in favor of this list.

    • setExclusions

      public void setExclusions(List<String> exclusions)
      A list of entity context IDs which should not receive updates. The entities for these IDs will be filtered out after performing a search based on the query & filters.

    • setSandboxId

      public void setSandboxId(String sandboxId)
      The ID of the sandbox these changes should be contained within.

    • setAuthor

      public void setAuthor(String author)
      The author of these bulk operation changes.

    • setTemporarySandbox

      public void setTemporarySandbox(boolean isTemporarySandbox)
      Whether the sandbox is temporary and should be deleted after the bulk operation is complete.

    • setOperationData

      public void setOperationData(Map<String,Object> operationData)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • 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