Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
B
- buildNotFoundException(ObjectMapper, WebClientResponseException.NotFound) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Builds a not found exception that correlates to the given
WebClientResponseException.NotFound
exception. - buildResolutionRequest(ContextInfo, String, NativeWebRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
-
Builds the
ResolveCustomerSegmentsRequest
against which the resolvedCustomerSegments
are evaluated to determine if they match the current context.
C
- canEqual(Object) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- canEqual(Object) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- canEqual(Object) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
- canEqual(Object) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
- com.broadleafcommerce.customer.client.autoconfigure - package com.broadleafcommerce.customer.client.autoconfigure
- com.broadleafcommerce.customer.client.context - package com.broadleafcommerce.customer.client.context
- com.broadleafcommerce.customer.client.domain - package com.broadleafcommerce.customer.client.domain
- com.broadleafcommerce.customer.client.domain.type - package com.broadleafcommerce.customer.client.domain.type
- com.broadleafcommerce.customer.client.exception - package com.broadleafcommerce.customer.client.exception
- com.broadleafcommerce.customer.client.properties - package com.broadleafcommerce.customer.client.properties
- com.broadleafcommerce.customer.client.provider - package com.broadleafcommerce.customer.client.provider
- com.broadleafcommerce.customer.client.provider.external - package com.broadleafcommerce.customer.client.provider.external
- CUSTOMER_SET - Enum constant in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
-
A segment with a manually curated set of customers.
- CustomerClientCacheAutoConfiguration - Class in com.broadleafcommerce.customer.client.autoconfigure
-
Configuration for engaging default Broadleaf support for Apache Ignite cache
- CustomerClientCacheAutoConfiguration() - Constructor for class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheAutoConfiguration
- customerClientCacheManagerCustomizer(IgniteConfigurers.BasicIgniteConfigurer, CustomerClientCacheProperties) - Method in class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheAutoConfiguration
- CustomerClientCacheProperties - Class in com.broadleafcommerce.customer.client.autoconfigure
- CustomerClientCacheProperties() - Constructor for class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheProperties
- CustomerSegment - Class in com.broadleafcommerce.customer.client.domain
- CustomerSegment() - Constructor for class com.broadleafcommerce.customer.client.domain.CustomerSegment
- CustomerSegmentContextInfoCustomizer<P extends CustomerSegment> - Class in com.broadleafcommerce.customer.client.context
-
Customizer responsible for hydrating
ContextInfo.getCustomerSegmentIds()
. - CustomerSegmentContextInfoCustomizer(DataRouteSupporting, CustomerSegmentProvider<P>, TypeFactory, AuthenticationUtils, RuleEvaluationService, CacheStateManager, CustomerSegmentResolutionProperties) - Constructor for class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- CustomerSegmentProvider<P extends CustomerSegment> - Interface in com.broadleafcommerce.customer.client.provider
-
Provider for interfacing with operations directly involving customer segment related domain.
- CustomerSegmentRef - Class in com.broadleafcommerce.customer.client.domain
-
A light version of
CustomerSegment
. - CustomerSegmentRef() - Constructor for class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- CustomerSegmentResolutionProperties - Class in com.broadleafcommerce.customer.client.context
-
Properties related to resolving
CustomerSegments
. - CustomerSegmentResolutionProperties() - Constructor for class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
- CustomerSegmentType - Enum in com.broadleafcommerce.customer.client.domain.type
-
Enumerates the default supported customer segment types.
- customize(ContextInfo, String, MethodParameter, NativeWebRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
D
- DefaultCustomerSegmentRuleEvaluationType - Enum in com.broadleafcommerce.customer.client.domain.type
-
Defines the default supported types of evaluation for
rule-based
CustomerSegments
. - DYNAMIC_CUSTOMER_SEGMENT_CACHE - Static variable in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- dynamicCustomerSegmentCache() - Method in class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheAutoConfiguration
E
- ENTITY_NOT_FOUND - Static variable in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
The
ApiError.getType()
that indicates entity is not found. - equals(Object) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- equals(Object) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- equals(Object) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
- equals(Object) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
- executeRequest(Supplier<T>) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
-
Executes a request with default Web Client error handling.
- EXTERNAL - Enum constant in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
-
A segment that is a reference to a segment defined in an external system.
- ExternalCustomerSegmentProvider<P extends CustomerSegment> - Class in com.broadleafcommerce.customer.client.provider.external
- ExternalCustomerSegmentProvider(WebClient, ObjectMapper, TypeFactory, ExternalCustomerSegmentProviderProperties, ExternalProviderUtility) - Constructor for class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- ExternalCustomerSegmentProviderProperties - Class in com.broadleafcommerce.customer.client.properties
-
Properties for Customer Segment functionalities.
- ExternalCustomerSegmentProviderProperties() - Constructor for class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
- ExternalProviderUtility - Class in com.broadleafcommerce.customer.client.provider.external
- ExternalProviderUtility() - Constructor for class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
G
- getAccountHierarchy() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The hierarchy of accounts, from the root account to the account member's account.
- getAccountId() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The ID of the account the user belongs to.
- getAdditionalAttribute() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- getAdditionalAttributes() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- getAdditionalClaims() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
-
Retrieves the additional auth claims that should be placed on the
ResolveCustomerSegmentsRequest
that theCustomerSegments
are evaluated against. - getAdditionalClaims() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Represents a list of additional auth token claims to add as attributes to the
ResolveCustomerSegmentsRequest
for rules to be evaluated against. - getAttributes() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
Additional, arbitrary request attributes.
- getAuthUtils() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getCacheStateManager() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getCommonHeaders(ObjectMapper, ContextInfo) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Builds the headers to be passed along with the request to the provider.
- getContextState() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
A subset of
Tracking
information to expose the context state for this object. - getCustomerSegmentProvider() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getCustomerSegmentResolutionProperties() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getCustomerSegmentType() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The type of this customer segment.
- getDescription() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The description of this customer segment.
- getDynamicCustomerSegmentCache() - Method in class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheProperties
- getDynamicCustomerSegmentCacheKeyGen() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getDynamicCustomerSegmentsFilter() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
-
Gets the RSQL filter to read dynamic customer segments.
- getEmail() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's email.
- getExternalProviderUtility() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- getExternalRef() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
If the
CustomerSegment.customerSegmentType
isCustomerSegmentType.EXTERNAL
, then this stores the identifier for the external segment. - getExternalRef() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
If the
customerSegmentType
isCustomerSegmentType.EXTERNAL
, then this stores the identifier for the external segment. - getFullName() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's full name.
- getHeaders(ContextInfo) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- getId() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- getId() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- getName() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The name of this customer segment.
- getName() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
The name of this customer segment.
- getObjectMapper() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- getPhoneNumber() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's phone number.
- getPrefetchedSegmentIdsToEvaluate() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
List of ids of any prefetched
CustomerSegments
to evaluate whether they apply to the request. - getPriority() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The priority of this customer segment.
- getPriority() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
The priority of this customer segment.
- getProcessingState() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The current processing state of this segment.
- getProperties() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- getReadCustomerSegmentsPath() - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The path to read all rule-based customer segments.
- getRealtimeMatchRule() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The rule(s) for this customer segment if rule based and using real-time evaluation.
- getReceivedException() - Method in exception com.broadleafcommerce.customer.client.exception.ProviderApiException
-
The received error.
- getRequestAttributeList() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Represents the list of attribute from a
WebRequest
to store onResolveCustomerSegmentsRequest
. - getRequestAttributes(ContextInfo, String, NativeWebRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
-
Retrieves the request attributes that should be placed on the
ResolveCustomerSegmentsRequest
that theCustomerSegments
are evaluated against. - getResolveCustomerSegmentsPath() - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The path to resolve customer segments according to the request details.
- getRootAccountId() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The ID of the root account the account member belongs to.
- getRoute() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getRuleEvaluationService() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getRuleEvaluationType() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
Indicates whether the
CustomerSegment.segmentMatchRule
is evaluated orCustomerSegment.realtimeMatchRule
. - getSegmentMatchRule() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The rule(s) for this customer segment if rule based and using offline evaluation.
- getSegments() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
-
List of references to matching
CustomerSegments
. - getServiceClient() - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The service client to use when calling customer services.
- getServiceClient() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
-
Gets the service's client ID.
- getTypeFactory() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- getTypeFactory() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- getUrl() - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The base url for the customer service.
- getUserId() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's id.
- getUsername() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's username.
- getWebClient() - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
H
- handleSegmentsRequiringExternalEvaluation(Collection<P>, ContextInfo, ResolveCustomerSegmentsRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
-
Handles
CustomerSegments
whereCustomerSegment.isInternalEvaluationRequired()
. - hashCode() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- hashCode() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- hashCode() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
- hashCode() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
I
- INITIALIZATION_REQUIRED - Static variable in class com.broadleafcommerce.customer.client.domain.SegmentStatus
-
The initial status of a newly created customer segment.
- isActive() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- isCustomerSet(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
- isEntityNotFound(ResponseEntity<ApiError>) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Determines if the given
ResponseEntity
indicates entity not found. - isEvaluatingRuleBasedSegmentsExternallyAllowed() - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Whether to allow
rule-based
CustomerSegments
withCustomerSegment.isInternalEvaluationRequired()
set to true to be sent to the customer service to be evaluated. - isExternal(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
- isInternalEvaluationRequired() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
When
CustomerSegment.ruleEvaluationType
isDefaultCustomerSegmentRuleEvaluationType.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. - isOffline(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
- isRealTime(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
- isRegistered() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
Defines whether the user is registered.
- isRuleBased(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
N
- NOT_APPLICABLE - Static variable in class com.broadleafcommerce.customer.client.domain.SegmentStatus
-
Indicates that the current segment should not be processed.
O
- OFFLINE - Enum constant in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
-
Indicates that the rule will be evaluated offline in a background process.
- orderToParamValue(Sort.Order) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Converts a sort order into a query parameter value (e.g.
P
- pageableToParams(Pageable) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Converts a pageable into its corresponding query parameters.
- PROCESSING - Static variable in class com.broadleafcommerce.customer.client.domain.SegmentStatus
-
Status indicating the customer segment is currently being processed.
- ProviderApiException - Exception in com.broadleafcommerce.customer.client.exception
-
Defines a generic error that can be thrown in response to receiving an error from an API that one of the providers (e.g.,
CustomerSegmentProvider
) received. - ProviderApiException(String, Throwable, WebClientResponseException) - Constructor for exception com.broadleafcommerce.customer.client.exception.ProviderApiException
- ProviderApiException(String, WebClientResponseException) - Constructor for exception com.broadleafcommerce.customer.client.exception.ProviderApiException
- ProviderApiException(Throwable, WebClientResponseException) - Constructor for exception com.broadleafcommerce.customer.client.exception.ProviderApiException
- ProviderApiException(WebClientResponseException) - Constructor for exception com.broadleafcommerce.customer.client.exception.ProviderApiException
R
- readDynamicCustomerSegments(ContextInfo) - Method in interface com.broadleafcommerce.customer.client.provider.CustomerSegmentProvider
-
Reads all customer segments that can be dynamically applied under the current context for the current user.
- readDynamicCustomerSegments(ContextInfo) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- readSegments(ContextInfo, String, NativeWebRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
-
Reads the dynamic
CustomerSegments
and caches them by default. - READY - Static variable in class com.broadleafcommerce.customer.client.domain.SegmentStatus
-
Status indicating the customer segment has been completely processed.
- REAL_TIME - Enum constant in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
-
Indicates that the rule will be evaluated in real-time against request attributes.
- ResolveCustomerSegmentResponse - Class in com.broadleafcommerce.customer.client.domain
-
Represents a response to a request to
CustomerSegments
that match a specific context. - ResolveCustomerSegmentResponse() - Constructor for class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
- resolveCustomerSegmentsForContext(ResolveCustomerSegmentsRequest, ContextInfo) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalCustomerSegmentProvider
- resolveCustomerSegmentsForContext(ResolveCustomerSegmentsRequest, ContextInfo) - Method in interface com.broadleafcommerce.customer.client.provider.CustomerSegmentProvider
-
Sends a request to the Customer provider to evaluate the request to determine what
CustomerSegments
match the context. - ResolveCustomerSegmentsRequest - Class in com.broadleafcommerce.customer.client.domain
-
Represents a request to resolve
CustomerSegments
matching a given context. - ResolveCustomerSegmentsRequest() - Constructor for class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
- RULE_BASED - Enum constant in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
-
A segment where membership is determined by a rule.
S
- SegmentStatus - Class in com.broadleafcommerce.customer.client.domain
-
The possible statuses available for rule based customer segments.
- setAccountHierarchy(List<String>) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The hierarchy of accounts, from the root account to the account member's account.
- setAccountId(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The ID of the account the user belongs to.
- setActive(boolean) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- setAdditionalClaims(List<String>) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Represents a list of additional auth token claims to add as attributes to the
ResolveCustomerSegmentsRequest
for rules to be evaluated against. - setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
Additional, arbitrary request attributes.
- setContextState(ContextState) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
A subset of
Tracking
information to expose the context state for this object. - setCustomerSegmentType(CustomerSegmentType) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The type of this customer segment.
- setDescription(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The description of this customer segment.
- setDynamicCustomerSegmentCache(Duration) - Method in class com.broadleafcommerce.customer.client.autoconfigure.CustomerClientCacheProperties
- setDynamicCustomerSegmentCacheKeyGen(ContextKeyGen) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
- setEmail(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's email.
- setEvaluatingRuleBasedSegmentsExternallyAllowed(boolean) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Whether to allow
rule-based
CustomerSegments
withCustomerSegment.isInternalEvaluationRequired()
set to true to be sent to the customer service to be evaluated. - setExternalRef(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
If the
CustomerSegment.customerSegmentType
isCustomerSegmentType.EXTERNAL
, then this stores the identifier for the external segment. - setExternalRef(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
If the
customerSegmentType
isCustomerSegmentType.EXTERNAL
, then this stores the identifier for the external segment. - setFullName(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's full name.
- setId(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- setId(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- setInternalEvaluationRequired(boolean) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
When
CustomerSegment.ruleEvaluationType
isDefaultCustomerSegmentRuleEvaluationType.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. - setName(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The name of this customer segment.
- setName(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
The name of this customer segment.
- setPhoneNumber(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's phone number.
- setPrefetchedSegmentIdsToEvaluate(List<String>) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
List of ids of any prefetched
CustomerSegments
to evaluate whether they apply to the request. - setPriority(Integer) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The priority of this customer segment.
- setPriority(Integer) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
-
The priority of this customer segment.
- setProcessingState(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The current processing state of this segment.
- setReadCustomerSegmentsPath(String) - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The path to read all rule-based customer segments.
- setRealtimeMatchRule(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The rule(s) for this customer segment if rule based and using real-time evaluation.
- setRegistered(boolean) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
Defines whether the user is registered.
- setRequestAttributeList(List<String>) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties
-
Represents the list of attribute from a
WebRequest
to store onResolveCustomerSegmentsRequest
. - setResolveCustomerSegmentsPath(String) - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The path to resolve customer segments according to the request details.
- setRootAccountId(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The ID of the root account the account member belongs to.
- setRuleEvaluationType(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
Indicates whether the
CustomerSegment.segmentMatchRule
is evaluated orCustomerSegment.realtimeMatchRule
. - setSegmentMatchRule(String) - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
-
The rule(s) for this customer segment if rule based and using offline evaluation.
- setSegments(List<CustomerSegmentRef>) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
-
List of references to matching
CustomerSegments
. - setServiceClient(String) - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The service client to use when calling customer services.
- setUrl(String) - Method in class com.broadleafcommerce.customer.client.properties.ExternalCustomerSegmentProviderProperties
-
The base url for the customer service.
- setUserId(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's id.
- setUsername(String) - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
-
The user's username.
- shouldHandle(ContextInfo, String, MethodParameter, NativeWebRequest) - Method in class com.broadleafcommerce.customer.client.context.CustomerSegmentContextInfoCustomizer
T
- toString() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegment
- toString() - Method in class com.broadleafcommerce.customer.client.domain.CustomerSegmentRef
- toString() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentResponse
- toString() - Method in class com.broadleafcommerce.customer.client.domain.ResolveCustomerSegmentsRequest
U
- UPDATE_REQUIRED - Static variable in class com.broadleafcommerce.customer.client.domain.SegmentStatus
-
Status indicating a "dirty" segment.
- uriVars(Object...) - Method in class com.broadleafcommerce.customer.client.provider.external.ExternalProviderUtility
-
Convenience method to generate a map of variables.
V
- valueOf(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.broadleafcommerce.customer.client.domain.type.CustomerSegmentType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.broadleafcommerce.customer.client.domain.type.DefaultCustomerSegmentRuleEvaluationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form