com.liferay.portal.service.LayoutBranchLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 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.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for LayoutBranch. This utility wraps
* {@link com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. 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 LayoutBranchLocalService
* @see com.liferay.portal.service.base.LayoutBranchLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl
* @generated
*/
@ProviderType
public class LayoutBranchLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.LayoutBranch addLayoutBranch(
com.liferay.portal.model.LayoutBranch layoutBranch)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addLayoutBranch(layoutBranch);
}
/**
* 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 static com.liferay.portal.model.LayoutBranch createLayoutBranch(
long LayoutBranchId) {
return getService().createLayoutBranch(LayoutBranchId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.LayoutBranch deleteLayoutBranch(
long LayoutBranchId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteLayoutBranch(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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.LayoutBranch deleteLayoutBranch(
com.liferay.portal.model.LayoutBranch layoutBranch)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deleteLayoutBranch(layoutBranch);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, 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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portal.model.LayoutBranch fetchLayoutBranch(
long LayoutBranchId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchLayoutBranch(LayoutBranchId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.LayoutBranch getLayoutBranch(
long LayoutBranchId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getLayoutBranch(LayoutBranchId);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static java.util.List getLayoutBranchs(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getLayoutBranchs(start, end);
}
/**
* Returns the number of layout branchs.
*
* @return the number of layout branchs
* @throws SystemException if a system exception occurred
*/
public static int getLayoutBranchsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getLayoutBranchsCount();
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portal.model.LayoutBranch updateLayoutBranch(
com.liferay.portal.model.LayoutBranch layoutBranch)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateLayoutBranch(layoutBranch);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
public static com.liferay.portal.model.LayoutBranch addLayoutBranch(
long layoutSetBranchId, long plid, java.lang.String name,
java.lang.String description, boolean master,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addLayoutBranch(layoutSetBranchId, plid, name, description,
master, serviceContext);
}
public static com.liferay.portal.model.LayoutBranch addLayoutBranch(
long layoutRevisionId, java.lang.String name,
java.lang.String description, boolean master,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addLayoutBranch(layoutRevisionId, name, description,
master, serviceContext);
}
public static void deleteLayoutSetBranchLayoutBranches(
long layoutSetBranchId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteLayoutSetBranchLayoutBranches(layoutSetBranchId);
}
public static java.util.List getLayoutBranches(
long layoutSetBranchId, long plid, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.getLayoutBranches(layoutSetBranchId, plid, start, end,
orderByComparator);
}
public static java.util.List getLayoutSetBranchLayoutBranches(
long layoutSetBranchId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getLayoutSetBranchLayoutBranches(layoutSetBranchId);
}
public static com.liferay.portal.model.LayoutBranch getMasterLayoutBranch(
long layoutSetBranchId, long plid)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getMasterLayoutBranch(layoutSetBranchId, plid);
}
public static com.liferay.portal.model.LayoutBranch getMasterLayoutBranch(
long layoutSetBranchId, long plid,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.getMasterLayoutBranch(layoutSetBranchId, plid,
serviceContext);
}
public static com.liferay.portal.model.LayoutBranch updateLayoutBranch(
long layoutBranchId, java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateLayoutBranch(layoutBranchId, name, description,
serviceContext);
}
public static LayoutBranchLocalService getService() {
if (_service == null) {
_service = (LayoutBranchLocalService)PortalBeanLocatorUtil.locate(LayoutBranchLocalService.class.getName());
ReferenceRegistry.registerReference(LayoutBranchLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(LayoutBranchLocalService service) {
}
private static LayoutBranchLocalService _service;
}