org.osivia.portal.api.selection
Interface ISelectionService

public interface ISelectionService

Selection service interface.

Author:

Cédric Krommenhoek

Method Summary

boolean	addItem(PortalControllerContext portalCtx, java.lang.String selectionId, SelectionItem selectionItem) Add item to a specified selection.
void	deleteSelection(PortalControllerContext portalCtx, java.lang.String selectionId) Delete a specified selection.
java.util.Set<SelectionItem>	getSelectionItems(PortalControllerContext portalCtx, java.lang.String selectionId) Access to a specified selection items set.
boolean	removeItem(PortalControllerContext portalCtx, java.lang.String selectionId, java.lang.String itemId) Remove item to a specified selection.

Method Detail

addItem

boolean addItem(PortalControllerContext portalCtx,
                java.lang.String selectionId,
                SelectionItem selectionItem)

Add item to a specified selection.

Parameters:

portalCtx - portal controller context

selectionId - specified selection identifier

selectionItem - item to add

Returns:

true if the item has been added

removeItem

boolean removeItem(PortalControllerContext portalCtx,
                   java.lang.String selectionId,
                   java.lang.String itemId)

Remove item to a specified selection.

Parameters:

portalCtx - portal controller context

selectionId - specified selection identifier

itemId - item to remove identifier

Returns:

true if the item has been removed

getSelectionItems

java.util.Set<SelectionItem> getSelectionItems(PortalControllerContext portalCtx,
                                               java.lang.String selectionId)

Access to a specified selection items set.

Parameters:

portalCtx - portal controller context

selectionId - specified selection identifier

Returns:

the selection items set

deleteSelection

void deleteSelection(PortalControllerContext portalCtx,
                     java.lang.String selectionId)

Delete a specified selection.

Parameters:

portalCtx - portal controller context

selectionId - specified selection identifier