com.liferay.content.targeting.service

Interface RuleInstanceLocalService

All Superinterfaces:

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

All Known Implementing Classes:

RuleInstanceLocalServiceWrapper

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

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

RuleInstanceLocalServiceUtil, com.liferay.content.targeting.service.base.RuleInstanceLocalServiceBaseImpl, com.liferay.content.targeting.service.impl.RuleInstanceLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
RuleInstance	addRuleInstance(long userId, java.lang.String ruleKey, long userSegmentId, int displayOrder, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
RuleInstance	addRuleInstance(long userId, java.lang.String ruleKey, long userSegmentId, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
RuleInstance	addRuleInstance(RuleInstance ruleInstance) Adds the rule instance to the database.
RuleInstance	createRuleInstance(long ruleInstanceId) Creates a new rule instance with the primary key.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
RuleInstance	deleteRuleInstance(long ruleInstanceId) Deletes the rule instance with the primary key from the database.
RuleInstance	deleteRuleInstance(RuleInstance ruleInstance) Deletes the rule instance from the database.
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.
RuleInstance	fetchRuleInstance(long ruleInstanceId)
RuleInstance	fetchRuleInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the rule instance matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
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)
RuleInstance	getRuleInstance(long ruleInstanceId) Returns the rule instance with the primary key.
RuleInstance	getRuleInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the rule instance matching the UUID and group.
java.util.List<RuleInstance>	getRuleInstances(int start, int end) Returns a range of all the rule instances.
java.util.List<RuleInstance>	getRuleInstances(long userSegmentId)
java.util.List<RuleInstance>	getRuleInstances(java.lang.String ruleKey, long userSegmentId)
java.util.List<RuleInstance>	getRuleInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the rule instances matching the UUID and company.
java.util.List<RuleInstance>	getRuleInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<RuleInstance> orderByComparator) Returns a range of rule instances matching the UUID and company.
int	getRuleInstancesCount() Returns the number of rule instances.
long	getRuleInstancesCount(long userSegmentId)
long	getRuleInstancesCount(java.lang.String ruleKey, long userSegmentId)
RuleInstance	updateRuleInstance(long ruleInstanceId, int displayOrder, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
RuleInstance	updateRuleInstance(long ruleInstanceId, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
RuleInstance	updateRuleInstance(RuleInstance ruleInstance) Updates the rule instance in the database or adds it if it does not yet exist.

Method Detail

addRuleInstance

RuleInstance addRuleInstance(long userId,
                             java.lang.String ruleKey,
                             long userSegmentId,
                             int displayOrder,
                             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

addRuleInstance

RuleInstance addRuleInstance(long userId,
                             java.lang.String ruleKey,
                             long userSegmentId,
                             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

addRuleInstance

@Indexable(type=REINDEX)
RuleInstance addRuleInstance(RuleInstance ruleInstance)

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

Parameters:

ruleInstance - the rule instance

Returns:

the rule instance that was added

createRuleInstance

@Transactional(enabled=false)
RuleInstance createRuleInstance(long ruleInstanceId)

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

Parameters:

ruleInstanceId - the primary key for the new rule instance

Returns:

the new rule instance

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

deleteRuleInstance

@Indexable(type=DELETE)
RuleInstance deleteRuleInstance(long ruleInstanceId)
                                                 throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

ruleInstanceId - the primary key of the rule instance

Returns:

the rule instance that was removed

Throws:

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

deleteRuleInstance

@Indexable(type=DELETE)
RuleInstance deleteRuleInstance(RuleInstance ruleInstance)
                                                 throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

ruleInstance - the rule instance

Returns:

the rule instance that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery 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.

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.RuleInstanceModelImpl. 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.RuleInstanceModelImpl. 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

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

fetchRuleInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RuleInstance fetchRuleInstance(long ruleInstanceId)

fetchRuleInstanceByUuidAndGroupId

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

Returns the rule instance matching the UUID and group.

Parameters:

uuid - the rule instance's UUID

groupId - the primary key of the group

Returns:

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

getActionableDynamicQuery

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

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

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

getRuleInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RuleInstance getRuleInstance(long ruleInstanceId)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the rule instance with the primary key.

Parameters:

ruleInstanceId - the primary key of the rule instance

Returns:

the rule instance

Throws:

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

getRuleInstanceByUuidAndGroupId

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

Returns the rule instance matching the UUID and group.

Parameters:

uuid - the rule instance's UUID

groupId - the primary key of the group

Returns:

the matching rule instance

Throws:

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

getRuleInstances

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

Returns a range of all the rule 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.RuleInstanceModelImpl. 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 rule instances

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

Returns:

the range of rule instances

getRuleInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<RuleInstance> getRuleInstances(long userSegmentId)

getRuleInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<RuleInstance> getRuleInstances(java.lang.String ruleKey,
                                                                                                                 long userSegmentId)

getRuleInstancesByUuidAndCompanyId

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

Returns all the rule instances matching the UUID and company.

Parameters:

uuid - the UUID of the rule instances

companyId - the primary key of the company

Returns:

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

getRuleInstancesByUuidAndCompanyId

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

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

Parameters:

uuid - the UUID of the rule instances

companyId - the primary key of the company

start - the lower bound of the range of rule instances

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

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

Returns:

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

getRuleInstancesCount

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

Returns the number of rule instances.

Returns:

the number of rule instances

getRuleInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getRuleInstancesCount(long userSegmentId)

getRuleInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getRuleInstancesCount(java.lang.String ruleKey,
                                                                                              long userSegmentId)

updateRuleInstance

RuleInstance updateRuleInstance(long ruleInstanceId,
                                int displayOrder,
                                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

updateRuleInstance

RuleInstance updateRuleInstance(long ruleInstanceId,
                                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

updateRuleInstance

@Indexable(type=REINDEX)
RuleInstance updateRuleInstance(RuleInstance ruleInstance)

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

Parameters:

ruleInstance - the rule instance

Returns:

the rule instance that was updated