Class SegmentsEntryLocalServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SegmentsEntry
addSegmentsEntry
(SegmentsEntry segmentsEntry) Adds the segments entry to the database.static SegmentsEntry
addSegmentsEntry
(String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, String criteria, com.liferay.portal.kernel.service.ServiceContext serviceContext) static SegmentsEntry
addSegmentsEntry
(String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, String criteria, String source, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
addSegmentsEntryClassPKs
(long segmentsEntryId, long[] classPKs, com.liferay.portal.kernel.service.ServiceContext serviceContext) static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static SegmentsEntry
createSegmentsEntry
(long segmentsEntryId) Creates a new segments entry with the primary key.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static void
deleteSegmentsEntries
(long groupId) static void
deleteSegmentsEntries
(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
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static SegmentsEntry
fetchSegmentsEntry
(long segmentsEntryId) static SegmentsEntry
fetchSegmentsEntry
(long groupId, String segmentsEntryKey) static SegmentsEntry
fetchSegmentsEntryByUuidAndGroupId
(String uuid, long groupId) Returns the segments entry matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static List<SegmentsEntry>
getSegmentsEntries
(int start, int end) Returns a range of all the segments entries.static List<SegmentsEntry>
getSegmentsEntries
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) static List<SegmentsEntry>
getSegmentsEntries
(long groupId, String source, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) static List<SegmentsEntry>
getSegmentsEntriesBySource
(String source, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) static List<SegmentsEntry>
getSegmentsEntriesByUuidAndCompanyId
(String uuid, long companyId) Returns all the segments entries matching the UUID and company.static List<SegmentsEntry>
getSegmentsEntriesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) Returns a range of segments entries matching the UUID and company.static int
Returns the number of segments entries.static int
getSegmentsEntriesCount
(long groupId) static SegmentsEntry
getSegmentsEntry
(long segmentsEntryId) Returns the segments entry with the primary key.static SegmentsEntry
getSegmentsEntryByUuidAndGroupId
(String uuid, long groupId) Returns the segments entry matching the UUID and group.static SegmentsEntryLocalService
static com.liferay.portal.kernel.search.BaseModelSearchResult<SegmentsEntry>
searchSegmentsEntries
(long companyId, long groupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort) static com.liferay.portal.kernel.search.BaseModelSearchResult<SegmentsEntry>
searchSegmentsEntries
(com.liferay.portal.kernel.search.SearchContext searchContext) static SegmentsEntry
updateSegmentsEntry
(long segmentsEntryId, String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, String criteria, com.liferay.portal.kernel.service.ServiceContext serviceContext) static SegmentsEntry
updateSegmentsEntry
(SegmentsEntry segmentsEntry) Updates the segments entry in the database or adds it if it does not yet exist.
-
Constructor Details
-
SegmentsEntryLocalServiceUtil
public SegmentsEntryLocalServiceUtil()
-
-
Method Details
-
addSegmentsEntry
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(String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, boolean active, String criteria, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSegmentsEntry
public static SegmentsEntry addSegmentsEntry(String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, boolean active, String criteria, String source, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSegmentsEntryClassPKs
public static void addSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createSegmentsEntry
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 com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSegmentsEntries
public static void deleteSegmentsEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSegmentsEntries
public static void deleteSegmentsEntries(String source) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSegmentsEntry
public static SegmentsEntry deleteSegmentsEntry(long segmentsEntryId) throws com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
- if a segments entry with the primary key could not be found
-
deleteSegmentsEntry
public static SegmentsEntry deleteSegmentsEntry(SegmentsEntry segmentsEntry) throws com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
-
deleteSegmentsEntryClassPKs
public static void deleteSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.segments.model.impl.SegmentsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.segments.model.impl.SegmentsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSegmentsEntry
-
fetchSegmentsEntry
-
fetchSegmentsEntryByUuidAndGroupId
Returns the segments entry matching the UUID and group.- Parameters:
uuid
- the segments entry's UUIDgroupId
- 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSegmentsEntries
Returns a range of all the segments entries.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.segments.model.impl.SegmentsEntryModelImpl
.- Parameters:
start
- the lower bound of the range of segments entriesend
- the upper bound of the range of segments entries (not inclusive)- Returns:
- the range of segments entries
-
getSegmentsEntries
public static List<SegmentsEntry> getSegmentsEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) -
getSegmentsEntries
public static List<SegmentsEntry> getSegmentsEntries(long groupId, String source, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) -
getSegmentsEntriesBySource
public static List<SegmentsEntry> getSegmentsEntriesBySource(String source, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) -
getSegmentsEntriesByUuidAndCompanyId
Returns all the segments entries matching the UUID and company.- Parameters:
uuid
- the UUID of the segments entriescompanyId
- the primary key of the company- Returns:
- the matching segments entries, or an empty list if no matches were found
-
getSegmentsEntriesByUuidAndCompanyId
public static List<SegmentsEntry> getSegmentsEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SegmentsEntry> orderByComparator) Returns a range of segments entries matching the UUID and company.- Parameters:
uuid
- the UUID of the segments entriescompanyId
- the primary key of the companystart
- the lower bound of the range of segments entriesend
- the upper bound of the range of segments entries (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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) -
getSegmentsEntry
public static SegmentsEntry getSegmentsEntry(long segmentsEntryId) throws com.liferay.portal.kernel.exception.PortalException Returns the segments entry with the primary key.- Parameters:
segmentsEntryId
- the primary key of the segments entry- Returns:
- the segments entry
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a segments entry with the primary key could not be found
-
getSegmentsEntryByUuidAndGroupId
public static SegmentsEntry getSegmentsEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the segments entry matching the UUID and group.- Parameters:
uuid
- the segments entry's UUIDgroupId
- the primary key of the group- Returns:
- the matching segments entry
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching segments entry could not be found
-
searchSegmentsEntries
public static com.liferay.portal.kernel.search.BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(long companyId, long groupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchSegmentsEntries
public static com.liferay.portal.kernel.search.BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(com.liferay.portal.kernel.search.SearchContext searchContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSegmentsEntry
public static SegmentsEntry updateSegmentsEntry(long segmentsEntryId, String segmentsEntryKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, boolean active, String criteria, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSegmentsEntry
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
-