Interface ItemSelector


@ProviderType public interface ItemSelector
Provides a helper class to retrieve the ItemSelectorRendering and the PortletURL for the item selector.
  • Method Details

    • getItemSelectedEventName

      String getItemSelectedEventName(String itemSelectorURL)
      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

      List<ItemSelectorCriterion> getItemSelectorCriteria(Map<String,String[]> parameters)
    • getItemSelectorCriteria

      List<ItemSelectorCriterion> getItemSelectorCriteria(String itemSelectorURL)
      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 the ItemSelectorRendering according to the parameters.
      Parameters:
      requestBackedPortletURLFactory - the factory used to generate the PortletURL
      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 selector PortletURL to render the item selector and show the selection views, scoped to the group matching the ItemSelectorCriterion and ItemSelectorReturnType. This method is not recommended for external use.
      Parameters:
      requestBackedPortletURLFactory - the factory used to generate the PortletURL
      group - the group from which to select items
      refererGroupId - the group ID of the item selector client
      itemSelectedEventName - the event name for views to fire
      itemSelectorCriteria - 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 selector PortletURL to render the item selector and show the selection views matching the ItemSelectorCriterion and ItemSelectorReturnType.
      Parameters:
      requestBackedPortletURLFactory - the factory used to generate the PortletURL
      itemSelectedEventName - the event name for views to fire
      itemSelectorCriteria - an array of criteria for the item selector to use to retrieve the views
      Returns:
      a generated item selector PortletURL