/** * 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.blogs.service; import aQute.bnd.annotation.ProviderType; import com.liferay.blogs.model.BlogsEntry; import com.liferay.exportimport.kernel.lar.PortletDataContext; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Projection; import com.liferay.portal.kernel.dao.orm.QueryDefinition; 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.repository.model.Folder; 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.permission.ModelPermissions; import com.liferay.portal.kernel.servlet.taglib.ui.ImageSelector; 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 java.io.InputStream; import java.io.Serializable; import java.util.Date; import java.util.List; import java.util.Map; /** * Provides the local service interface for BlogsEntry. 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 BlogsEntryLocalServiceUtil * @see com.liferay.blogs.service.base.BlogsEntryLocalServiceBaseImpl * @see com.liferay.blogs.service.impl.BlogsEntryLocalServiceImpl * @generated */ @ProviderType @Transactional(isolation = Isolation.PORTAL, rollbackFor = { PortalException.class, SystemException.class}) public interface BlogsEntryLocalService extends BaseLocalService, PersistedModelLocalService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this interface directly. Always use {@link BlogsEntryLocalServiceUtil} to access the blogs entry local service. Add custom service methods to {@link com.liferay.blogs.service.impl.BlogsEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. */ /** * Adds the blogs entry to the database. Also notifies the appropriate model listeners. * * @param blogsEntry the blogs entry * @return the blogs entry that was added */ @Indexable(type = IndexableType.REINDEX) public BlogsEntry addBlogsEntry(BlogsEntry blogsEntry); public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String content, ServiceContext serviceContext) throws PortalException; public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String content, Date displayDate, ServiceContext serviceContext) throws PortalException; /** * @deprecated As of 1.1.0, replaced by {@link #addEntry(long, String, String, String, String, int, int, int, int, int, boolean, boolean, String[], String, ImageSelector, ImageSelector, ServiceContext)} */ @java.lang.Deprecated public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, boolean smallImage, java.lang.String smallImageURL, java.lang.String smallImageFileName, InputStream smallImageInputStream, ServiceContext serviceContext) throws PortalException; public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String subtitle, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; @Indexable(type = IndexableType.REINDEX) public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String subtitle, java.lang.String description, java.lang.String content, Date displayDate, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String subtitle, java.lang.String urlTitle, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; @Indexable(type = IndexableType.REINDEX) public BlogsEntry addEntry(long userId, java.lang.String title, java.lang.String subtitle, java.lang.String urlTitle, java.lang.String description, java.lang.String content, Date displayDate, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; /** * Creates a new blogs entry with the primary key. Does not add the blogs entry to the database. * * @param entryId the primary key for the new blogs entry * @return the new blogs entry */ public BlogsEntry createBlogsEntry(long entryId); /** * Deletes the blogs entry from the database. Also notifies the appropriate model listeners. * * @param blogsEntry the blogs entry * @return the blogs entry that was removed */ @Indexable(type = IndexableType.DELETE) public BlogsEntry deleteBlogsEntry(BlogsEntry blogsEntry); /** * Deletes the blogs entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param entryId the primary key of the blogs entry * @return the blogs entry that was removed * @throws PortalException if a blogs entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) public BlogsEntry deleteBlogsEntry(long entryId) throws PortalException; @Indexable(type = IndexableType.DELETE) @SystemEvent(type = SystemEventConstants.TYPE_DELETE) public BlogsEntry deleteEntry(BlogsEntry entry) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry fetchBlogsEntry(long entryId); /** * Returns the blogs entry matching the UUID and group. * * @param uuid the blogs entry's UUID * @param groupId the primary key of the group * @return the matching blogs entry, or <code>null</code> if a matching blogs entry could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry fetchBlogsEntryByUuidAndGroupId(java.lang.String uuid, long groupId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry fetchEntry(long groupId, java.lang.String urlTitle); /** * Returns the blogs entry with the primary key. * * @param entryId the primary key of the blogs entry * @return the blogs entry * @throws PortalException if a blogs entry with the primary key could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry getBlogsEntry(long entryId) throws PortalException; /** * Returns the blogs entry matching the UUID and group. * * @param uuid the blogs entry's UUID * @param groupId the primary key of the group * @return the matching blogs entry * @throws PortalException if a matching blogs entry could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry getBlogsEntryByUuidAndGroupId(java.lang.String uuid, long groupId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry getEntry(long entryId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry getEntry(long groupId, java.lang.String urlTitle) throws PortalException; /** * Moves the blogs entry to the recycle bin. Social activity counters for * this entry get disabled. * * @param userId the primary key of the user moving the blogs entry * @param entry the blogs entry to be moved * @return the moved blogs entry */ @Indexable(type = IndexableType.REINDEX) public BlogsEntry moveEntryToTrash(long userId, BlogsEntry entry) throws PortalException; /** * Moves the blogs entry with the ID to the recycle bin. * * @param userId the primary key of the user moving the blogs entry * @param entryId the primary key of the blogs entry to be moved * @return the moved blogs entry */ public BlogsEntry moveEntryToTrash(long userId, long entryId) throws PortalException; /** * Restores the blogs entry with the ID from the recycle bin. Social * activity counters for this entry get activated. * * @param userId the primary key of the user restoring the blogs entry * @param entryId the primary key of the blogs entry to be restored * @return the restored blogs entry from the recycle bin */ @Indexable(type = IndexableType.REINDEX) public BlogsEntry restoreEntryFromTrash(long userId, long entryId) throws PortalException; /** * Updates the blogs entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param blogsEntry the blogs entry * @return the blogs entry that was updated */ @Indexable(type = IndexableType.REINDEX) public BlogsEntry updateBlogsEntry(BlogsEntry blogsEntry); public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String content, ServiceContext serviceContext) throws PortalException; /** * @deprecated As of 1.1.0, replaced by {@link #updateEntry(long, long, String, String, String, String, int, int, int, int, int, boolean, boolean, String[], String, ImageSelector, ImageSelector, ServiceContext)} */ @java.lang.Deprecated public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, boolean smallImage, java.lang.String smallImageURL, java.lang.String smallImageFileName, InputStream smallImageInputStream, ServiceContext serviceContext) throws PortalException; public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String subtitle, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; @Indexable(type = IndexableType.REINDEX) public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String subtitle, java.lang.String description, java.lang.String content, Date displayDate, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String subtitle, java.lang.String urlTitle, java.lang.String description, java.lang.String content, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; @Indexable(type = IndexableType.REINDEX) public BlogsEntry updateEntry(long userId, long entryId, java.lang.String title, java.lang.String subtitle, java.lang.String urlTitle, java.lang.String description, java.lang.String content, Date displayDate, boolean allowPingbacks, boolean allowTrackbacks, java.lang.String[] trackbacks, java.lang.String coverImageCaption, ImageSelector coverImageImageSelector, ImageSelector smallImageImageSelector, ServiceContext serviceContext) throws PortalException; /** * @deprecated As of 1.1.0, replaced by {@link #updateStatus(long, long, int, ServiceContext, Map)} */ @java.lang.Deprecated public BlogsEntry updateStatus(long userId, long entryId, int status, ServiceContext serviceContext) throws PortalException; @Indexable(type = IndexableType.REINDEX) public BlogsEntry updateStatus(long userId, long entryId, int status, ServiceContext serviceContext, Map<java.lang.String, Serializable> workflowContext) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public BlogsEntry[] getEntriesPrevAndNext(long entryId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ActionableDynamicQuery getActionableDynamicQuery(); public DynamicQuery dynamicQuery(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ExportActionableDynamicQuery getExportActionableDynamicQuery( PortletDataContext portletDataContext); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException; @Override @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException; public Folder addAttachmentsFolder(long userId, long groupId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Folder fetchAttachmentsFolder(long userId, long groupId); /** * Returns the number of blogs entries. * * @return the number of blogs entries */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getBlogsEntriesCount(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getCompanyEntriesCount(long companyId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupEntriesCount(long groupId, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupEntriesCount(long groupId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupUserEntriesCount(long groupId, long userId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getOrganizationEntriesCount(long organizationId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public java.lang.String getOSGiServiceIdentifier(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.lang.String getUniqueUrlTitle(BlogsEntry entry) throws PortalException; /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.blogs.model.impl.BlogsEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end); /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.blogs.model.impl.BlogsEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 <code>null</code>) * @return the ordered range of matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator); /** * Returns a range of all the blogs entries. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.blogs.model.impl.BlogsEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param start the lower bound of the range of blogs entries * @param end the upper bound of the range of blogs entries (not inclusive) * @return the range of blogs entries */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getBlogsEntries(int start, int end); /** * Returns all the blogs entries matching the UUID and company. * * @param uuid the UUID of the blogs entries * @param companyId the primary key of the company * @return the matching blogs entries, or an empty list if no matches were found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getBlogsEntriesByUuidAndCompanyId( java.lang.String uuid, long companyId); /** * Returns a range of blogs entries matching the UUID and company. * * @param uuid the UUID of the blogs entries * @param companyId the primary key of the company * @param start the lower bound of the range of blogs entries * @param end the upper bound of the range of blogs entries (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching blogs entries, or an empty list if no matches were found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getBlogsEntriesByUuidAndCompanyId( java.lang.String uuid, long companyId, int start, int end, OrderByComparator<BlogsEntry> orderByComparator); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getCompanyEntries(long companyId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getGroupEntries(long groupId, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getGroupEntries(long groupId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getGroupUserEntries(long groupId, long userId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getGroupsEntries(long companyId, long groupId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getNoAssetEntries(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<BlogsEntry> getOrganizationEntries(long organizationId, Date displayDate, QueryDefinition<BlogsEntry> queryDefinition); public long addOriginalImageFileEntry(long userId, long groupId, long entryId, ImageSelector imageSelector) throws PortalException; /** * 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); public void addCoverImage(long entryId, ImageSelector imageSelector) throws PortalException; public void addEntryResources(BlogsEntry entry, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException; public void addEntryResources(BlogsEntry entry, ModelPermissions modelPermissions) throws PortalException; public void addEntryResources(long entryId, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException; public void addEntryResources(long entryId, ModelPermissions modelPermissions) throws PortalException; public void addSmallImage(long entryId, ImageSelector imageSelector) throws PortalException; public void checkEntries() throws PortalException; public void deleteEntries(long groupId) throws PortalException; public void deleteEntry(long entryId) throws PortalException; public void moveEntriesToTrash(long groupId, long userId) throws PortalException; public void subscribe(long userId, long groupId) throws PortalException; public void unsubscribe(long userId, long groupId) throws PortalException; public void updateAsset(long userId, BlogsEntry entry, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority) throws PortalException; public void updateEntryResources(BlogsEntry entry, ModelPermissions modelPermissions) throws PortalException; public void updateEntryResources(BlogsEntry entry, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) throws PortalException; }