com.adobe.cq.commerce.api.smartlist

Interface SmartList

All Superinterfaces:

ProductCollection

public interface SmartList
extends ProductCollection

Smart list (sometimes also called wish list) is an ordered collection of 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SmartList.Privacy The available status of a smart-list.

Method Summary

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.

Methods inherited from interface com.adobe.cq.commerce.api.collection.ProductCollection

add, contains, getDescription, getDirectReferences, getPath, getProducts, getProperties, getProperty, getProperty, getTitle, getType, hasDirectReference, orderBefore, remove, setProperties, setProperty

Method Detail

add

void add(SmartListEntry smartListEntry)
  throws CommerceException

Adds a new smart list entry in the collection at the last position

Parameters:

smartListEntry - smart list entry to be added

Throws:

CommerceException - if the operation fails, if collection already contained the product/collection or product/collection is null.

update

void update(java.lang.String path,
            java.util.Map<java.lang.String,java.lang.Object> properties)
     throws CommerceException

Updates the smart list entry.

Parameters:

path - The smart list entry (product) path/ID.

properties - The additional data for smart list entry like updated quantity value

Throws:

CommerceException - if the smart list entry was not updated

getSmartListEntries

java.util.Iterator<SmartListEntry> getSmartListEntries()

Returns an iterator over smart list entries referred in the collection in the specified order.

Returns:

iterator over smart list entries referred in collection.

getOwner

java.lang.String getOwner()

Returns the owner id of the smart list.

Returns:

the owner id

isDefault

boolean isDefault()

Return true if the smart list is the default smart list, otherwise false. Each user has exactly one default smart list.

Returns:

true for the default smart list

getPrivacy

SmartList.Privacy getPrivacy()

Get the sharing and privacy status of a smart-list.

Returns:

The Privacy of the smart-list.