com.liferay.segments.provider

Interface SegmentsEntryProvider

@ProviderType
public interface SegmentsEntryProvider

Provides methods for obtaining SegmentsEntry objects and their related entities.

Method Summary

Modifier and Type	Method and Description
long[]	getSegmentsEntryClassPKs(long segmentsEntryId, int start, int end) Returns the primary keys of the entities related with the segment.
int	getSegmentsEntryClassPKsCount(long segmentsEntryId) Returns the number of entities related with the segment.
long[]	getSegmentsEntryIds(long groupId, java.lang.String className, long classPK) Returns IDs of the active SegmentsEntry objects of a group that are related with the entity.
long[]	getSegmentsEntryIds(long groupId, java.lang.String className, long classPK, Context context) Returns IDs of the active SegmentsEntry objects of a group that related with the entity under the given context.

Method Detail

getSegmentsEntryClassPKs

long[] getSegmentsEntryClassPKs(long segmentsEntryId,
                                int start,
                                int end)
                         throws com.liferay.portal.kernel.exception.PortalException

Returns the primary keys of the entities related with the segment.

Parameters:

segmentsEntryId - the ID of the segment

start - the lower bound of the range of primary keys

end - the upper bound of the range of primary keys (not inclusive)

Returns:

the primary keys of the entities related with the segment

Throws:

com.liferay.portal.kernel.exception.PortalException

getSegmentsEntryClassPKsCount

int getSegmentsEntryClassPKsCount(long segmentsEntryId)
                           throws com.liferay.portal.kernel.exception.PortalException

Returns the number of entities related with the segment.

Parameters:

segmentsEntryId - the ID of the segment

Returns:

the number of entities related with the segment

Throws:

com.liferay.portal.kernel.exception.PortalException

getSegmentsEntryIds

long[] getSegmentsEntryIds(long groupId,
                           java.lang.String className,
                           long classPK)
                    throws com.liferay.portal.kernel.exception.PortalException

Returns IDs of the active SegmentsEntry objects of a group that are related with the entity.

Parameters:

groupId - the primary key of the group

className - the class name of the entity

classPK - the primary key of the entity

Returns:

the IDs the of active SegmentsEntry objects related to the entity

Throws:

com.liferay.portal.kernel.exception.PortalException

getSegmentsEntryIds

long[] getSegmentsEntryIds(long groupId,
                           java.lang.String className,
                           long classPK,
                           Context context)
                    throws com.liferay.portal.kernel.exception.PortalException

Returns IDs of the active SegmentsEntry objects of a group that related with the entity under the given context.

Parameters:

groupId - the primary key of the group

className - the class name of the entity

classPK - the primary key of the entity

context - the context

Returns:

the IDs the of active SegmentsEntry objects related to the entity

Throws:

com.liferay.portal.kernel.exception.PortalException