Package org.ametys.plugins.odfweb.cart

Class ODFCartManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.cart.ODFCartManager

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ODFCartManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Component to handle ODF cart items

Field Summary

Fields

Modifier and Type	Field	Description
static String	CART_USER_PREF_CONTENT_IDS	The id of user preference for cart's elements
static String	ROLE	The avalon role
static String	SUBSCRIPTION_USER_PREF_CONTENT_IDS	The id of user preference for subscription

Constructor Summary

Constructors

Constructor	Description
ODFCartManager()

Method Summary

Modifier and Type	Method	Description
boolean	addCartItem(UserIdentity owner, String itemId, String siteName)	Add a content to the cart
protected void	additionalItemInfo(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, Course course, Map<String,Object> infos)	Get the additional information for Course cart item
protected void	additionalItemInfo(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, AbstractProgram abstractProgram, Map<String,Object> infos)	Get the additional information for AbstractProgram cart item
Map<String,Object>	cartItem2Json(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, String siteName, String viewName)	Get the JSON representation of a cart item
void	contextualize(Context context)
org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem	getCartItem(String itemId)	Get a cart item from its id
List<String>	getCartItemIds(UserIdentity user, String siteName)	Get the id of ODF's cart items for a given user
protected List<String>	getCartItemIds(UserIdentity user, String siteName, String userPrefsId)	Get the id of items for a given user
List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem>	getCartItems(UserIdentity owner, String siteName)	Get the ODF's cart items for a given user
List<String>	getItemIdsWithSubscription(UserIdentity user, String siteName)	Get the id of ODF's cart items for which a given user is a subscriber
List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem>	getItemsWithSubscription(UserIdentity owner, String siteName)	Get the ODF's cart items for which the given user is a subscriber
protected String	getMailBody(List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem> items, String message, UserIdentity owner, String siteName, String language, boolean text)	Get the mail body to sharing cart
protected String	getMailSubject(String siteName, String language)	Get the mail subject for sharing cart
protected Page	getPage(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, String siteName)	Get the page associated to this cart's item
boolean	isSubscriber(UserIdentity owner, String itemId, String siteName)	determines if the user subscribes to this item
void	saveItemsInUserPreference(UserIdentity owner, List<String> itemIds, String siteName, String userPrefsId)	Save the given items into the given user preference
void	saxCartItem(ContentHandler contentHandler, org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, String siteName)	SAX a cart's item
void	saxCartItems(ContentHandler contentHandler, UserIdentity owner, String siteName)	SAX the cart's items
protected void	saxContent(ContentHandler handler, Content content, String viewName)	SAX the content view
protected void	saxPage(ContentHandler handler, org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item, String siteName)	Sax the content's page
protected void	saxTypes(ContentHandler handler, String[] types)	Sax the content types
void	service(ServiceManager serviceManager)
void	setCartItems(UserIdentity owner, List<String> itemIds, String siteName)	Set the cart's items
void	setSubscription(UserIdentity owner, List<String> itemIds, String siteName)	Subscribe to a list of items.
Map<String,Object>	shareCartItems(UserIdentity owner, List<String> itemIds, List<String> recipients, String siteName, String language, String message)	Share the cart's items by mail
boolean	subscribe(UserIdentity owner, String itemId, String siteName)	Subscribe to a content
boolean	unsubscribe(UserIdentity owner, String itemId, String siteName)	Unsubscribe to a content

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE

public static final String ROLE

The avalon role

CART_USER_PREF_CONTENT_IDS

public static final String CART_USER_PREF_CONTENT_IDS

The id of user preference for cart's elements

See Also:

Constant Field Values

SUBSCRIPTION_USER_PREF_CONTENT_IDS

public static final String SUBSCRIPTION_USER_PREF_CONTENT_IDS

The id of user preference for subscription

See Also:

Constant Field Values

Constructor Detail

ODFCartManager

public ODFCartManager()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getCartItemIds

public List<String> getCartItemIds(UserIdentity user,
                                   String siteName)
                            throws UserPreferencesException

Get the id of ODF's cart items for a given user

Parameters:

user - the user

siteName - the current site name

Returns:

the list of contents' id

Throws:

UserPreferencesException - if failed to get cart items

getItemIdsWithSubscription

public List<String> getItemIdsWithSubscription(UserIdentity user,
                                               String siteName)
                                        throws UserPreferencesException

Get the id of ODF's cart items for which a given user is a subscriber

Parameters:

user - the user

siteName - the current site name

Returns:

the list of contents' id

Throws:

UserPreferencesException - if failed to get cart items

getCartItemIds

protected List<String> getCartItemIds(UserIdentity user,
                                      String siteName,
                                      String userPrefsId)
                               throws UserPreferencesException

Get the id of items for a given user

Parameters:

user - the user

siteName - the current site name

userPrefsId - The id of user preferences

Returns:

the list of contents' id

Throws:

UserPreferencesException - if failed to get cart items

getCartItems

public List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem> getCartItems(UserIdentity owner,
                                                                                    String siteName)
                                                                             throws UserPreferencesException

Get the ODF's cart items for a given user

Parameters:

owner - the user

siteName - the current site name

Returns:

the list of contents

Throws:

UserPreferencesException - if failed to get cart items

getItemsWithSubscription

public List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem> getItemsWithSubscription(UserIdentity owner,
                                                                                                String siteName)
                                                                                         throws UserPreferencesException

Get the ODF's cart items for which the given user is a subscriber

Parameters:

owner - the user

siteName - the current site name

Returns:

the list of contents

Throws:

UserPreferencesException - if failed to get subscriptions

getCartItem

public org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem getCartItem(String itemId)

Get a cart item from its id

Parameters:

itemId - the item's id

Returns:

the cart item or null if no content was found

setCartItems

public void setCartItems(UserIdentity owner,
                         List<String> itemIds,
                         String siteName)
                  throws UserPreferencesException

Set the cart's items

Parameters:

owner - The cart owner

itemIds - the id of items to set in the cart

siteName - the site name

Throws:

UserPreferencesException - if failed to save cart

setSubscription

public void setSubscription(UserIdentity owner,
                            List<String> itemIds,
                            String siteName)
                     throws UserPreferencesException

Subscribe to a list of items. All subscriptions are replaced by the given items.

Parameters:

owner - The cart owner

itemIds - the id of items to subscribe to.

siteName - the site name

Throws:

UserPreferencesException - if failed to save subscriptions

saveItemsInUserPreference

public void saveItemsInUserPreference(UserIdentity owner,
                                      List<String> itemIds,
                                      String siteName,
                                      String userPrefsId)
                               throws UserPreferencesException

Save the given items into the given user preference

Parameters:

owner - the user

itemIds - the id of items

siteName - the site name

userPrefsId - the id of user preference

Throws:

UserPreferencesException - if failed to save user preference

addCartItem

public boolean addCartItem(UserIdentity owner,
                           String itemId,
                           String siteName)
                    throws UserPreferencesException

Add a content to the cart

Parameters:

owner - the cart owner

itemId - the id of content to add into the cart

siteName - the site name

Returns:

true if the content was successfully added

Throws:

UserPreferencesException - if failed to save cart

isSubscriber

public boolean isSubscriber(UserIdentity owner,
                            String itemId,
                            String siteName)
                     throws UserPreferencesException

determines if the user subscribes to this item

Parameters:

owner - the user

itemId - the id of content

siteName - the site name

Returns:

true if the user subscribes to this item, false otherwise

Throws:

UserPreferencesException - if failed to check subscription

subscribe

public boolean subscribe(UserIdentity owner,
                         String itemId,
                         String siteName)
                  throws UserPreferencesException

Subscribe to a content

Parameters:

owner - the cart owner

itemId - the id of content

siteName - the site name

Returns:

if the content was successfuly added to subscriptions

Throws:

UserPreferencesException - if failed to subscribe to content

unsubscribe

public boolean unsubscribe(UserIdentity owner,
                           String itemId,
                           String siteName)
                    throws UserPreferencesException

Unsubscribe to a content

Parameters:

owner - the cart owner

itemId - the id of content

siteName - the site name

Returns:

if the content was successfuly added to subscriptions

Throws:

UserPreferencesException - if failed to subscribe to content

shareCartItems

public Map<String,Object> shareCartItems(UserIdentity owner,
                                               List<String> itemIds,
                                               List<String> recipients,
                                               String siteName,
                                               String language,
                                               String message)

Share the cart's items by mail

Parameters:

owner - The cart owner

itemIds - the id of contents to set in the cart

recipients - the mails to share with

siteName - the site name

language - the language

message - the message to add to selection

Returns:

the results

getMailSubject

protected String getMailSubject(String siteName,
                                String language)

Get the mail subject for sharing cart

Parameters:

siteName - The site name

language - the language

Returns:

the mail subject

getMailBody

protected String getMailBody(List<org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem> items,
                             String message,
                             UserIdentity owner,
                             String siteName,
                             String language,
                             boolean text)
                      throws IOException

Get the mail body to sharing cart

Parameters:

items - The cart's items

message - The message

owner - The cart's owner

siteName - The site name

language - the language

text - true to get the body to text body (html otherwise)

Returns:

the cart items to HTML format

Throws:

IOException - if failed to mail body

saxCartItems

public void saxCartItems(ContentHandler contentHandler,
                         UserIdentity owner,
                         String siteName)
                  throws SAXException,
                         IOException,
                         UserPreferencesException

SAX the cart's items

Parameters:

contentHandler - The content handler to sax into

owner - the cart owner

siteName - the site name

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

UserPreferencesException - if failed to get cart items

saxCartItem

public void saxCartItem(ContentHandler contentHandler,
                        org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                        String siteName)
                 throws SAXException,
                        IOException

SAX a cart's item

Parameters:

contentHandler - The content handler to sax into

item - the cart's item

siteName - the site name

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

cartItem2Json

public Map<String,Object> cartItem2Json(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                                              String siteName,
                                              String viewName)
                                       throws IOException

Get the JSON representation of a cart item

Parameters:

item - The cart's item

siteName - The site name

viewName - The name of content view to use

Returns:

The cart items properties

Throws:

IOException - if failed to read content view

additionalItemInfo

protected void additionalItemInfo(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                                  AbstractProgram abstractProgram,
                                  Map<String,Object> infos)

Get the additional information for AbstractProgram cart item

Parameters:

item - the odf cart item

abstractProgram - the abstract program

infos - the information to be completed

additionalItemInfo

protected void additionalItemInfo(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                                  Course course,
                                  Map<String,Object> infos)

Get the additional information for Course cart item

Parameters:

item - the odf cart item

course - the abstract program

infos - the information to be completed

saxTypes

protected void saxTypes(ContentHandler handler,
                        String[] types)
                 throws SAXException

Sax the content types

Parameters:

handler - The content handler to sax into

types - The content types

Throws:

SAXException - if an error occurred while saxing

saxContent

protected void saxContent(ContentHandler handler,
                          Content content,
                          String viewName)
                   throws SAXException,
                          IOException

SAX the content view

Parameters:

handler - The content handler to sax into

content - The content

viewName - The view name

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

saxPage

protected void saxPage(ContentHandler handler,
                       org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                       String siteName)
                throws SAXException

Sax the content's page

Parameters:

handler - The content handler to sax into

item - The cart's item

siteName - The current site name

Throws:

SAXException - if an error occurred while saxing

getPage

protected Page getPage(org.ametys.plugins.odfweb.cart.ODFCartManager.ODFCartItem item,
                       String siteName)

Get the page associated to this cart's item

Parameters:

item - The item

siteName - The site name

Returns:

the page or null if not found