com.liferay.content.targeting.service

Interface ChannelInstanceLocalService

All Superinterfaces:

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

All Known Implementing Classes:

ChannelInstanceLocalServiceWrapper

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

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

ChannelInstanceLocalServiceUtil, com.liferay.content.targeting.service.base.ChannelInstanceLocalServiceBaseImpl, com.liferay.content.targeting.service.impl.ChannelInstanceLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
ChannelInstance	addChannelInstance(ChannelInstance channelInstance) Adds the channel instance to the database.
ChannelInstance	addChannelInstance(long userId, long tacticId, java.lang.String channelKey, long campaignId, java.lang.String alias, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
ChannelInstance	createChannelInstance(long channelInstanceId) Creates a new channel instance with the primary key.
ChannelInstance	deleteChannelInstance(ChannelInstance channelInstance) Deletes the channel instance from the database.
ChannelInstance	deleteChannelInstance(long channelInstanceId) Deletes the channel instance with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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.
ChannelInstance	fetchChannelInstance(long channelInstanceId)
ChannelInstance	fetchChannelInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the channel instance matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<ChannelInstance>	getCampaignChannelInstances(long campaignId)
java.util.List<ChannelInstance>	getCampaignChannelInstances(long campaignId, java.lang.String channelKey)
ChannelInstance	getChannelInstance(long channelInstanceId) Returns the channel instance with the primary key.
ChannelInstance	getChannelInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the channel instance matching the UUID and group.
java.util.List<ChannelInstance>	getChannelInstances(int start, int end) Returns a range of all the channel instances.
java.util.List<ChannelInstance>	getChannelInstances(long tacticId)
java.util.List<ChannelInstance>	getChannelInstances(long tacticId, java.lang.String channelKey)
java.util.List<ChannelInstance>	getChannelInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the channel instances matching the UUID and company.
java.util.List<ChannelInstance>	getChannelInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ChannelInstance> orderByComparator) Returns a range of channel instances matching the UUID and company.
int	getChannelInstancesCount() Returns the number of channel instances.
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
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)
ChannelInstance	updateChannelInstance(ChannelInstance channelInstance) Updates the channel instance in the database or adds it if it does not yet exist.
ChannelInstance	updateChannelInstance(long channelInstanceId, java.lang.String alias, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Method Detail

addChannelInstance

@Indexable(type=REINDEX)
ChannelInstance addChannelInstance(ChannelInstance channelInstance)

Adds the channel instance to the database. Also notifies the appropriate model listeners.

Parameters:

channelInstance - the channel instance

Returns:

the channel instance that was added

addChannelInstance

ChannelInstance addChannelInstance(long userId,
                                   long tacticId,
                                   java.lang.String channelKey,
                                   long campaignId,
                                   java.lang.String alias,
                                   java.lang.String typeSettings,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createChannelInstance

ChannelInstance createChannelInstance(long channelInstanceId)

Creates a new channel instance with the primary key. Does not add the channel instance to the database.

Parameters:

channelInstanceId - the primary key for the new channel instance

Returns:

the new channel instance

deleteChannelInstance

@Indexable(type=DELETE)
ChannelInstance deleteChannelInstance(ChannelInstance channelInstance)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the channel instance from the database. Also notifies the appropriate model listeners.

Parameters:

channelInstance - the channel instance

Returns:

the channel instance that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteChannelInstance

@Indexable(type=DELETE)
ChannelInstance deleteChannelInstance(long channelInstanceId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the channel instance with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

channelInstanceId - the primary key of the channel instance

Returns:

the channel instance that was removed

Throws:

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

fetchChannelInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ChannelInstance fetchChannelInstance(long channelInstanceId)

fetchChannelInstanceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ChannelInstance fetchChannelInstanceByUuidAndGroupId(java.lang.String uuid,
                                                                                                                        long groupId)

Returns the channel instance matching the UUID and group.

Parameters:

uuid - the channel instance's UUID

groupId - the primary key of the group

Returns:

the matching channel instance, or null if a matching channel instance could not be found

getChannelInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ChannelInstance getChannelInstance(long channelInstanceId)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the channel instance with the primary key.

Parameters:

channelInstanceId - the primary key of the channel instance

Returns:

the channel instance

Throws:

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

getChannelInstanceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ChannelInstance getChannelInstanceByUuidAndGroupId(java.lang.String uuid,
                                                                                                                      long groupId)
                                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the channel instance matching the UUID and group.

Parameters:

uuid - the channel instance's UUID

groupId - the primary key of the group

Returns:

the matching channel instance

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching channel instance could not be found

updateChannelInstance

@Indexable(type=REINDEX)
ChannelInstance updateChannelInstance(ChannelInstance channelInstance)

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

Parameters:

channelInstance - the channel instance

Returns:

the channel instance that was updated

updateChannelInstance

ChannelInstance updateChannelInstance(long channelInstanceId,
                                      java.lang.String alias,
                                      java.lang.String typeSettings,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getActionableDynamicQuery

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

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

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

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

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

getChannelInstancesCount

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

Returns the number of channel instances.

Returns:

the number of channel instances

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ChannelInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

<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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ChannelInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getCampaignChannelInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getCampaignChannelInstances(long campaignId)
                                                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCampaignChannelInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getCampaignChannelInstances(long campaignId,
                                                                                                                               java.lang.String channelKey)
                                                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getChannelInstances

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

Returns a range of all the channel instances.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ChannelInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of channel instances

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

Returns:

the range of channel instances

getChannelInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getChannelInstances(long tacticId)
                                                                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getChannelInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getChannelInstances(long tacticId,
                                                                                                                       java.lang.String channelKey)
                                                                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getChannelInstancesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getChannelInstancesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                         long companyId)

Returns all the channel instances matching the UUID and company.

Parameters:

uuid - the UUID of the channel instances

companyId - the primary key of the company

Returns:

the matching channel instances, or an empty list if no matches were found

getChannelInstancesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ChannelInstance> getChannelInstancesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                         long companyId,
                                                                                                                                         int start,
                                                                                                                                         int end,
                                                                                                                                         com.liferay.portal.kernel.util.OrderByComparator<ChannelInstance> orderByComparator)

Returns a range of channel instances matching the UUID and company.

Parameters:

uuid - the UUID of the channel instances

companyId - the primary key of the company

start - the lower bound of the range of channel instances

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

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

Returns:

the range of matching channel instances, or an empty list if no matches were found

dynamicQueryCount

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

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