Serialized Form
-
Package com.broadleafcommerce.content.clone.contentitem
-
Class com.broadleafcommerce.content.clone.contentitem.CloneContentItemRequest
class CloneContentItemRequest extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
cloneRelationships
List<String> cloneRelationships
TheList
of the ContentItem relationships that is used to specify which of the relationships should be cloned. If this list is empty, the relationships will not be cloned. -
contentItemId
String contentItemId
TheContentItem
id to clone. -
folderId
String folderId
The id of the folder where the clonedContentItem
should be placed. -
name
String name
- See Also:
-
uri
String uri
- See Also:
-
-
-
Package com.broadleafcommerce.content.domain
-
Class com.broadleafcommerce.content.domain.Author
class Author extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.domain.ContentField
class ContentField extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
allowedModels
List<String> allowedModels
When the `referenceType` is `CONTENT`, this field holds allowed content models. If empty, allows all. -
allowRecommendationConfiguration
boolean allowRecommendationConfiguration
Whether this field can source from recommendations.Configurable at the
ContentItem
level. Only Product Reference type field can be configured with recommendations. -
attributes
Map<String,
Object> attributes Additional attributes needed to further define this field -
collection
boolean collection
Whether this field represents a collection -
contentModel
ContentModel contentModel
The content model this content field belongs to -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
displayOrder
Integer displayOrder
The display order of this field in relation to other fields. -
helpText
String helpText
Help text to display on the field -
hint
String hint
Hint text to display below the field in the admin -
id
String id
A unique id for the field. -
label
String label
The friendly display label for this field -
name
String name
A unique name for the content type, used for retrieval. -
referenceType
String referenceType
When the `type` is `REFERENCE`, this field holds the type of entity this field links to -
required
boolean required
Whether this field is required -
translatable
boolean translatable
Whether the field should be translatable. -
type
String type
The type of this content field
-
-
Class com.broadleafcommerce.content.domain.ContentFilter
class ContentFilter extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
filterKey
String filterKey
The key for this filter -
label
String label
The label for this filter -
options
Set<ContentFilterOption> options
The options for this filter
-
-
Class com.broadleafcommerce.content.domain.ContentFilterOption
class ContentFilterOption extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.domain.ContentItem
class ContentItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
activeEndDate
Instant activeEndDate
Defines the ending time for which this content item is active. If theactive start date
is not null, but the active end date is, the content item is considered to be active forever, starting on the start date.- See Also:
-
activeStartDate
Instant activeStartDate
Defines the beginning time for which this content item is active. If both the active start date and theactive end date
are null, this content item is considered to always be active.- See Also:
-
author
Author author
Information on the user who created this item. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
displayOrder
Integer displayOrder
This item's display order relative to other items. Usually set in post-processing before consumed by the frontend application. -
displayRule
String displayRule
Rule governing when this item can be displayed based on the context. This can be used to restrict this item to only logged in customers or similar restrictions. -
embedded
Boolean embedded
Whether this item is considered embedded within another item and should not be retrieved separately. -
fields
Map<String,
FieldData> fields The individual field data for this content -
folderId
String folderId
The folder ID that this content item belongs to. -
id
String id
The system ID of the content item. -
lastUpdated
Instant lastUpdated
The date and time that this content item was last modified.- See Also:
-
model
ContentModel model
The content model for this content. -
modelName
String modelName
The content model name for this content. -
name
String name
A unique name for the content item, used for retrieval. -
starred
boolean starred
Whether this item is starred by a user. This field is typically calculated and not set by external clients. -
tags
List<String> tags
List of simple tags used for filtering and retrieval. -
uri
String uri
SEO-friendly URI to identify this content item. This will be appended to theContentModel's URI
ifContentModel.isAddressableByUri()
is true.
-
-
Class com.broadleafcommerce.content.domain.ContentModel
class ContentModel extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
addressableByUri
boolean addressableByUri
Whether allContentItems
of this model can be retrieved by navigating toContentModel.uri
from a storefront app. For example, navigating to/blogs
would result in all Content Items using the "Blog" model being fetching. Moreover, those content items would have their own URIs that would be appended to the model's, e.g.,/:ContentModel.uri/:ContentItem.uri
.- See Also:
-
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
embeddedOnly
boolean embeddedOnly
Whether this model is only used as an embedded model. Embedded models are not addressable by URL and are only used as part of another model.- Since:
- Release Train 2.1.2
-
fields
List<ContentField> fields
The list of fields that make up this content model -
id
String id
The context ID of the content model. -
name
String name
A unique name for the content model, used for retrieval. -
uri
String uri
SEO-friendly URI to identifyContentItems
of this model.ContentItems
of this model will have theirURIs
appended to this.
-
-
Class com.broadleafcommerce.content.domain.ContentTag
class ContentTag extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.domain.ContentZone
class ContentZone extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
allowedModels
List<String> allowedModels
When the `referenceType` is `CONTENT`, this field holds allowed content models. If empty, allows all. -
alternateItemSets
List<ContentZoneItemList> alternateItemSets
List ofContentZoneItemLists
to display based on theirrules
. These are grouped lists ofContentItems
. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
defaultItems
List<ContentZoneItem> defaultItems
The defaultContentItem
to display. This will be displayed ifContentZone.alternateItemSets
is empty or none match the request context. -
id
String id
The system ID of the zone. -
name
String name
A unique name for the content zone, used for retrieval.
-
-
Class com.broadleafcommerce.content.domain.ContentZoneItem
class ContentZoneItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentItemMembershipRule
String contentItemMembershipRule
If the membership type isContentItemMembershipType.RULE_BASED
, this rule defines what items to include. -
contentItemMembershipType
String contentItemMembershipType
The content item membership type. Items can either be explicitly defined or be included based on a given rule. -
displayOrder
Integer displayOrder
The display order of this item in relation to other items -
displayRule
String displayRule
The display rule for the item to be displayed in the zone. -
item
ContentItem item
The ID of theContentItem
to display.
-
-
Class com.broadleafcommerce.content.domain.ContentZoneItemList
class ContentZoneItemList extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contextState
com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState
A subset ofTracking
information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when theChangeDetails
for the parent object's entireattributes
map are compared. -
displayRule
String displayRule
The display rule required to be matched by requests for the list to be displayed in the zone. -
id
String id
The id for this list. Should be unique for the parentContentZone
. -
items
List<ContentZoneItem> items
TheContentItems
in this list. -
name
String name
The name of this list. This is used in the admin UI.
-
-
Class com.broadleafcommerce.content.domain.FieldData
class FieldData extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentItem
ContentItem contentItem
The content item this field belongs to -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
displayOrder
Integer displayOrder
The field's display order, defined by theContentModel
-
enableRecommendations
boolean enableRecommendations
Whether this field should use recommendations for its product references. Only Product Reference type field can be configured with recommendations.- Since:
- Content Service 2.0.6, Release Train 2.2.0
-
id
String id
The field's unique identifier -
name
String name
The content field's name -
numberOfRecommendations
Integer numberOfRecommendations
The number of recommendations requested from the recommendations engine- Since:
- Content Service 2.0.6, Release Train 2.2.0
-
recommendationModelType
String recommendationModelType
The type of Recommendation Model that should be queried when retrieving recommendations e.g. BOUGHT_ALSO_BOUGHT- Since:
- Content Service 2.0.6, Release Train 2.2.0
-
value
Object value
The field's value
-
-
Class com.broadleafcommerce.content.domain.StarredItem
class StarredItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentItemId
String contentItemId
The system ID of the content item. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
id
String id
The system ID of the content item. -
userId
String userId
The ID of the user who starred the item.
-
-
Class com.broadleafcommerce.content.domain.ThemeField
class ThemeField extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
fieldGroup
ThemeFieldGroup fieldGroup
The group this field belongs to. -
id
String id
A unique id for the field. -
label
String label
The friendly display label for this field -
name
String name
A unique name for the field, used for retrieval. -
type
String type
The type of this content field -
value
Object value
The field's value
-
-
Class com.broadleafcommerce.content.domain.ThemeFieldGroup
class ThemeFieldGroup extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
fields
List<ThemeField> fields
The fields in this group. -
id
String id
A unique id for the field. -
label
String label
The friendly display label for this field -
name
String name
A unique name for the field, used for retrieval.
-
-
-
Package com.broadleafcommerce.content.domain.asset
-
Class com.broadleafcommerce.content.domain.asset.ContentItemAsset
class ContentItemAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable- serialVersionUID:
- 1L
-
-
Package com.broadleafcommerce.content.domain.commerce
-
Class com.broadleafcommerce.content.domain.commerce.BulkContentResolverRequest
class BulkContentResolverRequest extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentResolverRequests
List<ContentResolverRequest> contentResolverRequests
List of content resolver requests to include
-
-
Class com.broadleafcommerce.content.domain.commerce.BulkContentResolverResponse
class BulkContentResolverResponse extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentResolverResponseToId
Map<String,
ContentResolverResponse<T extends ContentItem>> contentResolverResponseToId AContentResolverResponse
for eachContentResolverRequest
mapped by request ID. -
requestIdsNotFound
List<String> requestIdsNotFound
Anyrequest IDs
not returned in the correspondingContentResolverResponse
-
-
Class com.broadleafcommerce.content.domain.commerce.ContentResolverRequest
class ContentResolverRequest extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
attributes
Map<String,
Object> attributes Map holding any additional attributes passed in the request not matching any defined properties. -
contentContext
ContentContext contentContext
Any contextual information needed to resolve targetted content.If present, this information is used during content zone resolution.
-
contentZoneName
String contentZoneName
Name of aContentZone
to retrieve relatedContentItems
.If a zone with the provided name is found, the
ContentZone's
`defaultItems` will be returned as well as any `alternateItemSets` that meet their `displayRule`'s criteria.If present, all other request parameters will be ignored.
-
itemIds
Set<String> itemIds
Ids ofContentItems
to retrieve.If
ContentResolverRequest.uri
,ContentResolverRequest.modelId
, orContentResolverRequest.modelName
are present, then this will be ignored. If this is present, thenContentResolverRequest.itemNames
will be ignored. -
itemNames
Set<String> itemNames
Names ofContentItems
to retrieve.If
ContentResolverRequest.uri
,ContentResolverRequest.itemIds
,ContentResolverRequest.modelId
, orContentResolverRequest.modelName
are present, then this will be ignored. -
modelId
String modelId
Id of aContentModel
all of whoseContentItems
to retrieve.If present,
ContentResolverRequest.modelId
,ContentResolverRequest.itemIds
, andContentResolverRequest.itemNames
will be ignored. IfContentResolverRequest.uri
is present, then this will be ignored. -
modelName
String modelName
Name of aContentModel
all of whoseContentItems
to retrieve.If present,
ContentResolverRequest.itemIds
andContentResolverRequest.itemNames
will be ignored will be ignored. IfContentResolverRequest.uri
orContentResolverRequest.modelId
are present, then this will be ignored. -
requestId
String requestId
The id of this content resolver request.- Since:
- 2.0.3
-
uri
String uri
URI of either aContentModel
all of whoseContentItems
should be retrieved or else that of a singleContentItem
. In the latter case, the parentContentModel's URI
should be appended in the request.If present,
ContentResolverRequest.itemNames
,ContentResolverRequest.itemIds
,ContentResolverRequest.modelId
, andContentResolverRequest.modelName
will be ignored.
-
-
Class com.broadleafcommerce.content.domain.commerce.ContentResolverResponse
class ContentResolverResponse extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
idsNotFound
Set<String> idsNotFound
AnyContentResolverRequest.getItemIds()
that did not match active content. -
namesNotFound
Set<String> namesNotFound
AnyContentResolverRequest.getItemNames()
that did not match active content. -
paginatedResults
org.springframework.data.domain.Page<T extends ContentItem> paginatedResults
Paginated results. Only present if pagination params were present in the request. -
results
List<T extends ContentItem> results
Unpaginated list of results. Only present if no pagination params were present in the request.
-
-
-
Package com.broadleafcommerce.content.domain.commerce.context
-
Class com.broadleafcommerce.content.domain.commerce.context.ContentContext
class ContentContext extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
attributes
Map<String,
Object> attributes Additional, unspecified attributes. -
customer
CustomerRef customer
TheCustomerRef
used in this context -
locale
String locale
TheLocale
used in this context
-
-
Class com.broadleafcommerce.content.domain.commerce.context.CustomerRef
class CustomerRef extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
accountId
String accountId
The ID of the account the user belongs to. -
authenticated
boolean authenticated
Whether the customer is authenticated. -
customerSegmentIds
List<String> customerSegmentIds
A list of customer segment ids in this context. -
userId
String userId
The user's id. -
username
String username
The user's username.
-
-
-
Package com.broadleafcommerce.content.domain.folder
-
Class com.broadleafcommerce.content.domain.folder.Attribute
class Attribute extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contextState
com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState
A subset ofTracking
information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when theChangeDetails
for the parent object's entireattributes
map are compared. -
value
Object value
The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values:Map<String, Attribute>
.
-
-
Class com.broadleafcommerce.content.domain.folder.ContentFolder
class ContentFolder extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
attributes
Map<String,
Attribute> attributes Additional attributes of the folder. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
id
String id
The context ID of the folder. -
name
String name
The user facing name of this folder. -
parentFolderId
String parentFolderId
-
-
Class com.broadleafcommerce.content.domain.folder.ContentFolderItem
class ContentFolderItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contentItemId
String contentItemId
The content item. -
contextState
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
A subset ofTracking
information to expose the context state for this object. -
folderId
String folderId
-
id
String id
The context ID of the folder.
-
-
-
Package com.broadleafcommerce.content.provider.jpa.domain
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaAuthor
class JpaAuthor extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentField
class JpaContentField extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
_id
String _id
-
allowedModels
List<String> allowedModels
- See Also:
-
allowRecommendationConfiguration
boolean allowRecommendationConfiguration
-
attributes
Map<String,
Object> attributes - See Also:
-
collection
boolean collection
- See Also:
-
contentModelContextId
String contentModelContextId
-
contextId
String contextId
-
displayOrder
Integer displayOrder
- See Also:
-
helpText
String helpText
- See Also:
-
hint
String hint
- See Also:
-
label
String label
- See Also:
-
name
String name
- See Also:
-
referenceType
String referenceType
- See Also:
-
required
boolean required
- See Also:
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking
-
translatable
boolean translatable
- See Also:
-
type
String type
- See Also:
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentItem
class JpaContentItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
_id
String _id
-
activeEndDate
Instant activeEndDate
- See Also:
-
activeStartDate
Instant activeStartDate
- See Also:
-
author
JpaAuthor author
- See Also:
-
contextId
String contextId
-
displayRule
String displayRule
- See Also:
-
embedded
boolean embedded
- See Also:
-
lastUpdated
Instant lastUpdated
- See Also:
-
modelContextId
String modelContextId
- See Also:
-
modelName
String modelName
-
name
String name
- See Also:
-
tags
String tags
- See Also:
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking
-
uri
String uri
- See Also:
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentModel
class JpaContentModel extends Object implements Serializable-
Serialized Fields
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentZone
class JpaContentZone extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
_id
String _id
-
allowedModels
List<String> allowedModels
- See Also:
-
alternateItemSets
List<JpaContentZoneItemList> alternateItemSets
- See Also:
-
contextId
String contextId
- See Also:
-
defaultItems
List<JpaContentZoneItem> defaultItems
- See Also:
-
name
String name
- See Also:
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentZoneItem
class JpaContentZoneItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaContentZoneItemList
class JpaContentZoneItemList extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
displayRule
String displayRule
- See Also:
-
id
String id
- See Also:
-
items
List<JpaContentZoneItem> items
- See Also:
-
name
String name
- See Also:
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaFieldData
class JpaFieldData extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
_id
String _id
-
contentItemContextId
String contentItemContextId
-
contextId
String contextId
-
enableRecommendations
boolean enableRecommendations
-
name
String name
- See Also:
-
numberOfRecommendations
Integer numberOfRecommendations
-
recommendationModelType
String recommendationModelType
-
tracking
com.broadleafcommerce.data.tracking.jpa.filtering.domain.CatalogJpaTracking tracking
-
value
Object value
- See Also:
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaStarredItem
class JpaStarredItem extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaThemeField
class JpaThemeField extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
Class com.broadleafcommerce.content.provider.jpa.domain.JpaThemeFieldGroup
class JpaThemeFieldGroup extends Object implements Serializable- serialVersionUID:
- 1L
-
-
Package com.broadleafcommerce.content.provider.jpa.domain.asset
-
Class com.broadleafcommerce.content.provider.jpa.domain.asset.JpaContentItemAsset
class JpaContentItemAsset extends com.broadleafcommerce.asset.consumer.domain.EntityAsset implements Serializable- serialVersionUID:
- 1L
-
-
Package com.broadleafcommerce.content.provider.jpa.domain.folder
-
Class com.broadleafcommerce.content.provider.jpa.domain.folder.JpaAttribute
class JpaAttribute extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
value
Object value
- See Also:
-
-
Class com.broadleafcommerce.content.provider.jpa.domain.folder.JpaContentFolder
class JpaContentFolder extends Object implements Serializable- serialVersionUID:
- 1L
-
Class com.broadleafcommerce.content.provider.jpa.domain.folder.JpaContentFolderItem
class JpaContentFolderItem extends Object implements Serializable- serialVersionUID:
- 1L
-
-
Package com.broadleafcommerce.content.service.messaging.cache
-
Class com.broadleafcommerce.content.service.messaging.cache.ContentCacheInvalidationEvent
class ContentCacheInvalidationEvent extends org.springframework.context.ApplicationEvent implements Serializable -
Class com.broadleafcommerce.content.service.messaging.cache.ContentCacheInvalidationRemoteEvent
class ContentCacheInvalidationRemoteEvent extends Object implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
contextId
String contextId
Entity context id. -
id
String id
Entity id. -
modelContextId
String modelContextId
This field contains theContentModel
id of theContentItem.getModel()
if available. -
name
String name
This field contains the content entity name if available, for exampleContentItem.getName()
. -
type
String type
The entity type. -
uri
String uri
This field contains the content URI if available, for exampleContentItem.getUri()
.
-
-
-
Package com.broadleafcommerce.content.web.endpoint.exception
-
Exception com.broadleafcommerce.content.web.endpoint.exception.ExistingContentItemsException
class ExistingContentItemsException extends RuntimeException implements Serializable
-