com.liferay.analytics.message.storage.service

Interface AnalyticsMessageLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

AnalyticsMessageLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface AnalyticsMessageLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

AnalyticsMessageLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
AnalyticsMessage	addAnalyticsMessage(AnalyticsMessage analyticsMessage) Adds the analytics message to the database.
AnalyticsMessage	addAnalyticsMessage(long companyId, long userId, byte[] body)
AnalyticsMessage	createAnalyticsMessage(long analyticsMessageId) Creates a new analytics message with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
AnalyticsMessage	deleteAnalyticsMessage(AnalyticsMessage analyticsMessage) Deletes the analytics message from the database.
AnalyticsMessage	deleteAnalyticsMessage(long analyticsMessageId) Deletes the analytics message with the primary key from the database.
void	deleteAnalyticsMessages(java.util.List<AnalyticsMessage> analyticsMessages)
void	deleteAnalyticsMessages(long companyId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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.
<T> java.util.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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
AnalyticsMessage	fetchAnalyticsMessage(long analyticsMessageId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
AnalyticsMessage	getAnalyticsMessage(long analyticsMessageId) Returns the analytics message with the primary key.
java.util.List<AnalyticsMessage>	getAnalyticsMessages(int start, int end) Returns a range of all the analytics messages.
java.util.List<AnalyticsMessage>	getAnalyticsMessages(long companyId, int start, int end)
int	getAnalyticsMessagesCount() Returns the number of analytics messages.
AnalyticsMessageBodyBlobModel	getBodyBlobModel(java.io.Serializable primaryKey)
java.util.List<java.lang.Long>	getCompanyIds()
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.io.InputStream	openBodyInputStream(long analyticsMessageId)
AnalyticsMessage	updateAnalyticsMessage(AnalyticsMessage analyticsMessage) Updates the analytics message in the database or adds it if it does not yet exist.

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

getBasePersistence

Method Detail

addAnalyticsMessage

@Indexable(type=REINDEX)
AnalyticsMessage addAnalyticsMessage(AnalyticsMessage analyticsMessage)

Adds the analytics message to the database. Also notifies the appropriate model listeners.

Important: Inspect AnalyticsMessageLocalServiceImpl 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:

analyticsMessage - the analytics message

Returns:

the analytics message that was added

addAnalyticsMessage

AnalyticsMessage addAnalyticsMessage(long companyId,
                                     long userId,
                                     byte[] body)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createAnalyticsMessage

@Transactional(enabled=false)
AnalyticsMessage createAnalyticsMessage(long analyticsMessageId)

Creates a new analytics message with the primary key. Does not add the analytics message to the database.

Parameters:

analyticsMessageId - the primary key for the new analytics message

Returns:

the new analytics message

createPersistedModel

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteAnalyticsMessage

@Indexable(type=DELETE)
AnalyticsMessage deleteAnalyticsMessage(AnalyticsMessage analyticsMessage)

Deletes the analytics message from the database. Also notifies the appropriate model listeners.

Important: Inspect AnalyticsMessageLocalServiceImpl 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:

analyticsMessage - the analytics message

Returns:

the analytics message that was removed

deleteAnalyticsMessage

@Indexable(type=DELETE)
AnalyticsMessage deleteAnalyticsMessage(long analyticsMessageId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Deletes the analytics message with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect AnalyticsMessageLocalServiceImpl 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:

analyticsMessageId - the primary key of the analytics message

Returns:

the analytics message that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a analytics message with the primary key could not be found

deleteAnalyticsMessages

void deleteAnalyticsMessages(java.util.List<AnalyticsMessage> analyticsMessages)

deleteAnalyticsMessages

void deleteAnalyticsMessages(long companyId)

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(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 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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

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(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 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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

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(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

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

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchAnalyticsMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnalyticsMessage fetchAnalyticsMessage(long analyticsMessageId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getAnalyticsMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnalyticsMessage getAnalyticsMessage(long analyticsMessageId)
                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the analytics message with the primary key.

Parameters:

analyticsMessageId - the primary key of the analytics message

Returns:

the analytics message

Throws:

com.liferay.portal.kernel.exception.PortalException - if a analytics message with the primary key could not be found

getAnalyticsMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<AnalyticsMessage> getAnalyticsMessages(int start,
                                                                                                                         int end)

Returns a range of all the analytics messages.

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.analytics.message.storage.model.impl.AnalyticsMessageModelImpl.

Parameters:

start - the lower bound of the range of analytics messages

end - the upper bound of the range of analytics messages (not inclusive)

Returns:

the range of analytics messages

getAnalyticsMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<AnalyticsMessage> getAnalyticsMessages(long companyId,
                                                                                                                         int start,
                                                                                                                         int end)

getAnalyticsMessagesCount

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

Returns the number of analytics messages.

Returns:

the number of analytics messages

getBodyBlobModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnalyticsMessageBodyBlobModel getBodyBlobModel(java.io.Serializable primaryKey)

getCompanyIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getCompanyIds()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

openBodyInputStream

@Transactional(readOnly=true)
java.io.InputStream openBodyInputStream(long analyticsMessageId)

updateAnalyticsMessage

@Indexable(type=REINDEX)
AnalyticsMessage updateAnalyticsMessage(AnalyticsMessage analyticsMessage)

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

Important: Inspect AnalyticsMessageLocalServiceImpl 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:

analyticsMessage - the analytics message

Returns:

the analytics message that was updated