Package com.liferay.item.selector
Interface ItemSelector
@ProviderType
public interface ItemSelector
Provides a helper class to retrieve the
ItemSelectorRendering
and the
PortletURL
for the item selector.-
Method Summary
Modifier and TypeMethodDescriptiongetItemSelectedEventName
(String itemSelectorURL) Returns the selected event name used to create the item selector URL.getItemSelectorCriteria
(String itemSelectorURL) Returns the item selector criteria that was used to create the item selector URL.getItemSelectorCriteria
(Map<String, String[]> parameters) getItemSelectorRendering
(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, Map<String, String[]> parameters, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns theItemSelectorRendering
according to the parameters.javax.portlet.PortletURL
getItemSelectorURL
(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, com.liferay.portal.kernel.model.Group group, long refererGroupId, String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria) Returns a generated item selectorPortletURL
to render the item selector and show the selection views, scoped to the group matching theItemSelectorCriterion
andItemSelectorReturnType
.javax.portlet.PortletURL
getItemSelectorURL
(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria) Returns a generated item selectorPortletURL
to render the item selector and show the selection views matching theItemSelectorCriterion
andItemSelectorReturnType
.
-
Method Details
-
getItemSelectedEventName
Returns the selected event name used to create the item selector URL.- Parameters:
itemSelectorURL
- the unescaped item selector URL- Returns:
- the selected event name
-
getItemSelectorCriteria
-
getItemSelectorCriteria
Returns the item selector criteria that was used to create the item selector URL.- Parameters:
itemSelectorURL
- the unescaped item selector URL- Returns:
- the item selector criteria
-
getItemSelectorRendering
ItemSelectorRendering getItemSelectorRendering(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, Map<String, String[]> parameters, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns theItemSelectorRendering
according to the parameters.- Parameters:
requestBackedPortletURLFactory
- the factory used to generate thePortletURL
parameters
- the map of parameters received in the URL. The item selector framework uses them to get and render the views.themeDisplay
- the current theme display- Returns:
- the
ItemSelectorRendering
-
getItemSelectorURL
javax.portlet.PortletURL getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, com.liferay.portal.kernel.model.Group group, long refererGroupId, String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria) Returns a generated item selectorPortletURL
to render the item selector and show the selection views, scoped to the group matching theItemSelectorCriterion
andItemSelectorReturnType
. This method is not recommended for external use.- Parameters:
requestBackedPortletURLFactory
- the factory used to generate thePortletURL
group
- the group from which to select itemsrefererGroupId
- the group ID of the item selector clientitemSelectedEventName
- the event name for views to fireitemSelectorCriteria
- an array of criteria for the item selector to use to retrieve views- Returns:
- a generated item selector
PortletURL
-
getItemSelectorURL
javax.portlet.PortletURL getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria) Returns a generated item selectorPortletURL
to render the item selector and show the selection views matching theItemSelectorCriterion
andItemSelectorReturnType
.- Parameters:
requestBackedPortletURLFactory
- the factory used to generate thePortletURL
itemSelectedEventName
- the event name for views to fireitemSelectorCriteria
- an array of criteria for the item selector to use to retrieve the views- Returns:
- a generated item selector
PortletURL
-