com.liferay.segments.service

Interface SegmentsEntryLocalService

All Superinterfaces:

BaseLocalService, CTService<SegmentsEntry>, PersistedModelLocalService

All Known Implementing Classes:

SegmentsEntryLocalServiceWrapper

@CTAware
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SegmentsEntryLocalService
extends BaseLocalService, CTService<SegmentsEntry>, PersistedModelLocalService

Provides the local service interface for SegmentsEntry. 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:

SegmentsEntryLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SegmentsEntry	addSegmentsEntry(SegmentsEntry segmentsEntry) Adds the segments entry to the database.
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)
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)
void	addSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs, ServiceContext serviceContext)
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
SegmentsEntry	createSegmentsEntry(long segmentsEntryId) Creates a new segments entry with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteSegmentsEntries(long groupId)
void	deleteSegmentsEntries(java.lang.String source)
SegmentsEntry	deleteSegmentsEntry(long segmentsEntryId) Deletes the segments entry with the primary key from the database.
SegmentsEntry	deleteSegmentsEntry(SegmentsEntry segmentsEntry) Deletes the segments entry from the database.
void	deleteSegmentsEntryClassPKs(long segmentsEntryId, long[] classPKs)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
SegmentsEntry	fetchSegmentsEntry(long segmentsEntryId)
SegmentsEntry	fetchSegmentsEntry(long groupId, java.lang.String segmentsEntryKey, boolean includeAncestorSegmentsEntries)
SegmentsEntry	fetchSegmentsEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the segments entry matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
CTPersistence<SegmentsEntry>	getCTPersistence()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.Class<SegmentsEntry>	getModelClass()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<SegmentsEntry>	getSegmentsEntries(int start, int end) Returns a range of all the segments entries.
java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean includeAncestorSegmentsEntries, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean active, java.lang.String type, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
java.util.List<SegmentsEntry>	getSegmentsEntries(long groupId, boolean active, java.lang.String source, java.lang.String type, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
java.util.List<SegmentsEntry>	getSegmentsEntriesBySource(java.lang.String source, int start, int end, OrderByComparator<SegmentsEntry> orderByComparator)
java.util.List<SegmentsEntry>	getSegmentsEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the segments entries matching the UUID and company.
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.
int	getSegmentsEntriesCount() Returns the number of segments entries.
int	getSegmentsEntriesCount(long groupId, boolean includeAncestorSegmentsEntries)
SegmentsEntry	getSegmentsEntry(long segmentsEntryId) Returns the segments entry with the primary key.
SegmentsEntry	getSegmentsEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the segments entry matching the UUID and group.
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)
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)
BaseModelSearchResult<SegmentsEntry>	searchSegmentsEntries(SearchContext searchContext)
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)
SegmentsEntry	updateSegmentsEntry(SegmentsEntry segmentsEntry) Updates the segments entry in the database or adds it if it does not yet exist.
<R,E extends java.lang.Throwable> R	updateWithUnsafeFunction(UnsafeFunction<CTPersistence<SegmentsEntry>,R,E> updateUnsafeFunction)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addSegmentsEntry

@Indexable(type=REINDEX)
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

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

@Indexable(type=REINDEX)
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

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

Throws:

PortalException

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

createSegmentsEntry

@Transactional(enabled=false)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSegmentsEntries

void deleteSegmentsEntries(long groupId)
                    throws PortalException

Throws:

PortalException

deleteSegmentsEntries

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

Throws:

PortalException

deleteSegmentsEntry

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
 @SystemEvent(type=1)
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

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

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SegmentsEntry fetchSegmentsEntry(long segmentsEntryId)

fetchSegmentsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SegmentsEntry fetchSegmentsEntry(long groupId,
                                                                                                    java.lang.String segmentsEntryKey,
                                                                                                    boolean includeAncestorSegmentsEntries)

fetchSegmentsEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSegmentsEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SegmentsEntry> getSegmentsEntries(long groupId,
                                                                                                                    boolean includeAncestorSegmentsEntries,
                                                                                                                    int start,
                                                                                                                    int end,
                                                                                                                    OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SegmentsEntry> getSegmentsEntries(long groupId,
                                                                                                                    boolean active,
                                                                                                                    java.lang.String type,
                                                                                                                    int start,
                                                                                                                    int end,
                                                                                                                    OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SegmentsEntry> getSegmentsEntriesBySource(java.lang.String source,
                                                                                                                            int start,
                                                                                                                            int end,
                                                                                                                            OrderByComparator<SegmentsEntry> orderByComparator)

getSegmentsEntriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSegmentsEntriesCount()

Returns the number of segments entries.

Returns:

the number of segments entries

getSegmentsEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSegmentsEntriesCount(long groupId,
                                                                                               boolean includeAncestorSegmentsEntries)

getSegmentsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<SegmentsEntry> searchSegmentsEntries(SearchContext searchContext)
                                                                                                                       throws PortalException

Throws:

PortalException

updateSegmentsEntry

@Indexable(type=REINDEX)
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

@Indexable(type=REINDEX)
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

getCTPersistence

@Transactional(enabled=false)
CTPersistence<SegmentsEntry> getCTPersistence()

Specified by:

getCTPersistence in interface CTService<SegmentsEntry>

getModelClass

@Transactional(enabled=false)
java.lang.Class<SegmentsEntry> getModelClass()

Specified by:

getModelClass in interface CTService<SegmentsEntry>

updateWithUnsafeFunction

@Transactional(rollbackFor=java.lang.Throwable.class)
<R,E extends java.lang.Throwable> R updateWithUnsafeFunction(UnsafeFunction<CTPersistence<SegmentsEntry>,R,E> updateUnsafeFunction)
                                                                                                            throws E extends java.lang.Throwable

Specified by:

updateWithUnsafeFunction in interface CTService<SegmentsEntry>

Throws:

E extends java.lang.Throwable