com.liferay.announcements.kernel.service.AnnouncementsFlagLocalService 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.announcements.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.announcements.kernel.model.AnnouncementsFlag;
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 java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for AnnouncementsFlag. 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 AnnouncementsFlagLocalServiceUtil
* @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl
* @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface AnnouncementsFlagLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link AnnouncementsFlagLocalServiceUtil} to access the announcements flag local service. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the announcements flag to the database. Also notifies the appropriate model listeners.
*
* @param announcementsFlag the announcements flag
* @return the announcements flag that was added
*/
@Indexable(type = IndexableType.REINDEX)
public AnnouncementsFlag addAnnouncementsFlag(
AnnouncementsFlag announcementsFlag);
public AnnouncementsFlag addFlag(long userId, long entryId, int value);
/**
* Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.
*
* @param flagId the primary key for the new announcements flag
* @return the new announcements flag
*/
public AnnouncementsFlag createAnnouncementsFlag(long flagId);
/**
* Deletes the announcements flag from the database. Also notifies the appropriate model listeners.
*
* @param announcementsFlag the announcements flag
* @return the announcements flag that was removed
*/
@Indexable(type = IndexableType.DELETE)
public AnnouncementsFlag deleteAnnouncementsFlag(
AnnouncementsFlag announcementsFlag);
/**
* Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param flagId the primary key of the announcements flag
* @return the announcements flag that was removed
* @throws PortalException if a announcements flag with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public AnnouncementsFlag deleteAnnouncementsFlag(long flagId)
throws PortalException;
public void deleteFlag(AnnouncementsFlag flag);
public void deleteFlag(long flagId) throws PortalException;
public void deleteFlags(long entryId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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 AnnouncementsFlag fetchAnnouncementsFlag(long flagId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the announcements flag with the primary key.
*
* @param flagId the primary key of the announcements flag
* @return the announcements flag
* @throws PortalException if a announcements flag with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public AnnouncementsFlag getAnnouncementsFlag(long flagId)
throws PortalException;
/**
* Returns a range of all the announcements flags.
*
*
* 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.announcements.model.impl.AnnouncementsFlagModelImpl}. 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 announcements flags
* @param end the upper bound of the range of announcements flags (not inclusive)
* @return the range of announcements flags
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getAnnouncementsFlags(int start, int end);
/**
* Returns the number of announcements flags.
*
* @return the number of announcements flags
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getAnnouncementsFlagsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public AnnouncementsFlag getFlag(long userId, long entryId, int value)
throws PortalException;
@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;
/**
* Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param announcementsFlag the announcements flag
* @return the announcements flag that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public AnnouncementsFlag updateAnnouncementsFlag(
AnnouncementsFlag announcementsFlag);
}