com.liferay.segments.service.SegmentsExperimentRelLocalService Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.segments.service;
import com.liferay.petra.function.UnsafeFunction;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.change.tracking.CTAware;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.service.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.segments.model.SegmentsExperimentRel;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SegmentsExperimentRel. 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.
*
* @author Eduardo Garcia
* @see SegmentsExperimentRelLocalServiceUtil
* @generated
*/
@CTAware
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SegmentsExperimentRelLocalService
extends BaseLocalService, CTService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.segments.service.impl.SegmentsExperimentRelLocalServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the segments experiment rel local service via injection or a org.osgi.util.tracker.ServiceTracker
. Use {@link SegmentsExperimentRelLocalServiceUtil} if injection and service tracking are not available.
*/
public SegmentsExperimentRel addSegmentsExperimentRel(
long segmentsExperimentId, long segmentsExperienceId,
ServiceContext serviceContext)
throws PortalException;
/**
* Adds the segments experiment rel to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SegmentsExperimentRelLocalServiceImpl 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.
*
*
* @param segmentsExperimentRel the segments experiment rel
* @return the segments experiment rel that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SegmentsExperimentRel addSegmentsExperimentRel(
SegmentsExperimentRel segmentsExperimentRel);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new segments experiment rel with the primary key. Does not add the segments experiment rel to the database.
*
* @param segmentsExperimentRelId the primary key for the new segments experiment rel
* @return the new segments experiment rel
*/
@Transactional(enabled = false)
public SegmentsExperimentRel createSegmentsExperimentRel(
long segmentsExperimentRelId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the segments experiment rel with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SegmentsExperimentRelLocalServiceImpl 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.
*
*
* @param segmentsExperimentRelId the primary key of the segments experiment rel
* @return the segments experiment rel that was removed
* @throws PortalException if a segments experiment rel with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SegmentsExperimentRel deleteSegmentsExperimentRel(
long segmentsExperimentRelId)
throws PortalException;
/**
* Deletes the segments experiment rel from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SegmentsExperimentRelLocalServiceImpl 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.
*
*
* @param segmentsExperimentRel the segments experiment rel
* @return the segments experiment rel that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public SegmentsExperimentRel deleteSegmentsExperimentRel(
SegmentsExperimentRel segmentsExperimentRel)
throws PortalException;
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public SegmentsExperimentRel deleteSegmentsExperimentRel(
SegmentsExperimentRel segmentsExperimentRel, boolean force)
throws PortalException;
public void deleteSegmentsExperimentRels(long segmentsExperimentId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* 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.SegmentsExperimentRelModelImpl
.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* 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.SegmentsExperimentRelModelImpl
.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null
)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SegmentsExperimentRel fetchSegmentsExperimentRel(
long segmentsExperimentRelId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SegmentsExperimentRel fetchSegmentsExperimentRel(
long segmentsExperimentId, long segmentsExperienceId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Returns the segments experiment rel with the primary key.
*
* @param segmentsExperimentRelId the primary key of the segments experiment rel
* @return the segments experiment rel
* @throws PortalException if a segments experiment rel with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SegmentsExperimentRel getSegmentsExperimentRel(
long segmentsExperimentRelId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SegmentsExperimentRel getSegmentsExperimentRel(
long segmentsExperimentId, long segmentsExperienceId)
throws PortalException;
/**
* Returns a range of all the segments experiment rels.
*
*
* 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.SegmentsExperimentRelModelImpl
.
*
*
* @param start the lower bound of the range of segments experiment rels
* @param end the upper bound of the range of segments experiment rels (not inclusive)
* @return the range of segments experiment rels
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSegmentsExperimentRels(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSegmentsExperimentRels(
long segmentsExperimentId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getSegmentsExperimentRelsBySegmentsExperienceId(
long segmentsExperienceId);
/**
* Returns the number of segments experiment rels.
*
* @return the number of segments experiment rels
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSegmentsExperimentRelsCount();
public SegmentsExperimentRel updateSegmentsExperimentRel(
long segmentsExperimentRelId, double split)
throws PortalException;
public SegmentsExperimentRel updateSegmentsExperimentRel(
long segmentsExperimentId, long segmentsExperienceId, double split)
throws PortalException;
public SegmentsExperimentRel updateSegmentsExperimentRel(
long segmentsExperimentRelId, String name,
ServiceContext serviceContext)
throws PortalException;
/**
* Updates the segments experiment rel in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SegmentsExperimentRelLocalServiceImpl 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.
*
*
* @param segmentsExperimentRel the segments experiment rel
* @return the segments experiment rel that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SegmentsExperimentRel updateSegmentsExperimentRel(
SegmentsExperimentRel segmentsExperimentRel);
@Override
@Transactional(enabled = false)
public CTPersistence getCTPersistence();
@Override
@Transactional(enabled = false)
public Class getModelClass();
@Override
@Transactional(rollbackFor = Throwable.class)
public R updateWithUnsafeFunction(
UnsafeFunction, R, E>
updateUnsafeFunction)
throws E;
}