org.osivia.portal.api.selection

Interface ISelectionService

public interface ISelectionService

Selection service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME MBean name.

Method Summary

Modifier and Type	Method and Description
boolean	addItem(PortalControllerContext portalControllerContext, String id, SelectionItem item) Add item to a specified selection.
void	deleteSelection(PortalControllerContext portalControllerContext, String id) Delete a specified selection.
Set<SelectionItem>	getSelectionItems(PortalControllerContext portalControllerContext, String id) Access to a specified selection items set.
boolean	removeItem(PortalControllerContext portalControllerContext, String id, String itemId) Remove item to a specified selection.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

Method Detail

addItem

boolean addItem(PortalControllerContext portalControllerContext,
                String id,
                SelectionItem item)

Add item to a specified selection.

Parameters:

portalControllerContext - portal controller context

id - specified selection identifier

item - selection item to add

Returns:

true if the item has been added

removeItem

boolean removeItem(PortalControllerContext portalControllerContext,
                   String id,
                   String itemId)

Remove item to a specified selection.

Parameters:

portalControllerContext - portal controller context

id - specified selection identifier

itemId - item to remove identifier

Returns:

true if the item has been removed

getSelectionItems

Set<SelectionItem> getSelectionItems(PortalControllerContext portalControllerContext,
                                     String id)

Access to a specified selection items set.

Parameters:

portalControllerContext - portal controller context

id - specified selection identifier

Returns:

the selection items set

deleteSelection

void deleteSelection(PortalControllerContext portalControllerContext,
                     String id)

Delete a specified selection.

Parameters:

portalControllerContext - portal controller context

id - specified selection identifier