com.liferay.portal.kernel.service.LayoutBranchLocalService Maven / Gradle / Ivy
Show all versions of com.liferay.portal.kernel Show documentation
/**
* 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.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.LayoutBranch;
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.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 LayoutBranch. 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 LayoutBranchLocalServiceUtil
* @see com.liferay.portal.service.base.LayoutBranchLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface LayoutBranchLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link LayoutBranchLocalServiceUtil} to access the layout branch local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the layout branch to the database. Also notifies the appropriate model listeners.
*
* @param layoutBranch the layout branch
* @return the layout branch that was added
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutBranch addLayoutBranch(LayoutBranch layoutBranch);
public LayoutBranch addLayoutBranch(long layoutRevisionId,
java.lang.String name, java.lang.String description, boolean master,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws PortalException;
public LayoutBranch addLayoutBranch(long layoutSetBranchId, long plid,
java.lang.String name, java.lang.String description, boolean master,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new layout branch with the primary key. Does not add the layout branch to the database.
*
* @param layoutBranchId the primary key for the new layout branch
* @return the new layout branch
*/
public LayoutBranch createLayoutBranch(long layoutBranchId);
/**
* Deletes the layout branch from the database. Also notifies the appropriate model listeners.
*
* @param layoutBranch the layout branch
* @return the layout branch that was removed
*/
@Indexable(type = IndexableType.DELETE)
public LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch);
/**
* Deletes the layout branch with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param layoutBranchId the primary key of the layout branch
* @return the layout branch that was removed
* @throws PortalException if a layout branch with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public LayoutBranch deleteLayoutBranch(long layoutBranchId)
throws PortalException;
public void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutBranchModelImpl}. 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
*/
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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutBranchModelImpl}. 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
*/
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
*/
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);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutBranch fetchLayoutBranch(long layoutBranchId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the layout branch with the primary key.
*
* @param layoutBranchId the primary key of the layout branch
* @return the layout branch
* @throws PortalException if a layout branch with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutBranch getLayoutBranch(long layoutBranchId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutBranches(long layoutSetBranchId,
long plid, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns a range of all the layout branchs.
*
*
* 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutBranchModelImpl}. 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 branchs
* @param end the upper bound of the range of layout branchs (not inclusive)
* @return the range of layout branchs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutBranchs(int start, int end);
/**
* Returns the number of layout branchs.
*
* @return the number of layout branchs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutBranchsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutSetBranchLayoutBranches(
long layoutSetBranchId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public LayoutBranch getMasterLayoutBranch(long layoutSetBranchId,
long plid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws PortalException;
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public java.lang.String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param layoutBranch the layout branch
* @return the layout branch that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch);
public LayoutBranch updateLayoutBranch(long layoutBranchId,
java.lang.String name, java.lang.String description,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws PortalException;
}