Package com.liferay.segments.provider
Interface SegmentsEntryProvider
@ProviderType
public interface SegmentsEntryProvider
Provides methods for obtaining
SegmentsEntrys and their related
entities.-
Method Summary
Modifier and TypeMethodDescriptionlong[]getSegmentsEntryClassPKs(long segmentsEntryId, int start, int end) Returns the primary keys of the entities related to the segment.intgetSegmentsEntryClassPKsCount(long segmentsEntryId) Returns the number of entities related to the segment.default long[]getSegmentsEntryIds(long groupId, String className, long classPK) Returns IDs of the group's active segments entries that are related to the entity.long[]getSegmentsEntryIds(long groupId, String className, long classPK, Context context) Returns IDs of the group's active segments entries that are related to the entity under the given context.default long[]getSegmentsEntryIds(long groupId, String className, long classPK, Context context, long[] segmentsEntryIds) Returns IDs of the group's active segments entries that are related to the entity under the given context.default long[]getSegmentsEntryIds(long groupId, String className, long classPK, Context context, long[] filterSegmentsEntryIds, long[] segmentsEntryIds) Returns IDs of the group's active segments entries that are related to the entity under the given context.
-
Method Details
-
getSegmentsEntryClassPKs
long[] getSegmentsEntryClassPKs(long segmentsEntryId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException Returns the primary keys of the entities related to the segment.- Parameters:
segmentsEntryId- the segment's IDstart- the lower bound of the range of primary keysend- the upper bound of the range of primary keys (not inclusive)- Returns:
- the primary keys of the entities related to the segment
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getSegmentsEntryClassPKsCount
int getSegmentsEntryClassPKsCount(long segmentsEntryId) throws com.liferay.portal.kernel.exception.PortalException Returns the number of entities related to the segment.- Parameters:
segmentsEntryId- the segment's ID- Returns:
- the number of entities related to the segment
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getSegmentsEntryIds
default long[] getSegmentsEntryIds(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns IDs of the group's active segments entries that are related to the entity.- Parameters:
groupId- the primary key of the groupclassName- the entity's class nameclassPK- the primary key of the entity- Returns:
- the IDs of the active segments entries related to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getSegmentsEntryIds
long[] getSegmentsEntryIds(long groupId, String className, long classPK, Context context) throws com.liferay.portal.kernel.exception.PortalException Returns IDs of the group's active segments entries that are related to the entity under the given context.- Parameters:
groupId- the primary key of the groupclassName- the entity's class nameclassPK- the primary key of the entitycontext- the context- Returns:
- the IDs of the active segments entries related to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getSegmentsEntryIds
default long[] getSegmentsEntryIds(long groupId, String className, long classPK, Context context, long[] segmentsEntryIds) throws com.liferay.portal.kernel.exception.PortalException Returns IDs of the group's active segments entries that are related to the entity under the given context.- Parameters:
groupId- the primary key of the groupclassName- the entity's class nameclassPK- the primary key of the entitycontext- the contextsegmentsEntryIds- the IDs of the group's active segments entries that are currently related to the entity under the given context- Returns:
- the IDs of the active segments entries related to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
getSegmentsEntryIds
default long[] getSegmentsEntryIds(long groupId, String className, long classPK, Context context, long[] filterSegmentsEntryIds, long[] segmentsEntryIds) throws com.liferay.portal.kernel.exception.PortalException Returns IDs of the group's active segments entries that are related to the entity under the given context.- Parameters:
groupId- the primary key of the groupclassName- the entity's class nameclassPK- the primary key of the entitycontext- the contextfilterSegmentsEntryIds- the IDs of the segments entries that could be returnedsegmentsEntryIds- the IDs of the group's active segments entries that are currently related to the entity under the given context- Returns:
- the IDs of the active segments entries related to the entity
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-