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:

CVS $Id: BasketManager.html 1304258 2012-03-23 10:09:27Z ilgrosso $

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

static final String ROLE

The component role

BASKET_KEY

static final String BASKET_KEY

This key is used to store the current basket in the session

BRIEFCASE_KEY

static final String BRIEFCASE_KEY

This key is used to store the current briefcase in the session

FOLDER_KEY

static final String FOLDER_KEY

This key is used to store the current folder in the session

ALL_BRIEFCASES_KEY

static final String ALL_BRIEFCASES_KEY

This key is used to store all briefcases in the session (of the admin)

Method Detail

getBasket

Basket getBasket()

Return the basket of the current user

getBriefcase

Briefcase getBriefcase()

Return the briefcase of the current user

getFolder

Folder getFolder()

Return the folder of the current user

getBriefcaseDescriptions

List getBriefcaseDescriptions()

Return all briefcases. This is a list of ContentStoreDescription objects.

getBasketActions

List getBasketActions()

Return all configured actions for a basket - this is a list of BasketManager.ActionInfos.

getBasketAction

BasketManager.ActionInfo getBasketAction(String name)

Get the info

getBriefcaseActions

List getBriefcaseActions()

Return all configured actions for a briefcase - this is a list of BasketManager.ActionInfos.

getBriefcaseAction

BasketManager.ActionInfo getBriefcaseAction(String name)

Get the info

addBatch

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

update

void update(ContentStore store)

Update/save the content store