com.liferay.social.kernel.service.SocialActivitySettingLocalService Maven / Gradle / Ivy
Show all versions of com.liferay.portal.kernel Show documentation
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.social.kernel.service;
import aQute.bnd.annotation.ProviderType;
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.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;
/**
* 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
* @see com.liferay.portlet.social.service.base.SocialActivitySettingLocalServiceBaseImpl
* @see com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface SocialActivitySettingLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link SocialActivitySettingLocalServiceUtil} to access the social activity setting local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the social activity setting to the database. Also notifies the appropriate model listeners.
*
* @param socialActivitySetting the social activity setting
* @return the social activity setting that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivitySetting addSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
/**
* 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
*/
public SocialActivitySetting createSocialActivitySetting(
long activitySettingId);
public void deleteActivitySetting(long groupId, java.lang.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.
*
* @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.
*
* @param socialActivitySetting the social activity setting
* @return the social activity setting that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SocialActivitySetting deleteSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
*
*
* @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
*/
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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
*
*
* @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
*/
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
*/
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
*/
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,
java.lang.String className, int activityType);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getActivityDefinitions(long groupId,
java.lang.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 java.lang.String getOSGiServiceIdentifier();
@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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySettingModelImpl}. 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.
*
*
* @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, java.lang.String className,
int activityType,
SocialActivityCounterDefinition activityCounterDefinition)
throws PortalException;
public void updateActivitySetting(long groupId, java.lang.String className,
long classPK, boolean enabled) throws PortalException;
public void updateActivitySetting(long groupId, java.lang.String className,
boolean enabled) throws PortalException;
public void updateActivitySettings(long groupId,
java.lang.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.
*
* @param socialActivitySetting the social activity setting
* @return the social activity setting that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivitySetting updateSocialActivitySetting(
SocialActivitySetting socialActivitySetting);
}