com.liferay.social.kernel.service.SocialActivitySettingLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation
Show all versions of com.liferay.portal.kernel Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* 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.social.kernel.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.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.change.tracking.CTService;
import com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence;
import com.liferay.portal.kernel.spring.osgi.OSGiBeanProperties;
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.social.kernel.model.SocialActivityCounterDefinition;
import com.liferay.social.kernel.model.SocialActivityDefinition;
import com.liferay.social.kernel.model.SocialActivitySetting;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SocialActivitySetting. 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 Brian Wing Shun Chan
* @see SocialActivitySettingLocalServiceUtil
* @generated
*/
@CTAware
@OSGiBeanProperties(
property = {
"model.class.name=com.liferay.social.kernel.model.SocialActivitySetting"
}
)
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SocialActivitySettingLocalService
extends BaseLocalService, CTService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the social activity setting local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link SocialActivitySettingLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the social activity setting to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SocialActivitySettingLocalServiceImpl 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 socialActivitySetting the social activity setting
* @return the social activity setting that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivitySetting addSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new social activity setting with the primary key. Does not add the social activity setting to the database.
*
* @param activitySettingId the primary key for the new social activity setting
* @return the new social activity setting
*/
@Transactional(enabled = false)
public SocialActivitySetting createSocialActivitySetting(
long activitySettingId);
public void deleteActivitySetting(
long groupId, String className, long classPK);
public void deleteActivitySettings(long groupId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the social activity setting with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SocialActivitySettingLocalServiceImpl 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 activitySettingId the primary key of the social activity setting
* @return the social activity setting that was removed
* @throws PortalException if a social activity setting with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SocialActivitySetting deleteSocialActivitySetting(
long activitySettingId)
throws PortalException;
/**
* Deletes the social activity setting from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SocialActivitySettingLocalServiceImpl 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 socialActivitySetting the social activity setting
* @return the social activity setting that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SocialActivitySetting deleteSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
@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.portlet.social.model.impl.SocialActivitySettingModelImpl.
*
*
* @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.portlet.social.model.impl.SocialActivitySettingModelImpl.
*
*
* @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 SocialActivitySetting fetchSocialActivitySetting(
long activitySettingId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SocialActivityDefinition getActivityDefinition(
long groupId, String className, int activityType);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getActivityDefinitions(
long groupId, String className);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getActivitySettings(long groupId);
@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 social activity setting with the primary key.
*
* @param activitySettingId the primary key of the social activity setting
* @return the social activity setting
* @throws PortalException if a social activity setting with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SocialActivitySetting getSocialActivitySetting(
long activitySettingId)
throws PortalException;
/**
* Returns a range of all the social activity settings.
*
*
* 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.portlet.social.model.impl.SocialActivitySettingModelImpl.
*
*
* @param start the lower bound of the range of social activity settings
* @param end the upper bound of the range of social activity settings (not inclusive)
* @return the range of social activity settings
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSocialActivitySettings(
int start, int end);
/**
* Returns the number of social activity settings.
*
* @return the number of social activity settings
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSocialActivitySettingsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean isEnabled(long groupId, long classNameId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean isEnabled(long groupId, long classNameId, long classPK);
public void updateActivitySetting(
long groupId, String className, boolean enabled)
throws PortalException;
public void updateActivitySetting(
long groupId, String className, int activityType,
SocialActivityCounterDefinition activityCounterDefinition)
throws PortalException;
public void updateActivitySetting(
long groupId, String className, long classPK, boolean enabled)
throws PortalException;
public void updateActivitySettings(
long groupId, String className, int activityType,
List activityCounterDefinitions)
throws PortalException;
/**
* Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SocialActivitySettingLocalServiceImpl 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 socialActivitySetting the social activity setting
* @return the social activity setting that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivitySetting updateSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
@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;
}