com.liferay.segments.service

Class SegmentsEntryLocalServiceUtil

java.lang.Object

com.liferay.segments.service.SegmentsEntryLocalServiceUtil

public class SegmentsEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for SegmentsEntry. This utility wraps com.liferay.segments.service.impl.SegmentsEntryLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

SegmentsEntryLocalService

Constructor Summary

Constructors

Constructor and Description
SegmentsEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static SegmentsEntry	addSegmentsEntry(SegmentsEntry segmentsEntry) Adds the segments entry to the database.
static SegmentsEntry	addSegmentsEntry(java.lang.String segmentsEntryKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, java.lang.String criteria, java.lang.String type, ServiceContext serviceContext)
static SegmentsEntry	addSegmentsEntry(java.lang.String segmentsEntryKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, java.lang.String criteria, java.lang.String source, java.lang.String type, ServiceContext serviceContext)
static void	addSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs, ServiceContext serviceContext)
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static SegmentsEntry	createSegmentsEntry(long segmentsEntryId) Creates a new segments entry with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteSegmentsEntries(long groupId)
static void	deleteSegmentsEntries(java.lang.String source)
static SegmentsEntry	deleteSegmentsEntry(long segmentsEntryId) Deletes the segments entry with the primary key from the database.
static SegmentsEntry	deleteSegmentsEntry(SegmentsEntry segmentsEntry) Deletes the segments entry from the database.
static void	deleteSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static SegmentsEntry	fetchSegmentsEntry(long segmentsEntryId)
static SegmentsEntry	fetchSegmentsEntry(long groupId, java.lang.String segmentsEntryKey, boolean includeAncestorSegmentsEntries)
static SegmentsEntry	fetchSegmentsEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the segments entry matching the UUID and group.
static ActionableDynamicQuery	getActionableDynamicQuery()
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static java.util.List<SegmentsEntry>	getSegmentsEntries(int start, int end) Returns a range of all the segments entries.
static java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean includeAncestorSegmentsEntries, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
static java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean active, java.lang.String type, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
static java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean active, java.lang.String source, java.lang.String type, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
static java.util.List<SegmentsEntry>	getSegmentsEntriesBySource(java.lang.String source, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
static java.util.List<SegmentsEntry>	getSegmentsEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the segments entries matching the UUID and company.
static java.util.List<SegmentsEntry>	getSegmentsEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator) Returns a range of segments entries matching the UUID and company.
static int	getSegmentsEntriesCount() Returns the number of segments entries.
static int	getSegmentsEntriesCount(long groupId, boolean includeAncestorSegmentsEntries)
static SegmentsEntry	getSegmentsEntry(long segmentsEntryId) Returns the segments entry with the primary key.
static SegmentsEntry	getSegmentsEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the segments entry matching the UUID and group.
static SegmentsEntryLocalService	getService()
static BaseModelSearchResult<SegmentsEntry>	searchSegmentsEntries(long companyId, long groupId, java.lang.String keywords, boolean includeAncestorSegmentsEntries, int start, int end, Sort sort) Deprecated. As of Athanasius (7.3.x), replaced by searchSegmentsEntries(long, long, String, boolean, LinkedHashMap, int, int, Sort)
static BaseModelSearchResult<SegmentsEntry>	searchSegmentsEntries(long companyId, long groupId, java.lang.String keywords, boolean includeAncestorSegmentsEntries, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, Sort sort)
static BaseModelSearchResult<SegmentsEntry>	searchSegmentsEntries(SearchContext searchContext)
static SegmentsEntry	updateSegmentsEntry(long segmentsEntryId, java.lang.String segmentsEntryKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, java.lang.String criteria, ServiceContext serviceContext)
static SegmentsEntry	updateSegmentsEntry(SegmentsEntry segmentsEntry) Updates the segments entry in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SegmentsEntryLocalServiceUtil

public SegmentsEntryLocalServiceUtil()

Method Detail

addSegmentsEntry

public static SegmentsEntry addSegmentsEntry(SegmentsEntry segmentsEntry)

Adds the segments entry to the database. Also notifies the appropriate model listeners.

Important: Inspect SegmentsEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

segmentsEntry - the segments entry

Returns:

the segments entry that was added

addSegmentsEntry

public static SegmentsEntry addSegmentsEntry(java.lang.String segmentsEntryKey,
                                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                             boolean active,
                                             java.lang.String criteria,
                                             java.lang.String type,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

addSegmentsEntry

public static SegmentsEntry addSegmentsEntry(java.lang.String segmentsEntryKey,
                                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                             boolean active,
                                             java.lang.String criteria,
                                             java.lang.String source,
                                             java.lang.String type,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

addSegmentsEntryClassPKs

public static void addSegmentsEntryClassPKs(long segmentsEntryId,
                                            long[] classPKs,
                                            ServiceContext serviceContext)
                                     throws PortalException

Throws:

PortalException

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createSegmentsEntry

public static SegmentsEntry createSegmentsEntry(long segmentsEntryId)

Creates a new segments entry with the primary key. Does not add the segments entry to the database.

Parameters:

segmentsEntryId - the primary key for the new segments entry

Returns:

the new segments entry

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteSegmentsEntries

public static void deleteSegmentsEntries(long groupId)
                                  throws PortalException

Throws:

PortalException

deleteSegmentsEntries

public static void deleteSegmentsEntries(java.lang.String source)
                                  throws PortalException

Throws:

PortalException

deleteSegmentsEntry

public static SegmentsEntry deleteSegmentsEntry(long segmentsEntryId)
                                         throws PortalException

Deletes the segments entry with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect SegmentsEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

segmentsEntryId - the primary key of the segments entry

Returns:

the segments entry that was removed

Throws:

PortalException - if a segments entry with the primary key could not be found

deleteSegmentsEntry

public static SegmentsEntry deleteSegmentsEntry(SegmentsEntry segmentsEntry)
                                         throws PortalException

Deletes the segments entry from the database. Also notifies the appropriate model listeners.

Important: Inspect SegmentsEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

segmentsEntry - the segments entry

Returns:

the segments entry that was removed

Throws:

PortalException

deleteSegmentsEntryClassPKs

public static void deleteSegmentsEntryClassPKs(long segmentsEntryId,
                                               long[] classPKs)
                                        throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.segments.model.impl.SegmentsEntryModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.segments.model.impl.SegmentsEntryModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSegmentsEntry

public static SegmentsEntry fetchSegmentsEntry(long segmentsEntryId)

fetchSegmentsEntry

public static SegmentsEntry fetchSegmentsEntry(long groupId,
                                               java.lang.String segmentsEntryKey,
                                               boolean includeAncestorSegmentsEntries)

fetchSegmentsEntryByUuidAndGroupId

public static SegmentsEntry fetchSegmentsEntryByUuidAndGroupId(java.lang.String uuid,
                                                               long groupId)

Returns the segments entry matching the UUID and group.

Parameters:

uuid - the segments entry's UUID

groupId - the primary key of the group

Returns:

the matching segments entry, or null if a matching segments entry could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getSegmentsEntries

public static java.util.List<SegmentsEntry> getSegmentsEntries(int start,
                                                               int end)

Returns a range of all the segments entries.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.segments.model.impl.SegmentsEntryModelImpl.

Parameters:

start - the lower bound of the range of segments entries

end - the upper bound of the range of segments entries (not inclusive)

Returns:

the range of segments entries

getSegmentsEntries

public static java.util.List<SegmentsEntry> getSegmentsEntries(long groupId,
                                                               boolean includeAncestorSegmentsEntries,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntries

public static java.util.List<SegmentsEntry> getSegmentsEntries(long groupId,
                                                               boolean active,
                                                               java.lang.String type,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntries

public static java.util.List<SegmentsEntry> getSegmentsEntries(long groupId,
                                                               boolean active,
                                                               java.lang.String source,
                                                               java.lang.String type,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntriesBySource

public static java.util.List<SegmentsEntry> getSegmentsEntriesBySource(java.lang.String source,
                                                                       int start,
                                                                       int end,
                                                                       OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntriesByUuidAndCompanyId

public static java.util.List<SegmentsEntry> getSegmentsEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                                 long companyId)

Returns all the segments entries matching the UUID and company.

Parameters:

uuid - the UUID of the segments entries

companyId - the primary key of the company

Returns:

the matching segments entries, or an empty list if no matches were found

getSegmentsEntriesByUuidAndCompanyId

public static java.util.List<SegmentsEntry> getSegmentsEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                                 long companyId,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator<SegmentsEntry> orderByComparator)

Returns a range of segments entries matching the UUID and company.

Parameters:

uuid - the UUID of the segments entries

companyId - the primary key of the company

start - the lower bound of the range of segments entries

end - the upper bound of the range of segments entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching segments entries, or an empty list if no matches were found

getSegmentsEntriesCount

public static int getSegmentsEntriesCount()

Returns the number of segments entries.

Returns:

the number of segments entries

getSegmentsEntriesCount

public static int getSegmentsEntriesCount(long groupId,
                                          boolean includeAncestorSegmentsEntries)

getSegmentsEntry

public static SegmentsEntry getSegmentsEntry(long segmentsEntryId)
                                      throws PortalException

Returns the segments entry with the primary key.

Parameters:

segmentsEntryId - the primary key of the segments entry

Returns:

the segments entry

Throws:

PortalException - if a segments entry with the primary key could not be found

getSegmentsEntryByUuidAndGroupId

public static SegmentsEntry getSegmentsEntryByUuidAndGroupId(java.lang.String uuid,
                                                             long groupId)
                                                      throws PortalException

Returns the segments entry matching the UUID and group.

Parameters:

uuid - the segments entry's UUID

groupId - the primary key of the group

Returns:

the matching segments entry

Throws:

PortalException - if a matching segments entry could not be found

searchSegmentsEntries

@Deprecated
public static BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(long companyId,
                                                                                     long groupId,
                                                                                     java.lang.String keywords,
                                                                                     boolean includeAncestorSegmentsEntries,
                                                                                     int start,
                                                                                     int end,
                                                                                     Sort sort)
                                                                              throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by searchSegmentsEntries(long, long, String, boolean, LinkedHashMap, int, int, Sort)

Throws:

PortalException

searchSegmentsEntries

public static BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(long companyId,
                                                                         long groupId,
                                                                         java.lang.String keywords,
                                                                         boolean includeAncestorSegmentsEntries,
                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                         int start,
                                                                         int end,
                                                                         Sort sort)
                                                                  throws PortalException

Throws:

PortalException

searchSegmentsEntries

public static BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(SearchContext searchContext)
                                                                  throws PortalException

Throws:

PortalException

updateSegmentsEntry

public static SegmentsEntry updateSegmentsEntry(long segmentsEntryId,
                                                java.lang.String segmentsEntryKey,
                                                java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                boolean active,
                                                java.lang.String criteria,
                                                ServiceContext serviceContext)
                                         throws PortalException

Throws:

PortalException

updateSegmentsEntry

public static SegmentsEntry updateSegmentsEntry(SegmentsEntry segmentsEntry)

Updates the segments entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect SegmentsEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

segmentsEntry - the segments entry

Returns:

the segments entry that was updated

getService

public static SegmentsEntryLocalService getService()