Serialized Form

  • Package com.broadleafcommerce.customer.client.domain

    • Class com.broadleafcommerce.customer.client.domain.CustomerSegment

      class CustomerSegment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • active
          boolean active
        • additionalAttributes
          Map<String,Object> additionalAttributes
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • customerSegmentType
          CustomerSegmentType customerSegmentType
          The type of this customer segment. This could be a customer set, rule-based, or external.
          See Also:
          • CustomerSegment.segmentMatchRule
          • CustomerSegment.realtimeMatchRule
          • CustomerSegment.ruleEvaluationType
        • description
          String description
          The description of this customer segment.
        • externalRef
          String externalRef
          If the CustomerSegment.customerSegmentType is CustomerSegmentType.EXTERNAL, then this stores the identifier for the external segment.
        • id
          String id
        • internalEvaluationRequired
          boolean internalEvaluationRequired
          When CustomerSegment.ruleEvaluationType is DefaultCustomerSegmentRuleEvaluationType.REAL_TIME, indicates whether evaluation of the rule should be done in Customer Services specifically because it requires information that is only available in that service and not in the authorization token claims or a request attribute. This is typically something to avoid due to performance impact.
        • name
          String name
          The name of this customer segment.
        • priority
          Integer priority
          The priority of this customer segment. This is to enforce ordering when a customer may belong to multiple segments. A lower value indicates higher priority.
        • processingState
          String processingState
          The current processing state of this segment.

          While this value is set on every segment for simplicity, the default behavior is that this value is only used of on rule based customer segments. This field not applicable for static segments, such as customer sets.

          The following describes the default processing states, and how these states are determined:

          • New Segment Created: INITIALIZATION_REQUIRED
          • Segment currently processing: PROCESSING
          • Segment finished processing: READY
          • Dirty Segment (Such as an update action on a segment, or a new customer is created but not immediately processed upon creation): UPDATE_REQUIRED
          See Also:
        • realtimeMatchRule
          String realtimeMatchRule
          The rule(s) for this customer segment if rule based and using real-time evaluation. The default behavior is an SpEL filter. This is separate from CustomerSegment.segmentMatchRule so that it can be validating using RuleValidate.
          See Also:
          • CustomerSegment.ruleEvaluationType
        • ruleEvaluationType
          String ruleEvaluationType
          Indicates whether the CustomerSegment.segmentMatchRule is evaluated or CustomerSegment.realtimeMatchRule. This also determines the format of the rule such as RSQL for offline or SpEL for real-time.
          See Also:
        • segmentMatchRule
          String segmentMatchRule
          The rule(s) for this customer segment if rule based and using offline evaluation. The default behavior is an RSQL filter.
          See Also:
          • CustomerSegment.ruleEvaluationType

    • Class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef

      class CustomerSegmentRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • externalRef
          String externalRef
          If the customerSegmentType is CustomerSegmentType.EXTERNAL, then this stores the identifier for the external segment.
        • id
          String id
        • name
          String name
          The name of this customer segment.
        • priority
          Integer priority
          The priority of this customer segment. This is to enforce ordering when a customer may belong to multiple segments. A lower value indicates higher priority.

    • Class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse

      class ResolveCustomerSegmentResponse extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest

      class ResolveCustomerSegmentsRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountHierarchy
          List<String> accountHierarchy
          The hierarchy of accounts, from the root account to the account member's account.

          For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be [rootAcct, subAcct, subSubAcct]. This is useful to have queries include sub-accounts.

        • accountId
          String accountId
          The ID of the account the user belongs to.
        • attributes
          Map<String,Object> attributes
          Additional, arbitrary request attributes. The attributes included in this map are determined by the list defined by the property CustomerSegmentResolutionProperties.getRequestAttributeList(). The property path is determined by the service using this client library such as broadleaf.catalogbrowse.context.customer-segment-customizer.request-attribute-list.
        • email
          String email
          The user's email.
        • fullName
          String fullName
          The user's full name.
        • phoneNumber
          String phoneNumber
          The user's phone number.
        • prefetchedSegmentIdsToEvaluate
          List<String> prefetchedSegmentIdsToEvaluate
          List of ids of any prefetched CustomerSegments to evaluate whether they apply to the request. This list will be used instead of looking up all rule-based or directly assigned customer segments.

          Typically, this will only include the ids of rule-based segments with evaluation type DefaultCustomerSegmentRuleEvaluationType.REAL_TIME as other segments should already be known from the user's auth token claims.

        • registered
          boolean registered
          Defines whether the user is registered. If false, then the user is considered anonymous.
        • rootAccountId
          String rootAccountId
          The ID of the root account the account member belongs to.
        • userId
          String userId
          The user's id.
        • username
          String username
          The user's username.

  • Package com.broadleafcommerce.customer.client.exception