com.liferay.html.preview.service.HtmlPreviewEntryLocalService 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.html.preview.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.html.preview.model.HtmlPreviewEntry;
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.ServiceContext;
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 HtmlPreviewEntry. 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 HtmlPreviewEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface HtmlPreviewEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link HtmlPreviewEntryLocalServiceUtil} to access the html preview entry local service. Add custom service methods to com.liferay.html.preview.service.impl.HtmlPreviewEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the html preview entry to the database. Also notifies the appropriate model listeners.
*
* @param htmlPreviewEntry the html preview entry
* @return the html preview entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public HtmlPreviewEntry addHtmlPreviewEntry(
HtmlPreviewEntry htmlPreviewEntry);
public HtmlPreviewEntry addHtmlPreviewEntry(
long userId, long groupId, long classNameId, long classPK,
String content, String mimeType, ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new html preview entry with the primary key. Does not add the html preview entry to the database.
*
* @param htmlPreviewEntryId the primary key for the new html preview entry
* @return the new html preview entry
*/
@Transactional(enabled = false)
public HtmlPreviewEntry createHtmlPreviewEntry(long htmlPreviewEntryId);
/**
* Deletes the html preview entry from the database. Also notifies the appropriate model listeners.
*
* @param htmlPreviewEntry the html preview entry
* @return the html preview entry that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public HtmlPreviewEntry deleteHtmlPreviewEntry(
HtmlPreviewEntry htmlPreviewEntry)
throws PortalException;
/**
* Deletes the html preview entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param htmlPreviewEntryId the primary key of the html preview entry
* @return the html preview entry that was removed
* @throws PortalException if a html preview entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public HtmlPreviewEntry deleteHtmlPreviewEntry(long htmlPreviewEntryId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@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.html.preview.model.impl.HtmlPreviewEntryModelImpl. 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.html.preview.model.impl.HtmlPreviewEntryModelImpl. 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 HtmlPreviewEntry fetchHtmlPreviewEntry(long htmlPreviewEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns a range of all the html preview entries.
*
*
* 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.html.preview.model.impl.HtmlPreviewEntryModelImpl. 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 html preview entries
* @param end the upper bound of the range of html preview entries (not inclusive)
* @return the range of html preview entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getHtmlPreviewEntries(int start, int end);
/**
* Returns the number of html preview entries.
*
* @return the number of html preview entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getHtmlPreviewEntriesCount();
/**
* Returns the html preview entry with the primary key.
*
* @param htmlPreviewEntryId the primary key of the html preview entry
* @return the html preview entry
* @throws PortalException if a html preview entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public HtmlPreviewEntry getHtmlPreviewEntry(long htmlPreviewEntryId)
throws PortalException;
@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;
/**
* Updates the html preview entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param htmlPreviewEntry the html preview entry
* @return the html preview entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public HtmlPreviewEntry updateHtmlPreviewEntry(
HtmlPreviewEntry htmlPreviewEntry);
public HtmlPreviewEntry updateHtmlPreviewEntry(
long htmlPreviewEntryId, String content, String mimeType,
ServiceContext serviceContext)
throws PortalException;
}