com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalService 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.layout.page.template.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.layout.page.template.model.LayoutPageTemplateCollection;
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.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 LayoutPageTemplateCollection. 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 LayoutPageTemplateCollectionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface LayoutPageTemplateCollectionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link LayoutPageTemplateCollectionLocalServiceUtil} to access the layout page template collection local service. Add custom service methods to com.liferay.layout.page.template.service.impl.LayoutPageTemplateCollectionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the layout page template collection to the database. Also notifies the appropriate model listeners.
*
* @param layoutPageTemplateCollection the layout page template collection
* @return the layout page template collection that was added
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutPageTemplateCollection addLayoutPageTemplateCollection(
LayoutPageTemplateCollection layoutPageTemplateCollection);
public LayoutPageTemplateCollection addLayoutPageTemplateCollection(
long userId, long groupId, String name, String description,
ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new layout page template collection with the primary key. Does not add the layout page template collection to the database.
*
* @param layoutPageTemplateCollectionId the primary key for the new layout page template collection
* @return the new layout page template collection
*/
@Transactional(enabled = false)
public LayoutPageTemplateCollection createLayoutPageTemplateCollection(
long layoutPageTemplateCollectionId);
/**
* Deletes the layout page template collection from the database. Also notifies the appropriate model listeners.
*
* @param layoutPageTemplateCollection the layout page template collection
* @return the layout page template collection that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
public LayoutPageTemplateCollection deleteLayoutPageTemplateCollection(
LayoutPageTemplateCollection layoutPageTemplateCollection)
throws PortalException;
/**
* Deletes the layout page template collection with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param layoutPageTemplateCollectionId the primary key of the layout page template collection
* @return the layout page template collection that was removed
* @throws PortalException if a layout page template collection with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public LayoutPageTemplateCollection deleteLayoutPageTemplateCollection(
long layoutPageTemplateCollectionId)
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.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl. 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.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl. 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 LayoutPageTemplateCollection fetchLayoutPageTemplateCollection(
long layoutPageTemplateCollectionId);
/**
* Returns the layout page template collection matching the UUID and group.
*
* @param uuid the layout page template collection's UUID
* @param groupId the primary key of the group
* @return the matching layout page template collection, or null if a matching layout page template collection could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPageTemplateCollection
fetchLayoutPageTemplateCollectionByUuidAndGroupId(
String uuid, long groupId);
@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 page template collection with the primary key.
*
* @param layoutPageTemplateCollectionId the primary key of the layout page template collection
* @return the layout page template collection
* @throws PortalException if a layout page template collection with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPageTemplateCollection getLayoutPageTemplateCollection(
long layoutPageTemplateCollectionId)
throws PortalException;
/**
* Returns the layout page template collection matching the UUID and group.
*
* @param uuid the layout page template collection's UUID
* @param groupId the primary key of the group
* @return the matching layout page template collection
* @throws PortalException if a matching layout page template collection could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutPageTemplateCollection
getLayoutPageTemplateCollectionByUuidAndGroupId(
String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the layout page template collections.
*
*
* 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.layout.page.template.model.impl.LayoutPageTemplateCollectionModelImpl. 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 page template collections
* @param end the upper bound of the range of layout page template collections (not inclusive)
* @return the range of layout page template collections
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutPageTemplateCollections(
int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutPageTemplateCollections(
long groupId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutPageTemplateCollections(
long groupId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutPageTemplateCollections(
long groupId, String name, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns all the layout page template collections matching the UUID and company.
*
* @param uuid the UUID of the layout page template collections
* @param companyId the primary key of the company
* @return the matching layout page template collections, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getLayoutPageTemplateCollectionsByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of layout page template collections matching the UUID and company.
*
* @param uuid the UUID of the layout page template collections
* @param companyId the primary key of the company
* @param start the lower bound of the range of layout page template collections
* @param end the upper bound of the range of layout page template collections (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching layout page template collections, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List
getLayoutPageTemplateCollectionsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of layout page template collections.
*
* @return the number of layout page template collections
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutPageTemplateCollectionsCount();
/**
* 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 layout page template collection in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param layoutPageTemplateCollection the layout page template collection
* @return the layout page template collection that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutPageTemplateCollection updateLayoutPageTemplateCollection(
LayoutPageTemplateCollection layoutPageTemplateCollection);
public LayoutPageTemplateCollection updateLayoutPageTemplateCollection(
long layoutPageTemplateCollectionId, String name,
String description)
throws PortalException;
}