com.liferay.portal.service.LayoutSetLocalService 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.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
/**
* Provides the local service interface for LayoutSet. 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 LayoutSetLocalServiceUtil
* @see com.liferay.portal.service.base.LayoutSetLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface LayoutSetLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link LayoutSetLocalServiceUtil} to access the layout set local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the layout set to the database. Also notifies the appropriate model listeners.
*
* @param layoutSet the layout set
* @return the layout set that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet addLayoutSet(
com.liferay.portal.model.LayoutSet layoutSet)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new layout set with the primary key. Does not add the layout set to the database.
*
* @param layoutSetId the primary key for the new layout set
* @return the new layout set
*/
public com.liferay.portal.model.LayoutSet createLayoutSet(long layoutSetId);
/**
* Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param layoutSetId the primary key of the layout set
* @return the layout set that was removed
* @throws PortalException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet deleteLayoutSet(long layoutSetId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the layout set from the database. Also notifies the appropriate model listeners.
*
* @param layoutSet the layout set
* @return the layout set that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet deleteLayoutSet(
com.liferay.portal.model.LayoutSet layoutSet)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery 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 java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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.LayoutSetModelImpl}. 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 java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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.LayoutSetModelImpl}. 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 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;
/**
* 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 long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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 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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.LayoutSet fetchLayoutSet(long layoutSetId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the layout set with the primary key.
*
* @param layoutSetId the primary key of the layout set
* @return the layout set
* @throws PortalException if a layout set with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.LayoutSet getLayoutSet(long layoutSetId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the layout sets.
*
*
* 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.LayoutSetModelImpl}. 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 sets
* @param end the upper bound of the range of layout sets (not inclusive)
* @return the range of layout sets
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getLayoutSets(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of layout sets.
*
* @return the number of layout sets
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutSetsCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param layoutSet the layout set
* @return the layout set that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.LayoutSet updateLayoutSet(
com.liferay.portal.model.LayoutSet layoutSet)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public com.liferay.portal.model.LayoutSet addLayoutSet(long groupId,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteLayoutSet(long groupId, boolean privateLayout,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.LayoutSet fetchLayoutSet(
java.lang.String virtualHostname)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.LayoutSet getLayoutSet(long groupId,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.LayoutSet getLayoutSet(
java.lang.String virtualHostname)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getLayoutSetsByLayoutSetPrototypeUuid(
java.lang.String layoutSetPrototypeUuid)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the state of the layout set prototype link.
*
*
* This method can disable the layout set prototype's link by setting
* layoutSetPrototypeLinkEnabled to false.
* However, this method can only enable the layout set prototype's link if
* the layout set prototype's current uuid is not null. Setting
* the layoutSetPrototypeLinkEnabled to true when
* the layout set prototype's current uuid is null will have no
* effect.
*
*
* @param groupId the primary key of the group
* @param privateLayout whether the layout set is private to the group
* @param layoutSetPrototypeLinkEnabled whether the layout set
prototype is link enabled
* @throws PortalException if a portal exception occurred
* @throws SystemException if a system exception occurred
* @deprecated As of 6.1.0, replaced by {@link
#updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
String)}
*/
public void updateLayoutSetPrototypeLinkEnabled(long groupId,
boolean privateLayout, boolean layoutSetPrototypeLinkEnabled)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the state of the layout set prototype link.
*
* @param groupId the primary key of the group
* @param privateLayout whether the layout set is private to the group
* @param layoutSetPrototypeLinkEnabled whether the layout set prototype is
link enabled
* @param layoutSetPrototypeUuid the uuid of the layout set prototype to
link with
* @throws PortalException if a portal exception occurred
* @throws SystemException if a system exception occurred
*/
public void updateLayoutSetPrototypeLinkEnabled(long groupId,
boolean privateLayout, boolean layoutSetPrototypeLinkEnabled,
java.lang.String layoutSetPrototypeUuid)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
boolean privateLayout, boolean logo, byte[] bytes)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
boolean privateLayout, boolean logo, java.io.File file)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
boolean privateLayout, boolean logo, java.io.InputStream is)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateLogo(long groupId,
boolean privateLayout, boolean logo, java.io.InputStream is,
boolean cleanUpStream)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateLookAndFeel(long groupId,
boolean privateLayout, java.lang.String themeId,
java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void updateLookAndFeel(long groupId, java.lang.String themeId,
java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updatePageCount(long groupId,
boolean privateLayout)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateSettings(long groupId,
boolean privateLayout, java.lang.String settings)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.LayoutSet updateVirtualHost(long groupId,
boolean privateLayout, java.lang.String virtualHostname)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
}