com.liferay.fragment.service.FragmentEntryLocalService 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.fragment.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.fragment.model.FragmentEntry;
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.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.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.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.Serializable;
import java.util.List;
/**
* Provides the local service interface for FragmentEntry. 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 FragmentEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface FragmentEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link FragmentEntryLocalServiceUtil} to access the fragment entry local service. Add custom service methods to com.liferay.fragment.service.impl.FragmentEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the fragment entry to the database. Also notifies the appropriate model listeners.
*
* @param fragmentEntry the fragment entry
* @return the fragment entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public FragmentEntry addFragmentEntry(FragmentEntry fragmentEntry);
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId, String name,
int status, ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId, String name,
long previewFileEntryId, int status, ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId,
String fragmentEntryKey, String name, int status,
ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId,
String fragmentEntryKey, String name, long previewFileEntryId,
int status, ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId, String name,
String css, String html, String js, int status,
ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId, String name,
String css, String html, String js, long previewFileEntryId,
int status, ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId,
String fragmentEntryKey, String name, String css, String html,
String js, int status, ServiceContext serviceContext)
throws PortalException;
public FragmentEntry addFragmentEntry(
long userId, long groupId, long fragmentCollectionId,
String fragmentEntryKey, String name, String css, String html,
String js, long previewFileEntryId, int status,
ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new fragment entry with the primary key. Does not add the fragment entry to the database.
*
* @param fragmentEntryId the primary key for the new fragment entry
* @return the new fragment entry
*/
@Transactional(enabled = false)
public FragmentEntry createFragmentEntry(long fragmentEntryId);
/**
* Deletes the fragment entry from the database. Also notifies the appropriate model listeners.
*
* @param fragmentEntry the fragment entry
* @return the fragment entry that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public FragmentEntry deleteFragmentEntry(FragmentEntry fragmentEntry)
throws PortalException;
/**
* Deletes the fragment entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param fragmentEntryId the primary key of the fragment entry
* @return the fragment entry that was removed
* @throws PortalException if a fragment entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public FragmentEntry deleteFragmentEntry(long fragmentEntryId)
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.fragment.model.impl.FragmentEntryModelImpl. 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.fragment.model.impl.FragmentEntryModelImpl. 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 FragmentEntry fetchFragmentEntry(long fragmentEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public FragmentEntry fetchFragmentEntry(
long groupId, String fragmentEntryKey);
/**
* Returns the fragment entry matching the UUID and group.
*
* @param uuid the fragment entry's UUID
* @param groupId the primary key of the group
* @return the matching fragment entry, or null if a matching fragment entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public FragmentEntry fetchFragmentEntryByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
/**
* Returns a range of all the fragment 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.fragment.model.impl.FragmentEntryModelImpl. 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 fragment entries
* @param end the upper bound of the range of fragment entries (not inclusive)
* @return the range of fragment entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(long fragmentCollectionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(
long fragmentCollectionId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(
long groupId, long fragmentCollectionId, int status);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(
long groupId, long fragmentCollectionId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntries(
long groupId, long fragmentCollectionId, String name, int start,
int end, OrderByComparator orderByComparator);
/**
* Returns all the fragment entries matching the UUID and company.
*
* @param uuid the UUID of the fragment entries
* @param companyId the primary key of the company
* @return the matching fragment entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntriesByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of fragment entries matching the UUID and company.
*
* @param uuid the UUID of the fragment entries
* @param companyId the primary key of the company
* @param start the lower bound of the range of fragment entries
* @param end the upper bound of the range of fragment entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching fragment entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFragmentEntriesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of fragment entries.
*
* @return the number of fragment entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getFragmentEntriesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getFragmentEntriesCount(long fragmentCollectionId);
/**
* Returns the fragment entry with the primary key.
*
* @param fragmentEntryId the primary key of the fragment entry
* @return the fragment entry
* @throws PortalException if a fragment entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public FragmentEntry getFragmentEntry(long fragmentEntryId)
throws PortalException;
/**
* Returns the fragment entry matching the UUID and group.
*
* @param uuid the fragment entry's UUID
* @param groupId the primary key of the group
* @return the matching fragment entry
* @throws PortalException if a matching fragment entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public FragmentEntry getFragmentEntryByUuidAndGroupId(
String uuid, long groupId)
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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public String[] getTempFileNames(
long userId, long groupId, String folderName)
throws PortalException;
/**
* Updates the fragment entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param fragmentEntry the fragment entry
* @return the fragment entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public FragmentEntry updateFragmentEntry(FragmentEntry fragmentEntry);
public FragmentEntry updateFragmentEntry(
long fragmentEntryId, long previewFileEntryId)
throws PortalException;
public FragmentEntry updateFragmentEntry(
long userId, long fragmentEntryId, String name, String css,
String html, String js, int status)
throws PortalException;
public FragmentEntry updateFragmentEntry(
long userId, long fragmentEntryId, String name, String css,
String html, String js, long previewFileEntryId, int status)
throws PortalException;
public FragmentEntry updateFragmentEntry(long fragmentEntryId, String name)
throws PortalException;
}