Package | Description |
---|---|
io.sphere.sdk.categories |
Provides model types to organize products in a hierarchical structure.
|
io.sphere.sdk.categories.commands |
Provides types to change the state of categories.
|
io.sphere.sdk.categories.commands.updateactions |
Provides the possible operations which can be performed on update commands for categories.
|
io.sphere.sdk.categories.expansion |
Provides reference expansion models for categories.
|
io.sphere.sdk.categories.messages | |
io.sphere.sdk.categories.queries |
Provides types to retrieve the state of categories.
|
io.sphere.sdk.products |
Provides model classes and builders for products.
|
io.sphere.sdk.products.attributes |
Provides model classes for product type attributes.
|
io.sphere.sdk.products.commands.updateactions |
Provides the possible operations which can be performed on update commands for products.
|
io.sphere.sdk.products.messages |
Provides model classes and builders for products.
|
io.sphere.sdk.products.queries |
Provides types to retrieve the state of products.
|
Modifier and Type | Method and Description |
---|---|
Category |
CategoryTree.getRootAncestor(Identifiable<Category> category)
For a given category searches the ancestor that is in root level.
|
Modifier and Type | Method and Description |
---|---|
Optional<Category> |
CategoryTree.findByExternalId(String externalId)
Finds a category by its external ID.
|
Optional<Category> |
CategoryTree.findById(String id)
Finds a category by id.
|
Optional<Category> |
CategoryTree.findByKey(String key)
Finds a category by the key.
|
Optional<Category> |
CategoryTree.findBySlug(Locale locale,
String slug)
Finds a category by the slug and a specific locale.
|
List<Category> |
CategoryTree.findChildren(Identifiable<Category> category)
return the children for category.
|
List<Category> |
CategoryTree.findSiblings(Collection<? extends Identifiable<Category>> categoryIds)
Gets a list containing all categories that share a parent
with at least one of the given categories.
|
List<Category> |
CategoryTree.getAllAsFlatList()
All categories as a flat list.
|
List<Reference<Category>> |
Category.getAncestors() |
ResourceIdentifier<Category> |
CategoryDraft.getParent() |
Reference<Category> |
Category.getParent()
Reference to the parent category.
|
ResourceIdentifier<Category> |
CategoryDraftDsl.getParent() |
List<Category> |
CategoryTree.getRoots()
Root categories (the ones that have no parent).
|
List<Category> |
CategoryTree.getSubtreeRoots()
For a subtree the categories which are at the top level.
|
static Reference<Category> |
Category.reference(String id) |
static Reference<Category> |
Category.referenceOfId(String id)
Creates a reference for one item of this class by a known ID.
|
default Reference<Category> |
Category.toReference() |
static com.fasterxml.jackson.core.type.TypeReference<Category> |
Category.typeReference()
Creates a container which contains the full Java type information to deserialize this class from JSON.
|
Modifier and Type | Method and Description |
---|---|
static String |
Category.toString(Category category) |
Modifier and Type | Method and Description |
---|---|
List<Category> |
CategoryTree.findChildren(Identifiable<Category> category)
return the children for category.
|
List<Category> |
CategoryTree.findSiblings(Collection<? extends Identifiable<Category>> categoryIds)
Gets a list containing all categories that share a parent
with at least one of the given categories.
|
Category |
CategoryTree.getRootAncestor(Identifiable<Category> category)
For a given category searches the ancestor that is in root level.
|
CategoryTree |
CategoryTree.getSubtree(Collection<? extends Identifiable<Category>> parentCategories)
Gets the subtree of the given parent categories.
|
static CategoryTree |
CategoryTree.of(List<Category> allCategoriesAsFlatList)
Creates a category tree from a flat list of categories.
|
CategoryDraftBuilder |
CategoryDraftBuilder.parent(Referenceable<Category> parent)
Deprecated.
use
CategoryDraftBuilderBase.parent(ResourceIdentifier) instead |
CategoryDraftDsl |
CategoryDraftDsl.withParent(ResourceIdentifier<Category> parent) |
Constructor and Description |
---|
CategoryDraftBuilder(List<AssetDraft> assets,
CustomFieldsDraft custom,
LocalizedString description,
String externalId,
String key,
LocalizedString metaDescription,
LocalizedString metaKeywords,
LocalizedString metaTitle,
LocalizedString name,
String orderHint,
ResourceIdentifier<Category> parent,
LocalizedString slug) |
Modifier and Type | Method and Description |
---|---|
static CategoryDeleteCommand |
CategoryDeleteCommand.of(Versioned<Category> versioned)
Creates a command object to delete a
Category by ID. |
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
List<? extends UpdateAction<Category>> updateActions)
Creates a command to update a Category selected by its ID using several update actions.
|
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
List<? extends UpdateAction<Category>> updateActions)
Creates a command to update a Category selected by its ID using several update actions.
|
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
UpdateAction<Category> updateAction,
UpdateAction<Category>... updateActions)
Creates a command to update a Category selected by its ID using one update action.
|
static CategoryUpdateCommand |
CategoryUpdateCommand.of(Versioned<Category> versioned,
UpdateAction<Category> updateAction,
UpdateAction<Category>... updateActions)
Creates a command to update a Category selected by its ID using one update action.
|
Modifier and Type | Method and Description |
---|---|
ResourceIdentifier<Category> |
ChangeParent.getParent() |
Modifier and Type | Method and Description |
---|---|
static ChangeParent |
ChangeParent.of(Referenceable<Category> parent) |
static ChangeParent |
ChangeParent.of(ResourceIdentifier<Category> parent) |
Modifier and Type | Method and Description |
---|---|
static CategoryExpansionModel<Category> |
CategoryExpansionModel.of() |
Modifier and Type | Method and Description |
---|---|
Category |
CategoryCreatedMessage.getCategory()
Gets the category object at creation time.
|
Modifier and Type | Method and Description |
---|---|
List<ExpansionPath<Category>> |
CategoryByIdGet.expansionPaths() |
List<ExpansionPath<Category>> |
CategoryByKeyGet.expansionPaths() |
StringQuerySortingModel<Category> |
CategoryQueryModel.externalId() |
StringQuerySortingModel<Category> |
CategoryQueryModel.key() |
LocalizedStringQuerySortingModel<Category> |
CategoryQueryModel.name() |
StringQuerySortingModel<Category> |
CategoryQueryModel.orderHint() |
ReferenceOptionalQueryModel<Category,Category> |
CategoryQueryModel.parent() |
ReferenceOptionalQueryModel<Category,Category> |
CategoryQueryModel.parent() |
static com.fasterxml.jackson.core.type.TypeReference<PagedQueryResult<Category>> |
CategoryQuery.resultTypeReference()
Creates a container which contains the full Java type information to deserialize the query result (NOT this class) from JSON.
|
LocalizedStringQuerySortingModel<Category> |
CategoryQueryModel.slug() |
Modifier and Type | Method and Description |
---|---|
Set<Reference<Category>> |
ProductProjection.getCategories() |
Set<Reference<Category>> |
ProductData.getCategories() |
Set<ResourceIdentifier<Category>> |
ProductDraft.getCategories() |
Set<ResourceIdentifier<Category>> |
ProductDraftDsl.getCategories() |
Modifier and Type | Method and Description |
---|---|
ProductDraftBuilder |
ProductDraftBuilder.categories(List<Reference<Category>> categories) |
ProductDraftBuilder |
ProductDraftBuilder.categoriesAsObjectList(List<Category> categories)
Adds categories to this product draft.
|
ProductDraftDsl |
ProductDraftDsl.withCategories(Set<ResourceIdentifier<Category>> categories) |
Modifier and Type | Method and Description |
---|---|
static RichReferenceAttributeType<Category> |
ReferenceAttributeType.ofCategory() |
static AttributeAccess<Reference<Category>> |
AttributeAccess.ofCategoryReference() |
static AttributeAccess<Set<Reference<Category>>> |
AttributeAccess.ofCategoryReferenceSet() |
Modifier and Type | Method and Description |
---|---|
protected abstract T |
ProductAttributeConverterBase.convertCategoryReference(Reference<Category> categoryReference,
Attribute attribute,
ProductType productType) |
protected String |
DefaultProductAttributeFormatter.convertCategoryReference(Reference<Category> categoryReference,
Attribute attribute,
ProductType productType) |
protected abstract T |
ProductAttributeConverterBase.convertCategoryReferenceSet(Set<Reference<Category>> v,
Attribute attribute,
ProductType productType) |
protected String |
DefaultProductAttributeFormatter.convertCategoryReferenceSet(Set<Reference<Category>> categoryReferenceSet,
Attribute attribute,
ProductType productType) |
Modifier and Type | Method and Description |
---|---|
ResourceIdentifier<Category> |
RemoveFromCategory.getCategory() |
ResourceIdentifier<Category> |
AddToCategory.getCategory() |
Modifier and Type | Method and Description |
---|---|
static RemoveFromCategory |
RemoveFromCategory.of(Referenceable<Category> category) |
static AddToCategory |
AddToCategory.of(Referenceable<Category> category) |
static RemoveFromCategory |
RemoveFromCategory.of(Referenceable<Category> category,
Boolean staged) |
static AddToCategory |
AddToCategory.of(Referenceable<Category> category,
Boolean staged) |
static AddToCategory |
AddToCategory.of(Referenceable<Category> category,
String orderHint) |
static AddToCategory |
AddToCategory.of(Referenceable<Category> category,
String orderHint,
Boolean staged) |
static RemoveFromCategory |
RemoveFromCategory.of(ResourceIdentifier<Category> category) |
static AddToCategory |
AddToCategory.of(ResourceIdentifier<Category> category) |
static RemoveFromCategory |
RemoveFromCategory.of(ResourceIdentifier<Category> category,
Boolean staged) |
static AddToCategory |
AddToCategory.of(ResourceIdentifier<Category> category,
Boolean staged) |
static AddToCategory |
AddToCategory.of(ResourceIdentifier<Category> category,
String orderHint) |
static AddToCategory |
AddToCategory.of(ResourceIdentifier<Category> category,
String orderHint,
Boolean staged) |
Modifier and Type | Method and Description |
---|---|
Reference<Category> |
ProductAddedToCategoryMessage.getCategory() |
Reference<Category> |
ProductRemovedFromCategoryMessage.getCategory() |
Modifier and Type | Method and Description |
---|---|
ReferenceCollectionQueryModel<T,Category> |
ProductDataQueryModel.categories() |
ReferenceCollectionQueryModel<ProductProjection,Category> |
ProductProjectionQueryModel.categories() |