@ProviderType public interface SmartList extends ProductCollection
SmartListEntry
(products including
quantity and other properties). The smart list does not store the actual products, it only points to them by the
given path
or an ID uniquely identifying them to the external commerce engine.Modifier and Type | Interface and Description |
---|---|
static class |
SmartList.Privacy
The available status of a smart-list.
|
Modifier and Type | Method and Description |
---|---|
void |
add(SmartListEntry smartListEntry)
Adds a new smart list entry in the collection at the last position
|
java.lang.String |
getOwner()
Returns the owner id of the smart list.
|
SmartList.Privacy |
getPrivacy()
Get the sharing and privacy status of a smart-list.
|
java.util.Iterator<SmartListEntry> |
getSmartListEntries()
Returns an iterator over smart list entries referred in the collection in the specified order.
|
boolean |
isDefault()
Return
true if the smart list is the default smart list, otherwise false . |
void |
update(java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> properties)
Updates the smart list entry.
|
add, contains, getDescription, getDirectReferences, getPath, getProducts, getProperties, getProperty, getProperty, getTitle, getType, hasDirectReference, orderBefore, remove, setProperties, setProperty
void add(SmartListEntry smartListEntry) throws CommerceException
smartListEntry
- smart list entry to be addedCommerceException
- if the operation fails, if collection already contained
the product/collection or product/collection is null.void update(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) throws CommerceException
path
- The smart list entry (product) path/ID.properties
- The additional data for smart list entry like updated quantity valueCommerceException
- if the smart list entry was not updatedjava.util.Iterator<SmartListEntry> getSmartListEntries()
java.lang.String getOwner()
boolean isDefault()
true
if the smart list is the default smart list, otherwise false
. Each user has
exactly one default smart list.true
for the default smart listSmartList.Privacy getPrivacy()
Privacy
of the smart-list.Copyright © 2010 - 2020 Adobe. All Rights Reserved