com.liferay.social.kernel.service.SocialActivityAchievementLocalService Maven / Gradle / Ivy
/**
* 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.SocialAchievement;
import com.liferay.social.kernel.model.SocialActivityAchievement;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for SocialActivityAchievement. 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 SocialActivityAchievementLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SocialActivityAchievementLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link SocialActivityAchievementLocalServiceUtil} to access the social activity achievement local service. Add custom service methods to com.liferay.portlet.social.service.impl.SocialActivityAchievementLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public void addActivityAchievement(
long userId, long groupId, SocialAchievement achievement)
throws PortalException;
/**
* Adds the social activity achievement to the database. Also notifies the appropriate model listeners.
*
* @param socialActivityAchievement the social activity achievement
* @return the social activity achievement that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivityAchievement addSocialActivityAchievement(
SocialActivityAchievement socialActivityAchievement);
/**
* Creates a new social activity achievement with the primary key. Does not add the social activity achievement to the database.
*
* @param activityAchievementId the primary key for the new social activity achievement
* @return the new social activity achievement
*/
@Transactional(enabled = false)
public SocialActivityAchievement createSocialActivityAchievement(
long activityAchievementId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the social activity achievement with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param activityAchievementId the primary key of the social activity achievement
* @return the social activity achievement that was removed
* @throws PortalException if a social activity achievement with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SocialActivityAchievement deleteSocialActivityAchievement(
long activityAchievementId)
throws PortalException;
/**
* Deletes the social activity achievement from the database. Also notifies the appropriate model listeners.
*
* @param socialActivityAchievement the social activity achievement
* @return the social activity achievement that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SocialActivityAchievement deleteSocialActivityAchievement(
SocialActivityAchievement socialActivityAchievement);
@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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivityAchievementModelImpl. 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
*/
@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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivityAchievementModelImpl. 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
*/
@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 SocialActivityAchievement fetchSocialActivityAchievement(
long activityAchievementId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SocialActivityAchievement fetchUserAchievement(
long userId, long groupId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupAchievements(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupAchievements(
long groupId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getGroupAchievementsCount(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getGroupAchievementsCount(long groupId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupFirstAchievements(
long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getGroupFirstAchievementsCount(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Returns the social activity achievement with the primary key.
*
* @param activityAchievementId the primary key of the social activity achievement
* @return the social activity achievement
* @throws PortalException if a social activity achievement with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SocialActivityAchievement getSocialActivityAchievement(
long activityAchievementId)
throws PortalException;
/**
* Returns a range of all the social activity achievements.
*
*
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialActivityAchievementModelImpl. 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 achievements
* @param end the upper bound of the range of social activity achievements (not inclusive)
* @return the range of social activity achievements
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSocialActivityAchievements(
int start, int end);
/**
* Returns the number of social activity achievements.
*
* @return the number of social activity achievements
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSocialActivityAchievementsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserAchievements(
long userId, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserAchievementsCount(long userId, long groupId);
/**
* Updates the social activity achievement in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param socialActivityAchievement the social activity achievement
* @return the social activity achievement that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SocialActivityAchievement updateSocialActivityAchievement(
SocialActivityAchievement socialActivityAchievement);
}