@ProviderType
public interface ItemSelector
ItemSelectorRendering
and the
PortletURL
for the item selector.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getItemSelectedEventName(java.lang.String itemSelectorURL)
Returns the selected event name used to create the item selector URL.
|
java.util.List<ItemSelectorCriterion> |
getItemSelectorCriteria(java.util.Map<java.lang.String,java.lang.String[]> parameters) |
java.util.List<ItemSelectorCriterion> |
getItemSelectorCriteria(java.lang.String itemSelectorURL)
Returns the item selector criteria that was used to create the item
selector URL.
|
ItemSelectorRendering |
getItemSelectorRendering(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory,
java.util.Map<java.lang.String,java.lang.String[]> parameters,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns the
ItemSelectorRendering according to the parameters. |
javax.portlet.PortletURL |
getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory,
com.liferay.portal.kernel.model.Group group,
long refererGroupId,
java.lang.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 . |
javax.portlet.PortletURL |
getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory,
java.lang.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 . |
java.lang.String getItemSelectedEventName(java.lang.String itemSelectorURL)
itemSelectorURL
- the unescaped item selector URLjava.util.List<ItemSelectorCriterion> getItemSelectorCriteria(java.util.Map<java.lang.String,java.lang.String[]> parameters)
java.util.List<ItemSelectorCriterion> getItemSelectorCriteria(java.lang.String itemSelectorURL)
itemSelectorURL
- the unescaped item selector URLItemSelectorRendering getItemSelectorRendering(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, java.util.Map<java.lang.String,java.lang.String[]> parameters, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
ItemSelectorRendering
according to the 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 displayItemSelectorRendering
javax.portlet.PortletURL getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, com.liferay.portal.kernel.model.Group group, long refererGroupId, java.lang.String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria)
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.requestBackedPortletURLFactory
- the factory used to generate the
PortletURL
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 viewsPortletURL
javax.portlet.PortletURL getItemSelectorURL(com.liferay.portal.kernel.portlet.RequestBackedPortletURLFactory requestBackedPortletURLFactory, java.lang.String itemSelectedEventName, ItemSelectorCriterion... itemSelectorCriteria)
PortletURL
to render the item
selector and show the selection views matching the ItemSelectorCriterion
and ItemSelectorReturnType
.requestBackedPortletURLFactory
- the factory used to generate the
PortletURL
itemSelectedEventName
- the event name for views to fireitemSelectorCriteria
- an array of criteria for the item selector
to use to retrieve the viewsPortletURL