com.adobe.cq.commerce.api.smartlist

Interface SmartListManager

@ProviderType
public interface SmartListManager

The SmartListManager defines the API to get, create and delete smart lists SmartList and methods related to sharing of a smart list. A SmartListManager can be retrieved from the CommerceSession.

Method Summary

Modifier and Type	Method and Description
SmartList	createSmartList(java.lang.String name) Creates a smart list with a given name.
SmartList	createSmartList(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Creates a smart list with a given name.
void	deleteSmartList(java.lang.String path) Removes the SmartList.
SmartList	getSmartList(java.lang.String path) Returns a smart list for the given path or an ID uniquely identifying the SmartList to the external commerce engine.
java.util.List<SmartList>	getSmartLists(java.lang.String filter) Get a list of smart lists, based on the provided filter, this can be all, only personal lists or lists shared by friends.
void	makeSmartListDefault(java.lang.String path) Mark the current smart list as default smart list.
void	shareSmartList(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Share the current smart list with third party customers.
void	updateSmartList(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> properties) Updates the SmartList.

Method Detail

getSmartList

SmartList getSmartList(java.lang.String path)

Returns a smart list for the given path or an ID uniquely identifying the SmartList to the external commerce engine. It returns null if given path/ID is not a smart list or is not defined.

Parameters:

path - The path/ID that represents the smart list

Returns:

The SmartList representing the smart list or null if not found.

getSmartLists

java.util.List<SmartList> getSmartLists(java.lang.String filter)

Get a list of smart lists, based on the provided filter, this can be all, only personal lists or lists shared by friends.

Parameters:

filter - An optional implementation-specific predicate name. For example to filter personal lists and lists shared by friends.

Returns:

a list of SmartList objects.

createSmartList

SmartList createSmartList(java.lang.String name)
                   throws CommerceException

Creates a smart list with a given name.

Parameters:

name - The name of the smart list.

Returns:

The SmartList representing the created smart list.

Throws:

CommerceException - if the smart list was not created

createSmartList

SmartList createSmartList(java.lang.String name,
                          java.util.Map<java.lang.String,java.lang.Object> properties)
                   throws CommerceException

Creates a smart list with a given name.

Parameters:

name - The name of the smart list.

properties - The additional data like description for the smart list.

Returns:

The SmartList representing the created smart list.

Throws:

CommerceException - if the smart list was not created

updateSmartList

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

Updates the SmartList.

Parameters:

path - The path/ID that represents the smart list to be updated.

properties - The additional data for smart list like title or description

Throws:

CommerceException - if the smart list was not updated

deleteSmartList

void deleteSmartList(java.lang.String path)
              throws CommerceException

Removes the SmartList.

Parameters:

path - The path/ID that represents the smart list to be deleted.

Throws:

CommerceException - if the smart list was not deleted

makeSmartListDefault

void makeSmartListDefault(java.lang.String path)
                   throws CommerceException

Mark the current smart list as default smart list. This implies, depending on the implementation, all other smart list of the same owner are marked as non default.

Parameters:

path - The path/ID that represents the smart list to be marked as default.

Throws:

CommerceException - if the smart list was not marked as default

shareSmartList

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

Share the current smart list with third party customers. Sharing information (recipients, sharing state, messages) are provided via the properties parameter. Use null for properties to "unshare" a smart-list and set it back to personal.

Parameters:

path - The path/ID that represents the smart list to be shared.

properties - The sharing properties.

Throws:

CommerceException - if the smart list was not marked as default