org.apache.cocoon.portal.coplets.basket
Interface BasketManager

All Known Implementing Classes:
BasketManagerImpl

public interface BasketManager

This is the manager for content-stores: baskets, briefcases and folders. You can retrieve the current basket, briefcase or folder for the user from this manager.

Version:
$Id: BasketManager.java 322471 2005-10-16 13:24:19Z cziegeler $

Nested Class Summary
static class BasketManager.ActionInfo
          An action info consists of a name and a url
 
Field Summary
static String ALL_BRIEFCASES_KEY
          This key is used to store all briefcases in the session (of the admin)
static String BASKET_KEY
          This key is used to store the current basket in the session
static String BRIEFCASE_KEY
          This key is used to store the current briefcase in the session
static String FOLDER_KEY
          This key is used to store the current folder in the session
static String ROLE
          The component role
 
Method Summary
 void addBatch(ContentItem item, int frequencyInDays, BasketManager.ActionInfo action)
           
 Basket getBasket()
          Return the basket of the current user
 BasketManager.ActionInfo getBasketAction(String name)
          Get the info
 List getBasketActions()
          Return all configured actions for a basket - this is a list of BasketManager.ActionInfos.
 Briefcase getBriefcase()
          Return the briefcase of the current user
 BasketManager.ActionInfo getBriefcaseAction(String name)
          Get the info
 List getBriefcaseActions()
          Return all configured actions for a briefcase - this is a list of BasketManager.ActionInfos.
 List getBriefcaseDescriptions()
          Return all briefcases.
 Folder getFolder()
          Return the folder of the current user
 void update(ContentStore store)
          Update/save the content store
 

Field Detail

ROLE

public static final String ROLE
The component role


BASKET_KEY

public static final String BASKET_KEY
This key is used to store the current basket in the session


BRIEFCASE_KEY

public static final String BRIEFCASE_KEY
This key is used to store the current briefcase in the session


FOLDER_KEY

public static final String FOLDER_KEY
This key is used to store the current folder in the session


ALL_BRIEFCASES_KEY

public static final String ALL_BRIEFCASES_KEY
This key is used to store all briefcases in the session (of the admin)

Method Detail

getBasket

public Basket getBasket()
Return the basket of the current user


getBriefcase

public Briefcase getBriefcase()
Return the briefcase of the current user


getFolder

public Folder getFolder()
Return the folder of the current user


getBriefcaseDescriptions

public List getBriefcaseDescriptions()
Return all briefcases. This is a list of ContentStoreDescription objects.


getBasketActions

public List getBasketActions()
Return all configured actions for a basket - this is a list of BasketManager.ActionInfos.


getBasketAction

public BasketManager.ActionInfo getBasketAction(String name)
Get the info


getBriefcaseActions

public List getBriefcaseActions()
Return all configured actions for a briefcase - this is a list of BasketManager.ActionInfos.


getBriefcaseAction

public BasketManager.ActionInfo getBriefcaseAction(String name)
Get the info


addBatch

public void addBatch(ContentItem item,
                     int frequencyInDays,
                     BasketManager.ActionInfo action)

update

public void update(ContentStore store)
Update/save the content store



Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.