com.liferay.portal.kernel.service.LayoutPrototypeLocalService 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.portal.kernel.service;
import aQute.bnd.annotation.ProviderType;
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.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.LayoutPrototype;
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.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;
import java.util.Locale;
import java.util.Map;
/**
* Provides the local service interface for LayoutPrototype. 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 LayoutPrototypeLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface LayoutPrototypeLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link LayoutPrototypeLocalServiceUtil} to access the layout prototype local service. Add custom service methods to com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the layout prototype to the database. Also notifies the appropriate model listeners.
*
* @param layoutPrototype the layout prototype
* @return the layout prototype that was added
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype);
public LayoutPrototype addLayoutPrototype(
long userId, long companyId, Map nameMap,
Map descriptionMap, boolean active,
ServiceContext serviceContext)
throws PortalException;
/**
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
#addLayoutPrototype(long, long, Map, Map, boolean,
ServiceContext)}
*/
@Deprecated
public LayoutPrototype addLayoutPrototype(
long userId, long companyId, Map nameMap,
String description, boolean active, ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new layout prototype with the primary key. Does not add the layout prototype to the database.
*
* @param layoutPrototypeId the primary key for the new layout prototype
* @return the new layout prototype
*/
@Transactional(enabled = false)
public LayoutPrototype createLayoutPrototype(long layoutPrototypeId);
/**
* Deletes the layout prototype from the database. Also notifies the appropriate model listeners.
*
* @param layoutPrototype the layout prototype
* @return the layout prototype that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(
action = SystemEventConstants.ACTION_SKIP,
type = SystemEventConstants.TYPE_DELETE
)
public LayoutPrototype deleteLayoutPrototype(
LayoutPrototype layoutPrototype)
throws PortalException;
/**
* Deletes the layout prototype with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param layoutPrototypeId the primary key of the layout prototype
* @return the layout prototype that was removed
* @throws PortalException if a layout prototype with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public LayoutPrototype deleteLayoutPrototype(long layoutPrototypeId)
throws PortalException;
public void deleteNondefaultLayoutPrototypes(long companyId)
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.portal.model.impl.LayoutPrototypeModelImpl. 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.portal.model.impl.LayoutPrototypeModelImpl. 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 LayoutPrototype fetchLayoutPrototype(long layoutPrototypeId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype fetchLayoutPrototype(
long companyId, String name, Locale locale);
/**
* Returns the layout prototype with the matching UUID and company.
*
* @param uuid the layout prototype's UUID
* @param companyId the primary key of the company
* @return the matching layout prototype, or null if a matching layout prototype could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype fetchLayoutProtoype(long companyId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the layout prototype with the primary key.
*
* @param layoutPrototypeId the primary key of the layout prototype
* @return the layout prototype
* @throws PortalException if a layout prototype with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype getLayoutPrototype(long companyId, String name)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype getLayoutPrototype(
long companyId, String name, Locale locale)
throws PortalException;
/**
* Returns the layout prototype with the matching UUID and company.
*
* @param uuid the layout prototype's UUID
* @param companyId the primary key of the company
* @return the matching layout prototype
* @throws PortalException if a matching layout prototype could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPrototype getLayoutPrototypeByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the layout prototypes.
*
*
* 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.portal.model.impl.LayoutPrototypeModelImpl. 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 layout prototypes
* @param end the upper bound of the range of layout prototypes (not inclusive)
* @return the range of layout prototypes
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutPrototypes(int start, int end);
/**
* Returns the number of layout prototypes.
*
* @return the number of layout prototypes
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutPrototypesCount();
/**
* 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 List search(
long companyId, Boolean active, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(long companyId, Boolean active);
/**
* Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param layoutPrototype the layout prototype
* @return the layout prototype that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutPrototype updateLayoutPrototype(
LayoutPrototype layoutPrototype);
public LayoutPrototype updateLayoutPrototype(
long layoutPrototypeId, Map nameMap,
Map descriptionMap, boolean active,
ServiceContext serviceContext)
throws PortalException;
/**
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
#updateLayoutPrototype(long, Map, Map, boolean,
ServiceContext)}
*/
@Deprecated
public LayoutPrototype updateLayoutPrototype(
long layoutPrototypeId, Map nameMap,
String description, boolean active, ServiceContext serviceContext)
throws PortalException;
}